aboutsummaryrefslogtreecommitdiffstats
path: root/packages/json-schemas
diff options
context:
space:
mode:
Diffstat (limited to 'packages/json-schemas')
-rw-r--r--packages/json-schemas/README.md12
-rw-r--r--packages/json-schemas/package.json2
-rw-r--r--packages/json-schemas/tsconfig.json7
3 files changed, 12 insertions, 9 deletions
diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md
index f320196e9..980d17416 100644
--- a/packages/json-schemas/README.md
+++ b/packages/json-schemas/README.md
@@ -12,8 +12,8 @@ yarn add @0xproject/json-schemas
**Import**
-```javascript
-import { schemas } from '@0xproject/json-schemas';
+```typescript
+import { SchemaValidator, ValidatorResult, schemas } from '@0xproject/json-schemas';
```
or
@@ -22,6 +22,14 @@ or
var schemas = require('@0xproject/json-schemas').schemas;
```
+If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
+
+```json
+"compilerOptions": {
+ "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
+}
+```
+
## Contributing
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.
diff --git a/packages/json-schemas/package.json b/packages/json-schemas/package.json
index 1266f964b..f4f4c63b5 100644
--- a/packages/json-schemas/package.json
+++ b/packages/json-schemas/package.json
@@ -39,6 +39,7 @@
},
"homepage": "https://github.com/0xProject/0x-monorepo/packages/json-schemas/README.md",
"dependencies": {
+ "@0xproject/typescript-typings": "^0.0.1",
"jsonschema": "^1.2.0",
"lodash.values": "^4.3.0"
},
@@ -50,7 +51,6 @@
"@types/lodash.values": "^4.3.3",
"@types/mocha": "^2.2.42",
"chai": "^4.0.1",
- "chai-typescript-typings": "^0.0.6",
"copyfiles": "^1.2.0",
"dirty-chai": "^2.0.1",
"lodash.foreach": "^4.5.0",
diff --git a/packages/json-schemas/tsconfig.json b/packages/json-schemas/tsconfig.json
index 10354fa33..e35816553 100644
--- a/packages/json-schemas/tsconfig.json
+++ b/packages/json-schemas/tsconfig.json
@@ -3,10 +3,5 @@
"compilerOptions": {
"outDir": "lib"
},
- "include": [
- "./src/**/*",
- "./test/**/*",
- "../../node_modules/web3-typescript-typings/index.d.ts",
- "../../node_modules/chai-typescript-typings/index.d.ts"
- ]
+ "include": ["./src/**/*", "./test/**/*"]
}