@0x/types
Version:
70 lines (45 loc) • 1.23 kB
Markdown
## @0x/types
TypeScript types shared across 0x projects and packages
## Installation
```bash
yarn add -D @0x/types
```
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
```json
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
```
## Usage
```javascript
import { TransactionReceipt, TxData, TxDataPayable } from '@0x/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](../../CONTRIBUTING.md) before getting started.
### Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
```bash
yarn config set workspaces-experimental true
```
Then install dependencies
```bash
yarn install
```
### Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
```bash
PKG=@0x/types yarn build
```
Or continuously rebuild on change:
```bash
PKG=@0x/types yarn watch
```
### Clean
```bash
yarn clean
```
### Lint
```bash
yarn lint
```