diff options
Diffstat (limited to 'packages/connect')
-rw-r--r-- | packages/connect/README.md | 18 | ||||
-rw-r--r-- | packages/connect/package.json | 10 | ||||
-rw-r--r-- | packages/connect/src/ws_orderbook_channel.ts | 4 |
3 files changed, 10 insertions, 22 deletions
diff --git a/packages/connect/README.md b/packages/connect/README.md index a57fefa59..9d8cb9215 100644 --- a/packages/connect/README.md +++ b/packages/connect/README.md @@ -43,28 +43,16 @@ yarn install ### Build -If this is your **first** time building this package, you must first build **all** packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from **within** the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory: +To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: ```bash -yarn lerna:rebuild +PKG=@0xproject/connect yarn build ``` Or continuously rebuild on change: ```bash -yarn dev -``` - -You can also build this specific package by running the following from within its directory: - -```bash -yarn build -``` - -or continuously rebuild on change: - -```bash -yarn build:watch +PKG=@0xproject/connect yarn watch ``` ### Clean diff --git a/packages/connect/package.json b/packages/connect/package.json index 2930de98e..d52fb450e 100644 --- a/packages/connect/package.json +++ b/packages/connect/package.json @@ -1,6 +1,9 @@ { "name": "@0xproject/connect", "version": "0.6.12", + "engines": { + "node" : ">=6.12" + }, "description": "A javascript library for interacting with the standard relayer api", "keywords": [ "connect", @@ -12,7 +15,7 @@ "main": "lib/src/index.js", "types": "lib/src/index.d.ts", "scripts": { - "build:watch": "tsc -w", + "watch": "tsc -w", "build": "tsc && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts", "clean": "shx rm -rf lib test_temp scripts", "copy_test_fixtures": "copyfiles -u 2 './test/fixtures/**/*.json' ./lib/test/fixtures", @@ -23,7 +26,7 @@ "coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info", "test:circleci": "yarn test:coverage", "manual:postpublish": "yarn build; node ./scripts/postpublish.js", - "docs:stage": "yarn build && node ./scripts/stage_docs.js", + "docs:stage": "node scripts/stage_docs.js", "docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES", "upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json" }, @@ -42,9 +45,6 @@ }, "author": "Brandon Millman", "license": "Apache-2.0", - "engines": { - "node": ">=6.0.0" - }, "bugs": { "url": "https://github.com/0xProject/0x-monorepo/issues" }, diff --git a/packages/connect/src/ws_orderbook_channel.ts b/packages/connect/src/ws_orderbook_channel.ts index 5aa730d8f..4a9d4058f 100644 --- a/packages/connect/src/ws_orderbook_channel.ts +++ b/packages/connect/src/ws_orderbook_channel.ts @@ -91,7 +91,7 @@ export class WebSocketOrderbookChannel implements OrderbookChannel { /** * Close the websocket and stop receiving updates */ - public close() { + public close(): void { if (!_.isUndefined(this._connectionIfExists)) { this._connectionIfExists.close(); } @@ -99,7 +99,7 @@ export class WebSocketOrderbookChannel implements OrderbookChannel { clearInterval(this._heartbeatTimerIfExists); } } - private _getConnection(callback: (error?: Error, connection?: WebSocket.connection) => void) { + private _getConnection(callback: (error?: Error, connection?: WebSocket.connection) => void): void { if (!_.isUndefined(this._connectionIfExists) && this._connectionIfExists.connected) { callback(undefined, this._connectionIfExists); } else { |