Add missing instructions to add external types to tsconfig.json after installing the package
This commit is contained in:
parent
699c0c3e05
commit
011bab3c80
@ -18,6 +18,15 @@ npm install 0x.js --save
|
||||
import { ZeroEx } from '0x.js';
|
||||
```
|
||||
|
||||
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
|
||||
|
||||
```
|
||||
"include": [
|
||||
"./node_modules/web3-typescript-typings/index.d.ts",
|
||||
"./node_modules/ethers-typescript-typings/index.d.ts"
|
||||
]
|
||||
```
|
||||
|
||||
#### UMD:
|
||||
|
||||
**Install**
|
||||
|
@ -8,6 +8,14 @@ Standard type and schema assertions to be used across all 0x projects and packag
|
||||
yarn add @0xproject/assert
|
||||
```
|
||||
|
||||
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
|
||||
|
||||
```
|
||||
"include": [
|
||||
"./node_modules/web3-typescript-typings/index.d.ts",
|
||||
]
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```typescript
|
||||
|
@ -8,6 +8,15 @@ BaseContract to derive all auto-generated wrappers from
|
||||
yarn add @0xproject/base-contract
|
||||
```
|
||||
|
||||
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
|
||||
|
||||
```
|
||||
"include": [
|
||||
"./node_modules/web3-typescript-typings/index.d.ts",
|
||||
"./node_modules/ethers-typescript-typings/index.d.ts"
|
||||
]
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```javascript
|
||||
|
@ -8,6 +8,14 @@ This repository contains a Javascript library that makes it easy to interact wit
|
||||
yarn add @0xproject/connect
|
||||
```
|
||||
|
||||
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
|
||||
|
||||
```
|
||||
"include": [
|
||||
"./node_modules/web3-typescript-typings/index.d.ts",
|
||||
]
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
* [Docs](https://0xproject.com/docs/connect)
|
||||
|
@ -7,3 +7,11 @@ Dev utils to be shared across 0x projects and packages
|
||||
```bash
|
||||
yarn add @0xproject/dev-utils
|
||||
```
|
||||
|
||||
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
|
||||
|
||||
```
|
||||
"include": [
|
||||
"./node_modules/web3-typescript-typings/index.d.ts",
|
||||
]
|
||||
```
|
||||
|
@ -10,6 +10,14 @@ We have written up a [Wiki](https://0xproject.com/wiki#Web3-Provider-Examples) a
|
||||
yarn add @0xproject/subproviders
|
||||
```
|
||||
|
||||
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
|
||||
|
||||
```
|
||||
"include": [
|
||||
"./node_modules/web3-typescript-typings/index.d.ts",
|
||||
]
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Simply import the subprovider you are interested in using:
|
||||
|
@ -8,6 +8,14 @@ Typescript types shared across 0x projects and packages
|
||||
yarn add -D @0xproject/types
|
||||
```
|
||||
|
||||
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
|
||||
|
||||
```
|
||||
"include": [
|
||||
"./node_modules/web3-typescript-typings/index.d.ts",
|
||||
]
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```javascript
|
||||
|
@ -8,6 +8,14 @@ Utils to be shared across 0x projects and packages
|
||||
yarn add @0xproject/utils
|
||||
```
|
||||
|
||||
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
|
||||
|
||||
```
|
||||
"include": [
|
||||
"./node_modules/web3-typescript-typings/index.d.ts",
|
||||
]
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```javascript
|
||||
|
@ -8,6 +8,14 @@ Wrapped version of web3 with a nicer interface that is used across 0x projects a
|
||||
yarn add @0xproject/web3-wrapper
|
||||
```
|
||||
|
||||
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
|
||||
|
||||
```
|
||||
"include": [
|
||||
"./node_modules/web3-typescript-typings/index.d.ts",
|
||||
]
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```typescript
|
||||
|
Loading…
x
Reference in New Issue
Block a user