| 1 | ## web3-typescript-typings
|
| 2 |
|
| 3 | There currently isn't an official [Web3][web3]
|
| 4 | type definition included in the [DefinitelyTyped][definitelytyped] project.
|
| 5 | Until that happens, we will continue to improve our own type definition.
|
| 6 | If it get's close to comprehensive, we'll add it to [DefinitelyTyped][definitelytyped].
|
| 7 |
|
| 8 | [web3]: https://github.com/ethereum/web3.js/
|
| 9 | [definitelytyped]: https://github.com/DefinitelyTyped/DefinitelyTyped
|
| 10 |
|
| 11 | ## Installation
|
| 12 |
|
| 13 | ```bash
|
| 14 | yarn add -D web3-typescript-typings
|
| 15 | ```
|
| 16 |
|
| 17 | ## Usage
|
| 18 |
|
| 19 | Add the following line within an `include` section of your `tsconfig.json`
|
| 20 |
|
| 21 | ```json
|
| 22 | "./node_modules/web3-typescript-typings/index.d.ts"
|
| 23 | ```
|
| 24 |
|
| 25 | ## Contributing
|
| 26 |
|
| 27 | We strongly encourage that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
|
| 28 |
|
| 29 | Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
|
| 30 |
|
| 31 | ### Install Dependencies
|
| 32 |
|
| 33 | If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
|
| 34 |
|
| 35 | ```bash
|
| 36 | yarn config set workspaces-experimental true
|
| 37 | ```
|
| 38 |
|
| 39 | Then install dependencies
|
| 40 |
|
| 41 | ```bash
|
| 42 | yarn install
|
| 43 | ```
|
| 44 |
|
| 45 | ### Lint
|
| 46 |
|
| 47 | ```bash
|
| 48 | yarn lint
|
| 49 | ```
|
| 50 | |
| \ | No newline at end of file |