Skip to content
TypeScript type definitions for Firefox WebExtensions
Branch: master
Clone or download
kelseasy Merge pull request #82 from antonva/browser-find
Add browser.find namespace.
Latest commit 652155e Mar 9, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
global Change return type of find to Promise<FindResults> Mar 8, 2019
.travis.yml chore(ci): add travis step Mar 9, 2017
LICENSE chore(license): switch to MPL-2.0 Mar 26, 2017
README.md Bump typescript version up to the minimum required, 2.3.0 Dec 3, 2017
package.json chore(yarn): update version Dec 27, 2018
tsconfig.json Make storage.get stricter Oct 22, 2017
tslint.json chore(yarn): add all the necessary files Mar 9, 2017
yarn.lock

README.md

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"],
  }
}
You can’t perform that action at this time.