wet

web-ext-types

TypeScript type definitions for Firefox WebExtensions

Showing:

Popularity

Downloads/wk

2K

GitHub Stars

135

Maintenance

Last Commit

2yrs ago

Contributors

30

Package

Dependencies

0

License

MPL-2.0

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

web-ext-types

Build Status Npm Version

TypeScript type definitions for WebExtensions, based on MDN's documentation.

Requirements

As this library is using the object type and default values for generics, typescript should at least be on version 2.3 to get the definitions to work.

Install it

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 kelseasy/web-ext-types --dev

# npm version
npm install --save-dev kelseasy/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": ["node_modules/@types", "node_modules/web-ext-types"],
  }
}

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial