Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 1.2 KB

README.md

File metadata and controls

69 lines (45 loc) · 1.2 KB

@0x/types

TypeScript types shared across 0x projects and packages

Installation

yarn add -D @0x/types

If your project is in TypeScript, add the following to your tsconfig.json:

"compilerOptions": {
    "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}

Usage

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 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=@0x/types yarn build

Or continuously rebuild on change:

PKG=@0x/types yarn watch

Clean

yarn clean

Lint

yarn lint