Functions and other tools for GreaseMonkey UserScript development.
Functions and other tools for GreaseMonkey UserScript development.
Documentation for the main branch is hosted at
Documentation can be built from a cloned repository by running yarn doc.
Most functions will require some @grant's to work properly,
but can fall back to other things like the browser's localStorage if grants aren't found.
Information for each function can be found in its docs.
To use in a Node project, add GreaseTools as a dependency.
``shnpm
npm install greasetools
You can then import and use GreaseTools functions:
`javascript
import { valuesProxy, getValues } from 'greasetools'const values = valuesProxy(
await getValues({
hello: 'World!',
}),
)
`$3
In a UserScript that isn't built with Node.js, you can
@require the library:`javascript
// @require https://gitlab.com/MysteryBlokHed/greasetools/-/raw/main/greasetools.user.js
`You can replace
main with a specific release tag like v0.1.0 to require a specific version:`javascript
// @require https://gitlab.com/MysteryBlokHed/greasetools/-/raw/v0.1.0/greasetools.user.js
`Functions are available on the global
GreaseTools object:`javascript
const { valuesProxy, getValues } = GreaseToolsconst values = valuesProxy(
await getValues({
hello: 'World!',
}),
)
`#### Type declarations
The types included with the npm package still work when the library is
@require'd.
Just add the types as a dev dependency for a Node project or install it globally.
With the package installed, include the following reference line somewhere in your TypeScript source file:`typescript
///
``GreaseTools is licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or
- MIT license (LICENSE-MIT or
at your option.
[build badge]: https://img.shields.io/gitlab/pipeline-status/MysteryBlokHed/greasetools
[npm badge]: https://img.shields.io/npm/v/greasetools
[license badge]: https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-green