|
| 1 | +# 油猴API的TypeScript类型定义 |
| 2 | + |
| 3 | +本项目已集成了油猴API的TypeScript类型定义,使您能够在开发过程中获得完整的类型检查和智能提示支持。 |
| 4 | + |
| 5 | +## 类型定义来源 |
| 6 | + |
| 7 | +类型定义通过以下方式提供: |
| 8 | + |
| 9 | +1. `@types/tampermonkey` npm包 - 提供了官方的油猴API类型定义 |
| 10 | +2. 本地类型扩展 - 在`src/types/tampermonkey.d.ts`文件中 |
| 11 | + |
| 12 | +## 如何使用 |
| 13 | + |
| 14 | +### 1. 在代码中使用油猴API |
| 15 | + |
| 16 | +您可以直接在代码中使用油猴API,TypeScript将自动识别这些API的类型: |
| 17 | + |
| 18 | +```typescript |
| 19 | +// 存储数据 |
| 20 | +GM_setValue('key', 'value'); |
| 21 | + |
| 22 | +// 读取数据 |
| 23 | +const value = GM_getValue('key', 'default'); |
| 24 | + |
| 25 | +// 注册菜单 |
| 26 | +GM_registerMenuCommand('菜单项', () => { |
| 27 | + console.log('点击了菜单项'); |
| 28 | +}); |
| 29 | + |
| 30 | +// 发送XHR请求 |
| 31 | +GM_xmlhttpRequest({ |
| 32 | + method: 'GET', |
| 33 | + url: 'https://example.com', |
| 34 | + onload: (response) => { |
| 35 | + console.log(response.responseText); |
| 36 | + } |
| 37 | +}); |
| 38 | +``` |
| 39 | + |
| 40 | +### 2. 使用Promise风格的API (GM.*) |
| 41 | + |
| 42 | +如果您更喜欢使用Promise风格的API,可以这样使用: |
| 43 | + |
| 44 | +```typescript |
| 45 | +// 存储数据 |
| 46 | +await GM.setValue('key', 'value'); |
| 47 | + |
| 48 | +// 读取数据 |
| 49 | +const value = await GM.getValue('key', 'default'); |
| 50 | + |
| 51 | +// 注册菜单 |
| 52 | +GM.registerMenuCommand('菜单项', () => { |
| 53 | + console.log('点击了菜单项'); |
| 54 | +}); |
| 55 | +``` |
| 56 | + |
| 57 | +### 3. 检查API可用性 |
| 58 | + |
| 59 | +由于油猴脚本可能在不同的环境中运行,建议在使用API前检查其可用性: |
| 60 | + |
| 61 | +```typescript |
| 62 | +if (typeof GM_setValue !== 'undefined') { |
| 63 | + GM_setValue('key', 'value'); |
| 64 | +} else if (typeof GM !== 'undefined' && GM.setValue) { |
| 65 | + await GM.setValue('key', 'value'); |
| 66 | +} else { |
| 67 | + console.warn('GM存储API不可用'); |
| 68 | +} |
| 69 | +``` |
| 70 | + |
| 71 | +## 示例代码 |
| 72 | + |
| 73 | +请查看 `src/gm_api_example/gm_api_usage.ts` 文件,其中包含了各种油猴API的使用示例。 |
| 74 | + |
| 75 | +## 注意事项 |
| 76 | + |
| 77 | +1. 确保在`userscript-headers.js`文件中添加了所需的`@grant`声明,否则相应的API将不可用。 |
| 78 | +2. 如果您需要使用未在`@types/tampermonkey`中定义的API或自定义扩展,可以在`src/types/tampermonkey.d.ts`文件中添加自定义类型定义。 |
0 commit comments