@0xproject/typescript-typings
v3.0.2
Published
0x project typescript type definitions
Downloads
2,873
Readme
@0xproject/typescript-typings
Type repository for external packages used by 0x. This is like our small version of DefinitelyTyped
Installation
yarn add -D @0xproject/typescript-typings
Usage
Add the following line within an compilerOptions
section of your tsconfig.json
"typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"]
This will allow the TS compiler to first look into that repo and then fallback to DT types.
Contributing
We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.
Please read our contribution guidelines before getting started.
Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental true
Then install dependencies
yarn install
Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@0xproject/typescript-typings yarn build
Or continuously rebuild on change:
PKG=@0xproject/typescript-typings yarn watch
Clean
yarn clean
Lint
yarn lint