GM API Types

All-in-One GM API types (Greasemonkey, Tampermonkey, Violentmonkey and etc)

Install

To install:

Bun:

bun install @toil/gm-types

NPM:

npm install @toil/gm-types

Usage

After installation add @toil/gm-types/v4 or/and @toil/gm-types/v3 to tsconfig.json

{
  "compilerOptions": {
    "types": ["@toil/gm-types/v3"]
    //...
  }
}

Supported APIs

Currently, only these APIs are supported (with their GM. alternatives):

• GM_info
• GM_notification
• GM Storage (GM_getValue, GM_setValue and etc)
• GM_addStyle
• GM_xmlhttpRequest
• GM_getResourceURL
• GM_cookie

Supported Extensions

Supported userscript managers:

• Tampermonkey
• Greasemonkey
• Violentmonkey
• FireMonkey
• OrangeMonkey
• UserScripts
• AdGuard UserScripts

1.0.4

• Added export XHRBody
• Added VMXHROnErrorHandler
• Updated types in XHRBody type
• Fixed typo in some comments

1.0.3

• Fixed setValue type value in GM. and GM_ APIs

1.0.2

• Added addValueChangeListener and removeValueChangeListener in GM. and GM_ APIs
• Improved type generics for setValue, setValues, getValue, getValues in GM. and GM_ APIs
• Added support cookie in GM and GM_ APIs`
• Fixed typo in Violentmonkey name

1.0.1

• Fixed README

1.0.0

• Initial release