aboutsummaryrefslogtreecommitdiffstats
path: root/packages/types
diff options
context:
space:
mode:
Diffstat (limited to 'packages/types')
-rw-r--r--packages/types/CHANGELOG.md3
-rw-r--r--packages/types/README.md12
-rw-r--r--packages/types/package.json58
-rw-r--r--packages/types/tsconfig.json25
-rw-r--r--packages/types/tslint.json4
5 files changed, 46 insertions, 56 deletions
diff --git a/packages/types/CHANGELOG.md b/packages/types/CHANGELOG.md
index b4cce6be0..899482c4c 100644
--- a/packages/types/CHANGELOG.md
+++ b/packages/types/CHANGELOG.md
@@ -1,4 +1,3 @@
# CHANGELOG
-vx.x.x
-------------------------
+## vx.x.x
diff --git a/packages/types/README.md b/packages/types/README.md
index c549a736f..d63970150 100644
--- a/packages/types/README.md
+++ b/packages/types/README.md
@@ -1,5 +1,4 @@
-@0xproject/types
-------
+## @0xproject/types
Typescript types shared across 0x projects and packages
@@ -12,14 +11,9 @@ yarn add -D @0xproject/types
## Usage
```javascript
-import {
- TransactionReceipt,
- TxData,
- TxDataPayable,
-} from '@0xproject/types';
+import { TransactionReceipt, TxData, TxDataPayable } from '@0xproject/types';
```
-
## Contributing
We strongly recommend 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.
@@ -29,11 +23,13 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting
### Install Dependencies
If you don't have yarn workspaces e`nabled (Yarn < v1.0) - enable them:
+
```bash
yarn config set workspaces-experimental true
```
Then install dependencies
+
```bash
yarn install
```
diff --git a/packages/types/package.json b/packages/types/package.json
index a16217169..67200203c 100644
--- a/packages/types/package.json
+++ b/packages/types/package.json
@@ -1,31 +1,31 @@
{
- "name": "@0xproject/types",
- "version": "0.1.2",
- "description": "0x types",
- "main": "lib/index.js",
- "types": "lib/index.d.ts",
- "scripts": {
- "build": "tsc",
- "clean": "shx rm -rf lib",
- "lint": "tslint --project . 'src/**/*.ts'"
- },
- "license": "Apache-2.0",
- "repository": {
- "type": "git",
- "url": "https://github.com/0xProject/0x.js.git"
- },
- "bugs": {
- "url": "https://github.com/0xProject/0x.js/issues"
- },
- "homepage": "https://github.com/0xProject/0x.js/packages/types/README.md",
- "devDependencies": {
- "@0xproject/tslint-config": "^0.4.0",
- "shx": "^0.2.2",
- "tslint": "5.8.0",
- "typescript": "~2.6.1"
- },
- "dependencies": {
- "@0xproject/utils": "^0.1.2",
- "web3": "^0.20.0"
- }
+ "name": "@0xproject/types",
+ "version": "0.1.2",
+ "description": "0x types",
+ "main": "lib/index.js",
+ "types": "lib/index.d.ts",
+ "scripts": {
+ "build": "tsc",
+ "clean": "shx rm -rf lib",
+ "lint": "tslint --project . 'src/**/*.ts'"
+ },
+ "license": "Apache-2.0",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/0xProject/0x.js.git"
+ },
+ "bugs": {
+ "url": "https://github.com/0xProject/0x.js/issues"
+ },
+ "homepage": "https://github.com/0xProject/0x.js/packages/types/README.md",
+ "devDependencies": {
+ "@0xproject/tslint-config": "^0.4.0",
+ "shx": "^0.2.2",
+ "tslint": "5.8.0",
+ "typescript": "~2.6.1"
+ },
+ "dependencies": {
+ "@0xproject/utils": "^0.1.2",
+ "web3": "^0.20.0"
+ }
}
diff --git a/packages/types/tsconfig.json b/packages/types/tsconfig.json
index de186cfc4..0aa8c3dde 100644
--- a/packages/types/tsconfig.json
+++ b/packages/types/tsconfig.json
@@ -1,16 +1,13 @@
{
- "compilerOptions": {
- "module": "commonjs",
- "target": "es5",
- "lib": [ "es2017", "dom"],
- "outDir": "lib",
- "sourceMap": true,
- "declaration": true,
- "noImplicitAny": true,
- "strictNullChecks": true
- },
- "include": [
- "./src/**/*",
- "../../node_modules/web3-typescript-typings/index.d.ts"
- ]
+ "compilerOptions": {
+ "module": "commonjs",
+ "target": "es5",
+ "lib": ["es2017", "dom"],
+ "outDir": "lib",
+ "sourceMap": true,
+ "declaration": true,
+ "noImplicitAny": true,
+ "strictNullChecks": true
+ },
+ "include": ["./src/**/*", "../../node_modules/web3-typescript-typings/index.d.ts"]
}
diff --git a/packages/types/tslint.json b/packages/types/tslint.json
index a07795151..ffaefe83a 100644
--- a/packages/types/tslint.json
+++ b/packages/types/tslint.json
@@ -1,5 +1,3 @@
{
- "extends": [
- "@0xproject/tslint-config"
- ]
+ "extends": ["@0xproject/tslint-config"]
}