TypeScript type definitions for WebExtensions, based on MDN's documentation. The library is unmaintained as of today (13/07/2017) as I do not wish to invest any of my free-time in a browser that traded its users privacy for convenience.
As this library is using the object
type, typescript
should at least be on
version 2.2
to get the definitions to work.
There is an npm package available, which means you can grab it from there:
# yarn version
yarn add web-ext-types --dev
# npm version
npm install --save-dev web-ext-types
Though if you want to use the git version, simply do:
# yarn version
yarn add michael-zapata/web-ext-types --dev
# npm version
npm install --save-dev michael-zapata/web-ext-types
As this is not a DefinitelyTyped
package, you will have to
include the type definition in your tsconfig.json
by hand, via a typeRoots
option.
{
"compilerOptions": {
// You have to explicitly set @types to get DefinitelyTyped type definitions
"typeRoots": ["@types", "node_modules/web-ext-types"],
}
}