Skip to content

Commit 6cb42ec

Browse files
committed
docs: 更新README,添加TypeScript支持文档
在README.md中添加TypeScript支持的说明,包括:\n1. 油猴API类型定义的使用方法\n2. 示例代码引用\n3. @grant声明注意事项
1 parent c8dd6a7 commit 6cb42ec

File tree

1 file changed

+37
-3
lines changed

1 file changed

+37
-3
lines changed

README.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
# 三、快速开始
1616

17-
在当前仓库(https://github.com/JSREI/userscript-template)选择`Use this template` --> `Create a new repository`,从这个模板仓库创建一个新的仓库:
17+
在当前仓库(https://github.com/JSREI/userscript-template)选择"`Use this template`" --> "`Create a new repository`",从这个模板仓库创建一个新的仓库:
1818

1919
![image-20230816233501101](README.assets/image-20230816233501101.png)
2020

@@ -138,11 +138,11 @@ npm run watch
138138
(() => {})();
139139
```
140140

141-
注意,当你使用`// @require file://D:/workspace/userscript-template/dist/index.ts`这种方式来调试的时候,你的油猴插件应该配置了允许访问文件网址(默认情况下是不允许的),在浏览器插件图标上右键,选择管理扩展程序
141+
注意,当你使用`// @require file://D:/workspace/userscript-template/dist/index.ts`这种方式来调试的时候,你的油猴插件应该配置了允许访问文件网址(默认情况下是不允许的),在浏览器插件图标上右键,选择"管理扩展程序"
142142

143143
![image-20240723005213833](./README.assets/image-20240723005213833.png)
144144

145-
确保这个允许访问文件网址开关是打开的,否则的话`@require`将无法引用本地文件:
145+
确保这个"允许访问文件网址"开关是打开的,否则的话`@require`将无法引用本地文件:
146146

147147
![image-20240723005321887](./README.assets/image-20240723005321887.png)
148148

@@ -156,6 +156,40 @@ npm run build
156156

157157
然后把`./dist/index.ts`文件拿去发布即可。
158158

159+
# 四、TypeScript支持
160+
161+
本项目已经集成了TypeScript支持,包括油猴API的类型定义。这使得在开发过程中可以获得完整的类型检查和智能提示。
162+
163+
## 油猴API类型定义
164+
165+
项目使用`@types/tampermonkey`包提供油猴API的类型定义,并在`src/types`目录下提供了额外的类型扩展。
166+
167+
### 如何使用
168+
169+
1. 直接在代码中使用油猴API,TypeScript将自动识别这些API的类型:
170+
171+
```typescript
172+
// 存储数据
173+
GM_setValue('key', 'value');
174+
175+
// 读取数据
176+
const value = GM_getValue('key', 'default');
177+
```
178+
179+
2. 查看`src/gm_api_example/gm_api_usage.ts`文件,了解更多油猴API的使用示例。
180+
181+
3. 详细的使用说明请参考`src/types/README.md`文件。
182+
183+
### 注意事项
184+
185+
确保在`userscript-headers.js`文件中添加了所需的`@grant`声明,否则相应的API将不可用。例如:
186+
187+
```js
188+
// @grant GM_getValue
189+
// @grant GM_setValue
190+
// @grant GM_xmlhttpRequest
191+
```
192+
159193

160194

161195

0 commit comments

Comments
 (0)