From 2aa0e60d2f5b9e91cae135450c145f8b014276d3 Mon Sep 17 00:00:00 2001 From: fabioberger Date: Fri, 2 Aug 2019 23:26:48 +0200 Subject: [PATCH 01/12] Add script for combining the TS client MD files into a single file and modify the `docs:md` command to do it --- rpc/clients/typescript/package.json | 9 ++- .../typescript/scripts/post_process_docs.ts | 63 +++++++++++++++++++ rpc/clients/typescript/tsconfig.json | 2 +- rpc/clients/typescript/yarn.lock | 13 +++- 4 files changed, 83 insertions(+), 4 deletions(-) create mode 100644 rpc/clients/typescript/scripts/post_process_docs.ts diff --git a/rpc/clients/typescript/package.json b/rpc/clients/typescript/package.json index e93b8a45a..c4436ba5c 100644 --- a/rpc/clients/typescript/package.json +++ b/rpc/clients/typescript/package.json @@ -21,7 +21,12 @@ "lint": "tslint --format stylish --project .", "fix": "tslint --fix --format stylish --project .", "test": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --exit", - "docs:md": "typedoc --theme markdown --platform gitbook --excludePrivate --excludeProtected --excludeExternals --excludeNotExported --target ES5 --module commonjs --out ../../../docs/json_rpc_clients/typescript/ ./src" + "script:processDocs": "node ./lib/scripts/post_process_docs.js", + "docs:generate": "typedoc --theme markdown --platform gitbook --excludePrivate --excludeProtected --excludeExternals --excludeNotExported --target ES5 --module commonjs --out ${npm_package_config_docspath} ./src", + "docs:md": "rm -rf ${npm_package_config_docspath}; yarn docs:generate; yarn script:processDocs;" + }, + "config": { + "docspath": "../../../docs/json_rpc_clients/typescript/" }, "repository": { "type": "git", @@ -46,6 +51,7 @@ }, "devDependencies": { "@0x/tslint-config": "^3.0.1", + "@types/glob": "^7.1.1", "@types/mocha": "^2.2.42", "@types/uuid": "^3.4.3", "@types/websocket": "^0.0.40", @@ -53,6 +59,7 @@ "chai-as-promised": "^7.1.0", "chai-bignumber": "^3.0.0", "dirty-chai": "^2.0.1", + "glob": "^7.1.4", "make-promises-safe": "^1.1.0", "mocha": "^4.1.0", "shx": "^0.2.2", diff --git a/rpc/clients/typescript/scripts/post_process_docs.ts b/rpc/clients/typescript/scripts/post_process_docs.ts new file mode 100644 index 000000000..39861aecd --- /dev/null +++ b/rpc/clients/typescript/scripts/post_process_docs.ts @@ -0,0 +1,63 @@ +import * as fs from 'fs'; +import * as glob from 'glob'; + +function main(): void { + // Concat all TS Client MD files together + const tsClientDocsRoot = `${process.cwd()}/../../../docs/json_rpc_clients/typescript`; + const allMdPath = `${tsClientDocsRoot}/all.md`; + + if (fs.existsSync(allMdPath)) { + fs.unlinkSync(allMdPath); + } + glob(`${tsClientDocsRoot}/**/*`, (err: Error | null, paths: string[]) => { + if (err !== null) { + throw err; + } + (paths as any).sort((firstEl: string, secondEl: string) => { + const firstIsFile = firstEl.includes('.md'); + const secondIsFile = secondEl.includes('.md'); + if ((firstIsFile && secondIsFile) || (!firstIsFile && !secondIsFile)) { + return 0; + } + if (firstIsFile) { + return -1; + } + if (secondIsFile) { + return 1; + } + return undefined; + }); + for (const path of paths) { + if (path.includes('.md', 1)) { + if (!path.includes('README.md', 1) && !path.includes('all.md', 1) && !path.includes('/modules/', 1) && !path.includes('globals.md', 1)) { + // Read file content and concat to new file + const content = fs.readFileSync(path); + fs.appendFileSync(allMdPath, content); + fs.appendFileSync(allMdPath, '\n'); + fs.appendFileSync(allMdPath, '\n'); + fs.appendFileSync(allMdPath, '
'); + fs.appendFileSync(allMdPath, '\n'); + fs.appendFileSync(allMdPath, '\n'); + } + if (!path.includes('README.md', 1)) { + fs.unlinkSync(path); + } + } else { + fs.rmdirSync(path); + } + } + + // Find/replace relative links with hash links + const docsBuff = fs.readFileSync(allMdPath); + let docs = docsBuff.toString(); + docs = docs.replace(/\]\(((?!.*(github.com)).*)(#.*\))/g, ']($3'); + docs = docs.replace(/\]\(..\/interfaces\/.*?\.(.*?)\.md\)/g, '](#interface-$1)'); + docs = docs.replace(/\]\(..\/classes\/.*?\.(.*?)\.md\)/g, '](#class-$1)'); + docs = docs.replace(/\]\(..\/enums\/.*?\.(.*?)\.md\)/g, '](#enumeration-$1)'); + docs = docs.replace(/\]\(_types_\.(.*?)\.md\)/g, '](#interface-$1)'); + docs = docs.replace(/\]\(.*\.(.*?)\.md\)/g, '](#class-$1)'); + fs.writeFileSync(allMdPath, docs); + }); +} + +main(); diff --git a/rpc/clients/typescript/tsconfig.json b/rpc/clients/typescript/tsconfig.json index 432648e84..06a983871 100644 --- a/rpc/clients/typescript/tsconfig.json +++ b/rpc/clients/typescript/tsconfig.json @@ -15,5 +15,5 @@ "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], "strict": true, }, - "include": ["./src/**/*", "./test/**/*"] + "include": ["./src/**/*", "./test/**/*", "./scripts/**/*"], } diff --git a/rpc/clients/typescript/yarn.lock b/rpc/clients/typescript/yarn.lock index 555393322..70c456aca 100644 --- a/rpc/clients/typescript/yarn.lock +++ b/rpc/clients/typescript/yarn.lock @@ -304,6 +304,15 @@ resolved "https://registry.yarnpkg.com/@types/events/-/events-3.0.0.tgz#2862f3f58a9a7f7c3e78d79f130dd4d71c25c2a7" integrity sha512-EaObqwIvayI5a8dCzhFrjKzVwKLxjoG9T6Ppd5CEo07LRKfQ8Yokw54r5+Wq7FaBQ+yXRvQAYPrHwya1/UFt9g== +"@types/glob@^7.1.1": + version "7.1.1" + resolved "https://registry.yarnpkg.com/@types/glob/-/glob-7.1.1.tgz#aa59a1c6e3fbc421e07ccd31a944c30eba521575" + integrity sha512-1Bh06cbWJUHMC97acuD6UMG29nMt0Aqz1vF3guLfG+kHHJhy3AyohZFFxYk2f7Q1SQIrNwvncxAE0N/9s70F2w== + dependencies: + "@types/events" "*" + "@types/minimatch" "*" + "@types/node" "*" + "@types/hdkey@^0.7.0": version "0.7.0" resolved "https://registry.yarnpkg.com/@types/hdkey/-/hdkey-0.7.0.tgz#6734d138e3c597f241be8fae2e60c2949bc3af87" @@ -311,7 +320,7 @@ dependencies: "@types/node" "*" -"@types/minimatch@3.0.3": +"@types/minimatch@*", "@types/minimatch@3.0.3": version "3.0.3" resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d" integrity sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA== @@ -3362,7 +3371,7 @@ glob@7.1.2: once "^1.3.0" path-is-absolute "^1.0.0" -glob@^7.0.0, glob@^7.1.1, glob@^7.1.3, glob@~7.1.4: +glob@^7.0.0, glob@^7.1.1, glob@^7.1.3, glob@^7.1.4, glob@~7.1.4: version "7.1.4" resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.4.tgz#aa608a2f6c577ad357e1ae5a5c26d9a8d1969255" integrity sha512-hkLPepehmnKk41pUGm3sYxoFs/umurYfYJCerbXEyFIWcAzvpipAgVkBqqT9RBKMGjnq6kMuyYwha6csxbiM1A== From 67453766ed0582503dad72f58fb94f7b94ff0e2f Mon Sep 17 00:00:00 2001 From: fabioberger Date: Fri, 2 Aug 2019 23:30:36 +0200 Subject: [PATCH 02/12] Run new docs:md script and replace individual files with single "Doc reference" --- cmd/cut-release/main.go | 45 - docs/SUMMARY.md | 51 +- docs/json_rpc_clients/typescript/all.md | 1529 +++++++++++++++++ .../classes/_ws_client_.wsclient.md | 186 -- .../enums/_types_.ordereventkind.md | 78 - .../typescript/enums/_types_.rejectedcode.md | 132 -- .../typescript/enums/_types_.rejectedkind.md | 33 - docs/json_rpc_clients/typescript/globals.md | 9 - .../interfaces/_types_.acceptedorderinfo.md | 37 - .../interfaces/_types_.clientconfig.md | 85 - .../interfaces/_types_.getordersresponse.md | 28 - .../_types_.heartbeateventpayload.md | 28 - .../interfaces/_types_.orderevent.md | 55 - .../interfaces/_types_.ordereventpayload.md | 28 - .../_types_.rawacceptedorderinfo.md | 37 - .../interfaces/_types_.raworderevent.md | 55 - .../_types_.rawrejectedorderinfo.md | 46 - .../_types_.rawvalidationresults.md | 28 - .../interfaces/_types_.rejectedorderinfo.md | 46 - .../interfaces/_types_.rejectedstatus.md | 28 - .../_types_.stringifiedsignedorder.md | 136 -- .../interfaces/_types_.validationresults.md | 28 - .../interfaces/_types_.wsmessage.md | 28 - .../typescript/interfaces/_types_.wsopts.md | 63 - .../typescript/modules/_index_.md | 1 - .../typescript/modules/_types_.md | 28 - .../typescript/modules/_ws_client_.md | 7 - 27 files changed, 1530 insertions(+), 1325 deletions(-) create mode 100644 docs/json_rpc_clients/typescript/all.md delete mode 100644 docs/json_rpc_clients/typescript/classes/_ws_client_.wsclient.md delete mode 100644 docs/json_rpc_clients/typescript/enums/_types_.ordereventkind.md delete mode 100644 docs/json_rpc_clients/typescript/enums/_types_.rejectedcode.md delete mode 100644 docs/json_rpc_clients/typescript/enums/_types_.rejectedkind.md delete mode 100644 docs/json_rpc_clients/typescript/globals.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.acceptedorderinfo.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.clientconfig.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.getordersresponse.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.heartbeateventpayload.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.orderevent.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.ordereventpayload.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.rawacceptedorderinfo.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.raworderevent.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.rawrejectedorderinfo.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.rawvalidationresults.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.rejectedorderinfo.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.rejectedstatus.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.stringifiedsignedorder.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.validationresults.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.wsmessage.md delete mode 100644 docs/json_rpc_clients/typescript/interfaces/_types_.wsopts.md delete mode 100644 docs/json_rpc_clients/typescript/modules/_index_.md delete mode 100644 docs/json_rpc_clients/typescript/modules/_types_.md delete mode 100644 docs/json_rpc_clients/typescript/modules/_ws_client_.md diff --git a/cmd/cut-release/main.go b/cmd/cut-release/main.go index f52c251f9..24ae00aef 100644 --- a/cmd/cut-release/main.go +++ b/cmd/cut-release/main.go @@ -4,7 +4,6 @@ import ( "fmt" "io/ioutil" "log" - "os" "os/exec" "regexp" "strings" @@ -72,50 +71,6 @@ func generateTypescriptClientDocs() { log.Print(string(stdoutStderr)) log.Fatal(err) } - - // Update SUMMARY.md - tsClientSummaryPath := "docs/json_rpc_clients/typescript/SUMMARY.md" - dat, err := ioutil.ReadFile(tsClientSummaryPath) - if err != nil { - log.Fatal(err) - } - // Modify the paths to be prefixed with `json_rpc_clients/typescript` - modifiedDat := strings.Replace(string(dat), "](", "](json_rpc_clients/typescript/", -1) - modifiedDat = strings.Replace(modifiedDat, "](json_rpc_clients/typescript/)", "]()", -1) - finalTsClientSummary := strings.Replace(modifiedDat, "* [", " * [", -1) - - // Replace the summary content nested under `Typescript client` - mainSummaryPath := "docs/SUMMARY.md" - dat, err = ioutil.ReadFile(mainSummaryPath) - if err != nil { - log.Fatal(err) - } - finalSummaryLines := []string{} - lines := strings.Split(string(dat), "\n") - isCutting := false - for _, l := range lines { - if strings.Contains(l, "") { - isCutting = false - finalSummaryLines = append(finalSummaryLines, finalTsClientSummary) - } - if !isCutting { - finalSummaryLines = append(finalSummaryLines, l) - } - if strings.Contains(l, "") { - isCutting = true - } - } - finalSummary := strings.Join(finalSummaryLines, "\n") - err = ioutil.WriteFile(mainSummaryPath, []byte(finalSummary), 0644) - if err != nil { - log.Fatal(err) - } - - // Remove the nested SUMMARY.MD file - err = os.Remove(tsClientSummaryPath) - if err != nil { - log.Fatal(err) - } } // Update the version string in all files that must be updated for a new release diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 4eaa79cc4..81f81a199 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -14,56 +14,7 @@ * [Golang client](https://godoc.org/github.com/0xProject/0x-mesh/rpc) * [TypeScript client](json_rpc_clients/typescript/README.md) - - * [Globals](json_rpc_clients/typescript/globals.md) - * [External Modules]() - * [index](json_rpc_clients/typescript/modules/_index_.md) - * [types](json_rpc_clients/typescript/modules/_types_.md) - * [types.OrderEventKind](json_rpc_clients/typescript/enums/_types_.ordereventkind.md) - * [types.RejectedCode](json_rpc_clients/typescript/enums/_types_.rejectedcode.md) - * [types.RejectedKind](json_rpc_clients/typescript/enums/_types_.rejectedkind.md) - * [types.AcceptedOrderInfo](json_rpc_clients/typescript/interfaces/_types_.acceptedorderinfo.md) - * [types.ClientConfig](json_rpc_clients/typescript/interfaces/_types_.clientconfig.md) - * [types.GetOrdersResponse](json_rpc_clients/typescript/interfaces/_types_.getordersresponse.md) - * [types.HeartbeatEventPayload](json_rpc_clients/typescript/interfaces/_types_.heartbeateventpayload.md) - * [types.OrderEvent](json_rpc_clients/typescript/interfaces/_types_.orderevent.md) - * [types.OrderEventPayload](json_rpc_clients/typescript/interfaces/_types_.ordereventpayload.md) - * [types.RawAcceptedOrderInfo](json_rpc_clients/typescript/interfaces/_types_.rawacceptedorderinfo.md) - * [types.RawOrderEvent](json_rpc_clients/typescript/interfaces/_types_.raworderevent.md) - * [types.RawRejectedOrderInfo](json_rpc_clients/typescript/interfaces/_types_.rawrejectedorderinfo.md) - * [types.RawValidationResults](json_rpc_clients/typescript/interfaces/_types_.rawvalidationresults.md) - * [types.RejectedOrderInfo](json_rpc_clients/typescript/interfaces/_types_.rejectedorderinfo.md) - * [types.RejectedStatus](json_rpc_clients/typescript/interfaces/_types_.rejectedstatus.md) - * [types.StringifiedSignedOrder](json_rpc_clients/typescript/interfaces/_types_.stringifiedsignedorder.md) - * [types.ValidationResults](json_rpc_clients/typescript/interfaces/_types_.validationresults.md) - * [types.WSMessage](json_rpc_clients/typescript/interfaces/_types_.wsmessage.md) - * [types.WSOpts](json_rpc_clients/typescript/interfaces/_types_.wsopts.md) - * [ws_client](json_rpc_clients/typescript/modules/_ws_client_.md) - * [ws_client.WSClient](json_rpc_clients/typescript/classes/_ws_client_.wsclient.md) - * [Classes]() - * [ws_client.WSClient](json_rpc_clients/typescript/classes/_ws_client_.wsclient.md) - * [Enums]() - * [types.OrderEventKind](json_rpc_clients/typescript/enums/_types_.ordereventkind.md) - * [types.RejectedCode](json_rpc_clients/typescript/enums/_types_.rejectedcode.md) - * [types.RejectedKind](json_rpc_clients/typescript/enums/_types_.rejectedkind.md) - * [Interfaces]() - * [types.AcceptedOrderInfo](json_rpc_clients/typescript/interfaces/_types_.acceptedorderinfo.md) - * [types.ClientConfig](json_rpc_clients/typescript/interfaces/_types_.clientconfig.md) - * [types.GetOrdersResponse](json_rpc_clients/typescript/interfaces/_types_.getordersresponse.md) - * [types.HeartbeatEventPayload](json_rpc_clients/typescript/interfaces/_types_.heartbeateventpayload.md) - * [types.OrderEvent](json_rpc_clients/typescript/interfaces/_types_.orderevent.md) - * [types.OrderEventPayload](json_rpc_clients/typescript/interfaces/_types_.ordereventpayload.md) - * [types.RawAcceptedOrderInfo](json_rpc_clients/typescript/interfaces/_types_.rawacceptedorderinfo.md) - * [types.RawOrderEvent](json_rpc_clients/typescript/interfaces/_types_.raworderevent.md) - * [types.RawRejectedOrderInfo](json_rpc_clients/typescript/interfaces/_types_.rawrejectedorderinfo.md) - * [types.RawValidationResults](json_rpc_clients/typescript/interfaces/_types_.rawvalidationresults.md) - * [types.RejectedOrderInfo](json_rpc_clients/typescript/interfaces/_types_.rejectedorderinfo.md) - * [types.RejectedStatus](json_rpc_clients/typescript/interfaces/_types_.rejectedstatus.md) - * [types.StringifiedSignedOrder](json_rpc_clients/typescript/interfaces/_types_.stringifiedsignedorder.md) - * [types.ValidationResults](json_rpc_clients/typescript/interfaces/_types_.validationresults.md) - * [types.WSMessage](json_rpc_clients/typescript/interfaces/_types_.wsmessage.md) - * [types.WSOpts](json_rpc_clients/typescript/interfaces/_types_.wsopts.md) - + * [Doc reference](json_rpc_clients/typescript/all.md) ## Contributing diff --git a/docs/json_rpc_clients/typescript/all.md b/docs/json_rpc_clients/typescript/all.md new file mode 100644 index 000000000..003a51ac8 --- /dev/null +++ b/docs/json_rpc_clients/typescript/all.md @@ -0,0 +1,1529 @@ +> # Class: WSClient + +This class includes all the functionality related to interacting with a Mesh JSON RPC +websocket endpoint. + +## Hierarchy + +* **WSClient** + +## Index + +### Constructors + +* [constructor](#constructor) + +### Methods + +* [addOrdersAsync](#addordersasync) +* [destroy](#destroy) +* [getOrdersAsync](#getordersasync) +* [getStatsAsync](#getstatsasync) +* [onClose](#onclose) +* [onReconnected](#onreconnected) +* [subscribeToOrdersAsync](#subscribetoordersasync) +* [unsubscribeAsync](#unsubscribeasync) + +## Constructors + +### constructor + +\+ **new WSClient**(`url`: string, `wsOpts?`: [WSOpts](#class-wsclient)* + +*Defined in [ws_client.ts:71](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L71)* + +Instantiates a new WSClient instance + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`url` | string | WS server endpoint | +`wsOpts?` | [WSOpts](#interface-wsopts) | WebSocket options | + +**Returns:** *[WSClient](#class-wsclient)* + +An instance of WSClient + +## Methods + +### addOrdersAsync + +▸ **addOrdersAsync**(`signedOrders`: `SignedOrder`[]): *`Promise`* + +*Defined in [ws_client.ts:96](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L96)* + +Adds an array of 0x signed orders to the Mesh node. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`signedOrders` | `SignedOrder`[] | signedOrders to add | + +**Returns:** *`Promise`* + +validation results + +___ + +### destroy + +▸ **destroy**(): *void* + +*Defined in [ws_client.ts:213](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L213)* + +destroy unsubscribes all active subscriptions, closes the websocket connection +and stops the internal heartbeat connection liveness check. + +**Returns:** *void* + +___ + +### getOrdersAsync + +▸ **getOrdersAsync**(`perPage`: number): *`Promise`* + +*Defined in [ws_client.ts:125](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L125)* + +Get all 0x signed orders currently stored in the Mesh node + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`perPage` | number | 200 | number of signedOrders to fetch per paginated request | + +**Returns:** *`Promise`* + +all orders, their hash and their fillableTakerAssetAmount + +___ + +### getStatsAsync + +▸ **getStatsAsync**(): *`Promise`* + +*Defined in [ws_client.ts:116](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L116)* + +**Returns:** *`Promise`* + +___ + +### onClose + +▸ **onClose**(`cb`: function): *void* + +*Defined in [ws_client.ts:195](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L195)* + +Get notified when the underlying WS connection closes normally. If it closes with an +error, WSClient automatically attempts to re-connect without emitting a `close` event. + +**Parameters:** + +▪ **cb**: *function* + +callback to call when WS connection closes + +▸ (): *void* + +**Returns:** *void* + +___ + +### onReconnected + +▸ **onReconnected**(`cb`: function): *void* + +*Defined in [ws_client.ts:204](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L204)* + +Get notified when a connection to the underlying WS connection is re-established + +**Parameters:** + +▪ **cb**: *function* + +callback to call with the error when it occurs + +▸ (): *void* + +**Returns:** *void* + +___ + +### subscribeToOrdersAsync + +▸ **subscribeToOrdersAsync**(`cb`: function): *`Promise`* + +*Defined in [ws_client.ts:156](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L156)* + +Subscribe to the 'orders' topic and receive order events from Mesh. This method returns a +subscriptionId that can be used to `unsubscribe()` from this subscription. + +**Parameters:** + +▪ **cb**: *function* + +callback function where you'd like to get notified about order events + +▸ (`orderEvents`: [OrderEvent](#interface-orderevent)[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`orderEvents` | [OrderEvent](#interface-orderevent)[] | + +**Returns:** *`Promise`* + +subscriptionId + +___ + +### unsubscribeAsync + +▸ **unsubscribeAsync**(`subscriptionId`: string): *`Promise`* + +*Defined in [ws_client.ts:185](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L185)* + +Unsubscribe from a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionId` | string | identifier of the subscription to cancel | + +**Returns:** *`Promise`* + +
+ +> # Enumeration: OrderEventKind + +## Index + +### Enumeration members + +* [Added](#added) +* [Cancelled](#cancelled) +* [Expired](#expired) +* [FillabilityIncreased](#fillabilityincreased) +* [Filled](#filled) +* [FullyFilled](#fullyfilled) +* [Invalid](#invalid) +* [Unfunded](#unfunded) + +## Enumeration members + +### Added + +• **Added**: = "ADDED" + +*Defined in [types.ts:55](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L55)* + +___ + +### Cancelled + +• **Cancelled**: = "CANCELLED" + +*Defined in [types.ts:58](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L58)* + +___ + +### Expired + +• **Expired**: = "EXPIRED" + +*Defined in [types.ts:59](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L59)* + +___ + +### FillabilityIncreased + +• **FillabilityIncreased**: = "FILLABILITY_INCREASED" + +*Defined in [types.ts:61](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L61)* + +___ + +### Filled + +• **Filled**: = "FILLED" + +*Defined in [types.ts:56](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L56)* + +___ + +### FullyFilled + +• **FullyFilled**: = "FULLY_FILLED" + +*Defined in [types.ts:57](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L57)* + +___ + +### Invalid + +• **Invalid**: = "INVALID" + +*Defined in [types.ts:54](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L54)* + +___ + +### Unfunded + +• **Unfunded**: = "UNFUNDED" + +*Defined in [types.ts:60](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L60)* + +
+ +> # Enumeration: RejectedCode + +## Index + +### Enumeration members + +* [InternalError](#internalerror) +* [MaxOrderSizeExceeded](#maxordersizeexceeded) +* [NetworkRequestFailed](#networkrequestfailed) +* [OrderAlreadyStored](#orderalreadystored) +* [OrderCancelled](#ordercancelled) +* [OrderExpired](#orderexpired) +* [OrderForIncorrectNetwork](#orderforincorrectnetwork) +* [OrderFullyFilled](#orderfullyfilled) +* [OrderHasInvalidMakerAssetAmount](#orderhasinvalidmakerassetamount) +* [OrderHasInvalidMakerAssetData](#orderhasinvalidmakerassetdata) +* [OrderHasInvalidSignature](#orderhasinvalidsignature) +* [OrderHasInvalidTakerAssetAmount](#orderhasinvalidtakerassetamount) +* [OrderHasInvalidTakerAssetData](#orderhasinvalidtakerassetdata) +* [OrderUnfunded](#orderunfunded) + +## Enumeration members + +### InternalError + +• **InternalError**: = "InternalError" + +*Defined in [types.ts:123](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L123)* + +___ + +### MaxOrderSizeExceeded + +• **MaxOrderSizeExceeded**: = "MaxOrderSizeExceeded" + +*Defined in [types.ts:124](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L124)* + +___ + +### NetworkRequestFailed + +• **NetworkRequestFailed**: = "NetworkRequestFailed" + +*Defined in [types.ts:127](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L127)* + +___ + +### OrderAlreadyStored + +• **OrderAlreadyStored**: = "OrderAlreadyStored" + +*Defined in [types.ts:125](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L125)* + +___ + +### OrderCancelled + +• **OrderCancelled**: = "OrderCancelled" + +*Defined in [types.ts:132](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L132)* + +___ + +### OrderExpired + +• **OrderExpired**: = "OrderExpired" + +*Defined in [types.ts:130](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L130)* + +___ + +### OrderForIncorrectNetwork + +• **OrderForIncorrectNetwork**: = "OrderForIncorrectNetwork" + +*Defined in [types.ts:126](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L126)* + +___ + +### OrderFullyFilled + +• **OrderFullyFilled**: = "OrderFullyFilled" + +*Defined in [types.ts:131](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L131)* + +___ + +### OrderHasInvalidMakerAssetAmount + +• **OrderHasInvalidMakerAssetAmount**: = "OrderHasInvalidMakerAssetAmount" + +*Defined in [types.ts:128](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L128)* + +___ + +### OrderHasInvalidMakerAssetData + +• **OrderHasInvalidMakerAssetData**: = "OrderHasInvalidMakerAssetData" + +*Defined in [types.ts:134](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L134)* + +___ + +### OrderHasInvalidSignature + +• **OrderHasInvalidSignature**: = "OrderHasInvalidSignature" + +*Defined in [types.ts:136](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L136)* + +___ + +### OrderHasInvalidTakerAssetAmount + +• **OrderHasInvalidTakerAssetAmount**: = "OrderHasInvalidTakerAssetAmount" + +*Defined in [types.ts:129](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L129)* + +___ + +### OrderHasInvalidTakerAssetData + +• **OrderHasInvalidTakerAssetData**: = "OrderHasInvalidTakerAssetData" + +*Defined in [types.ts:135](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L135)* + +___ + +### OrderUnfunded + +• **OrderUnfunded**: = "OrderUnfunded" + +*Defined in [types.ts:133](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L133)* + +
+ +> # Enumeration: RejectedKind + +## Index + +### Enumeration members + +* [MeshError](#mesherror) +* [MeshValidation](#meshvalidation) +* [ZeroexValidation](#zeroexvalidation) + +## Enumeration members + +### MeshError + +• **MeshError**: = "MESH_ERROR" + +*Defined in [types.ts:118](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L118)* + +___ + +### MeshValidation + +• **MeshValidation**: = "MESH_VALIDATION" + +*Defined in [types.ts:119](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L119)* + +___ + +### ZeroexValidation + +• **ZeroexValidation**: = "ZEROEX_VALIDATION" + +*Defined in [types.ts:117](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L117)* + +
+ +> # Interface: AcceptedOrderInfo + +## Hierarchy + +* **AcceptedOrderInfo** + +## Index + +### Properties + +* [fillableTakerAssetAmount](#fillabletakerassetamount) +* [isNew](#isnew) +* [orderHash](#orderhash) +* [signedOrder](#signedorder) + +## Properties + +### fillableTakerAssetAmount + +• **fillableTakerAssetAmount**: *`BigNumber`* + +*Defined in [types.ts:100](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L100)* + +___ + +### isNew + +• **isNew**: *boolean* + +*Defined in [types.ts:101](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L101)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [types.ts:98](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L98)* + +___ + +### signedOrder + +• **signedOrder**: *`SignedOrder`* + +*Defined in [types.ts:99](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L99)* + +
+ +> # Interface: ClientConfig + +WebSocketClient configs +Source: https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketClient.md#client-config-options + +## Hierarchy + +* **ClientConfig** + +## Index + +### Properties + +* [assembleFragments](#optional-assemblefragments) +* [closeTimeout](#optional-closetimeout) +* [fragmentOutgoingMessages](#optional-fragmentoutgoingmessages) +* [fragmentationThreshold](#optional-fragmentationthreshold) +* [maxReceivedFrameSize](#optional-maxreceivedframesize) +* [maxReceivedMessageSize](#optional-maxreceivedmessagesize) +* [tlsOptions](#optional-tlsoptions) +* [webSocketVersion](#optional-websocketversion) + +## Properties + +### `Optional` assembleFragments + +• **assembleFragments**? : *undefined | false | true* + +*Defined in [types.ts:14](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L14)* + +___ + +### `Optional` closeTimeout + +• **closeTimeout**? : *undefined | number* + +*Defined in [types.ts:15](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L15)* + +___ + +### `Optional` fragmentOutgoingMessages + +• **fragmentOutgoingMessages**? : *undefined | false | true* + +*Defined in [types.ts:12](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L12)* + +___ + +### `Optional` fragmentationThreshold + +• **fragmentationThreshold**? : *undefined | number* + +*Defined in [types.ts:13](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L13)* + +___ + +### `Optional` maxReceivedFrameSize + +• **maxReceivedFrameSize**? : *undefined | number* + +*Defined in [types.ts:10](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L10)* + +___ + +### `Optional` maxReceivedMessageSize + +• **maxReceivedMessageSize**? : *undefined | number* + +*Defined in [types.ts:11](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L11)* + +___ + +### `Optional` tlsOptions + +• **tlsOptions**? : *any* + +*Defined in [types.ts:16](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L16)* + +___ + +### `Optional` webSocketVersion + +• **webSocketVersion**? : *undefined | number* + +*Defined in [types.ts:9](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L9)* + +
+ +> # Interface: GetOrdersResponse + +## Hierarchy + +* **GetOrdersResponse** + +## Index + +### Properties + +* [ordersInfos](#ordersinfos) +* [snapshotID](#snapshotid) + +## Properties + +### ordersInfos + +• **ordersInfos**: *[RawAcceptedOrderInfo](#interface-rawacceptedorderinfo)[]* + +*Defined in [types.ts:170](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L170)* + +___ + +### snapshotID + +• **snapshotID**: *string* + +*Defined in [types.ts:169](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L169)* + +
+ +> # Interface: GetStatsResponse + +## Hierarchy + +* **GetStatsResponse** + +## Index + +### Properties + +* [EthereumNetworkID](#ethereumnetworkid) +* [LatestBlock](#latestblock) +* [NumOrders](#numorders) +* [NumPeers](#numpeers) +* [PeerID](#peerid) +* [PubSubTopic](#pubsubtopic) +* [Rendezvous](#rendezvous) +* [Version](#version) + +## Properties + +### EthereumNetworkID + +• **EthereumNetworkID**: *number* + +*Defined in [types.ts:188](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L188)* + +___ + +### LatestBlock + +• **LatestBlock**: *[LatestBlock](#interface-latestblock)* + +*Defined in [types.ts:189](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L189)* + +___ + +### NumOrders + +• **NumOrders**: *number* + +*Defined in [types.ts:191](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L191)* + +___ + +### NumPeers + +• **NumPeers**: *number* + +*Defined in [types.ts:190](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L190)* + +___ + +### PeerID + +• **PeerID**: *string* + +*Defined in [types.ts:187](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L187)* + +___ + +### PubSubTopic + +• **PubSubTopic**: *string* + +*Defined in [types.ts:185](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L185)* + +___ + +### Rendezvous + +• **Rendezvous**: *string* + +*Defined in [types.ts:186](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L186)* + +___ + +### Version + +• **Version**: *string* + +*Defined in [types.ts:184](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L184)* + +
+ +> # Interface: HeartbeatEventPayload + +## Hierarchy + +* **HeartbeatEventPayload** + +## Index + +### Properties + +* [result](#result) +* [subscription](#subscription) + +## Properties + +### result + +• **result**: *string* + +*Defined in [types.ts:71](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L71)* + +___ + +### subscription + +• **subscription**: *string* + +*Defined in [types.ts:70](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L70)* + +
+ +> # Interface: LatestBlock + +## Hierarchy + +* **LatestBlock** + +## Index + +### Properties + +* [hash](#hash) +* [number](#number) + +## Properties + +### hash + +• **hash**: *string* + +*Defined in [types.ts:180](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L180)* + +___ + +### number + +• **number**: *number* + +*Defined in [types.ts:179](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L179)* + +
+ +> # Interface: OrderEvent + +## Hierarchy + +* **OrderEvent** + +## Index + +### Properties + +* [fillableTakerAssetAmount](#fillabletakerassetamount) +* [kind](#kind) +* [orderHash](#orderhash) +* [signedOrder](#signedorder) +* [txHashes](#txhashes) + +## Properties + +### fillableTakerAssetAmount + +• **fillableTakerAssetAmount**: *`BigNumber`* + +*Defined in [types.ts:86](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L86)* + +___ + +### kind + +• **kind**: *[OrderEventKind](#enumeration-ordereventkind)* + +*Defined in [types.ts:85](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L85)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [types.ts:83](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L83)* + +___ + +### signedOrder + +• **signedOrder**: *`SignedOrder`* + +*Defined in [types.ts:84](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L84)* + +___ + +### txHashes + +• **txHashes**: *string[]* + +*Defined in [types.ts:87](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L87)* + +
+ +> # Interface: OrderEventPayload + +## Hierarchy + +* **OrderEventPayload** + +## Index + +### Properties + +* [result](#result) +* [subscription](#subscription) + +## Properties + +### result + +• **result**: *[RawOrderEvent](#interface-raworderevent)[]* + +*Defined in [types.ts:66](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L66)* + +___ + +### subscription + +• **subscription**: *string* + +*Defined in [types.ts:65](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L65)* + +
+ +> # Interface: OrderInfo + +## Hierarchy + +* **OrderInfo** + +## Index + +### Properties + +* [fillableTakerAssetAmount](#fillabletakerassetamount) +* [orderHash](#orderhash) +* [signedOrder](#signedorder) + +## Properties + +### fillableTakerAssetAmount + +• **fillableTakerAssetAmount**: *`BigNumber`* + +*Defined in [types.ts:113](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L113)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [types.ts:111](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L111)* + +___ + +### signedOrder + +• **signedOrder**: *`SignedOrder`* + +*Defined in [types.ts:112](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L112)* + +
+ +> # Interface: RawAcceptedOrderInfo + +## Hierarchy + +* **RawAcceptedOrderInfo** + +## Index + +### Properties + +* [fillableTakerAssetAmount](#fillabletakerassetamount) +* [isNew](#isnew) +* [orderHash](#orderhash) +* [signedOrder](#signedorder) + +## Properties + +### fillableTakerAssetAmount + +• **fillableTakerAssetAmount**: *string* + +*Defined in [types.ts:93](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L93)* + +___ + +### isNew + +• **isNew**: *boolean* + +*Defined in [types.ts:94](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L94)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [types.ts:91](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L91)* + +___ + +### signedOrder + +• **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* + +*Defined in [types.ts:92](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L92)* + +
+ +> # Interface: RawOrderEvent + +## Hierarchy + +* **RawOrderEvent** + +## Index + +### Properties + +* [fillableTakerAssetAmount](#fillabletakerassetamount) +* [kind](#kind) +* [orderHash](#orderhash) +* [signedOrder](#signedorder) +* [txHashes](#txhashes) + +## Properties + +### fillableTakerAssetAmount + +• **fillableTakerAssetAmount**: *string* + +*Defined in [types.ts:78](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L78)* + +___ + +### kind + +• **kind**: *[OrderEventKind](#enumeration-ordereventkind)* + +*Defined in [types.ts:77](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L77)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [types.ts:75](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L75)* + +___ + +### signedOrder + +• **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* + +*Defined in [types.ts:76](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L76)* + +___ + +### txHashes + +• **txHashes**: *string[]* + +*Defined in [types.ts:79](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L79)* + +
+ +> # Interface: RawOrderInfo + +## Hierarchy + +* **RawOrderInfo** + +## Index + +### Properties + +* [fillableTakerAssetAmount](#fillabletakerassetamount) +* [orderHash](#orderhash) +* [signedOrder](#signedorder) + +## Properties + +### fillableTakerAssetAmount + +• **fillableTakerAssetAmount**: *string* + +*Defined in [types.ts:107](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L107)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [types.ts:105](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L105)* + +___ + +### signedOrder + +• **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* + +*Defined in [types.ts:106](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L106)* + +
+ +> # Interface: RawRejectedOrderInfo + +## Hierarchy + +* **RawRejectedOrderInfo** + +## Index + +### Properties + +* [kind](#kind) +* [orderHash](#orderhash) +* [signedOrder](#signedorder) +* [status](#status) + +## Properties + +### kind + +• **kind**: *[RejectedKind](#enumeration-rejectedkind)* + +*Defined in [types.ts:147](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L147)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [types.ts:145](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L145)* + +___ + +### signedOrder + +• **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* + +*Defined in [types.ts:146](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L146)* + +___ + +### status + +• **status**: *[RejectedStatus](#interface-rejectedstatus)* + +*Defined in [types.ts:148](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L148)* + +
+ +> # Interface: RawValidationResults + +## Hierarchy + +* **RawValidationResults** + +## Index + +### Properties + +* [accepted](#accepted) +* [rejected](#rejected) + +## Properties + +### accepted + +• **accepted**: *[RawAcceptedOrderInfo](#interface-rawacceptedorderinfo)[]* + +*Defined in [types.ts:159](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L159)* + +___ + +### rejected + +• **rejected**: *[RawRejectedOrderInfo](#interface-rawrejectedorderinfo)[]* + +*Defined in [types.ts:160](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L160)* + +
+ +> # Interface: RejectedOrderInfo + +## Hierarchy + +* **RejectedOrderInfo** + +## Index + +### Properties + +* [kind](#kind) +* [orderHash](#orderhash) +* [signedOrder](#signedorder) +* [status](#status) + +## Properties + +### kind + +• **kind**: *[RejectedKind](#enumeration-rejectedkind)* + +*Defined in [types.ts:154](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L154)* + +___ + +### orderHash + +• **orderHash**: *string* + +*Defined in [types.ts:152](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L152)* + +___ + +### signedOrder + +• **signedOrder**: *`SignedOrder`* + +*Defined in [types.ts:153](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L153)* + +___ + +### status + +• **status**: *[RejectedStatus](#interface-rejectedstatus)* + +*Defined in [types.ts:155](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L155)* + +
+ +> # Interface: RejectedStatus + +## Hierarchy + +* **RejectedStatus** + +## Index + +### Properties + +* [code](#code) +* [message](#message) + +## Properties + +### code + +• **code**: *[RejectedCode](#enumeration-rejectedcode)* + +*Defined in [types.ts:140](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L140)* + +___ + +### message + +• **message**: *string* + +*Defined in [types.ts:141](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L141)* + +
+ +> # Interface: StringifiedSignedOrder + +## Hierarchy + +* **StringifiedSignedOrder** + +## Index + +### Properties + +* [exchangeAddress](#exchangeaddress) +* [expirationTimeSeconds](#expirationtimeseconds) +* [feeRecipientAddress](#feerecipientaddress) +* [makerAddress](#makeraddress) +* [makerAssetAmount](#makerassetamount) +* [makerAssetData](#makerassetdata) +* [makerFee](#makerfee) +* [salt](#salt) +* [senderAddress](#senderaddress) +* [signature](#signature) +* [takerAddress](#takeraddress) +* [takerAssetAmount](#takerassetamount) +* [takerAssetData](#takerassetdata) +* [takerFee](#takerfee) + +## Properties + +### exchangeAddress + +• **exchangeAddress**: *string* + +*Defined in [types.ts:47](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L47)* + +___ + +### expirationTimeSeconds + +• **expirationTimeSeconds**: *string* + +*Defined in [types.ts:49](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L49)* + +___ + +### feeRecipientAddress + +• **feeRecipientAddress**: *string* + +*Defined in [types.ts:48](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L48)* + +___ + +### makerAddress + +• **makerAddress**: *string* + +*Defined in [types.ts:38](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L38)* + +___ + +### makerAssetAmount + +• **makerAssetAmount**: *string* + +*Defined in [types.ts:42](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L42)* + +___ + +### makerAssetData + +• **makerAssetData**: *string* + +*Defined in [types.ts:44](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L44)* + +___ + +### makerFee + +• **makerFee**: *string* + +*Defined in [types.ts:40](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L40)* + +___ + +### salt + +• **salt**: *string* + +*Defined in [types.ts:46](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L46)* + +___ + +### senderAddress + +• **senderAddress**: *string* + +*Defined in [types.ts:37](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L37)* + +___ + +### signature + +• **signature**: *string* + +*Defined in [types.ts:50](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L50)* + +___ + +### takerAddress + +• **takerAddress**: *string* + +*Defined in [types.ts:39](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L39)* + +___ + +### takerAssetAmount + +• **takerAssetAmount**: *string* + +*Defined in [types.ts:43](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L43)* + +___ + +### takerAssetData + +• **takerAssetData**: *string* + +*Defined in [types.ts:45](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L45)* + +___ + +### takerFee + +• **takerFee**: *string* + +*Defined in [types.ts:41](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L41)* + +
+ +> # Interface: ValidationResults + +## Hierarchy + +* **ValidationResults** + +## Index + +### Properties + +* [accepted](#accepted) +* [rejected](#rejected) + +## Properties + +### accepted + +• **accepted**: *[AcceptedOrderInfo](#interface-acceptedorderinfo)[]* + +*Defined in [types.ts:164](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L164)* + +___ + +### rejected + +• **rejected**: *[RejectedOrderInfo](#interface-rejectedorderinfo)[]* + +*Defined in [types.ts:165](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L165)* + +
+ +> # Interface: WSMessage + +## Hierarchy + +* **WSMessage** + +## Index + +### Properties + +* [type](#type) +* [utf8Data](#utf8data) + +## Properties + +### type + +• **type**: *string* + +*Defined in [types.ts:174](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L174)* + +___ + +### utf8Data + +• **utf8Data**: *string* + +*Defined in [types.ts:175](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L175)* + +
+ +> # Interface: WSOpts + +timeout: timeout in milliseconds to enforce on every WS request that expects a response +headers: Request headers (e.g., authorization) +protocol: requestOptions should be either null or an object specifying additional configuration options to be +passed to http.request or https.request. This can be used to pass a custom agent to enable WebSocketClient usage +from behind an HTTP or HTTPS proxy server using koichik/node-tunnel or similar. +clientConfig: The client configs documented here: https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketClient.md +reconnectAfter: time in milliseconds after which to attempt to reconnect to WS server after an error occurred (default: 5000) + +## Hierarchy + +* **WSOpts** + +## Index + +### Properties + +* [clientConfig](#optional-clientconfig) +* [headers](#optional-headers) +* [protocol](#optional-protocol) +* [reconnectAfter](#optional-reconnectafter) +* [timeout](#optional-timeout) + +## Properties + +### `Optional` clientConfig + +• **clientConfig**? : *[ClientConfig](#interface-clientconfig)* + +*Defined in [types.ts:32](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L32)* + +___ + +### `Optional` headers + +• **headers**? : *undefined | `__type`* + +*Defined in [types.ts:30](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L30)* + +___ + +### `Optional` protocol + +• **protocol**? : *undefined | string* + +*Defined in [types.ts:31](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L31)* + +___ + +### `Optional` reconnectAfter + +• **reconnectAfter**? : *undefined | number* + +*Defined in [types.ts:33](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L33)* + +___ + +### `Optional` timeout + +• **timeout**? : *undefined | number* + +*Defined in [types.ts:29](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L29)* + +
+ +* [Globals](globals.md) +* [External Modules]() + * [index](modules/_index_.md) + * [types](modules/_types_.md) + * [types.OrderEventKind](#class-ordereventkind) + * [types.RejectedCode](#class-rejectedcode) + * [types.RejectedKind](#class-rejectedkind) + * [types.AcceptedOrderInfo](#class-acceptedorderinfo) + * [types.ClientConfig](#class-clientconfig) + * [types.GetOrdersResponse](#class-getordersresponse) + * [types.GetStatsResponse](#class-getstatsresponse) + * [types.HeartbeatEventPayload](#class-heartbeateventpayload) + * [types.LatestBlock](#class-latestblock) + * [types.OrderEvent](#class-orderevent) + * [types.OrderEventPayload](#class-ordereventpayload) + * [types.OrderInfo](#class-orderinfo) + * [types.RawAcceptedOrderInfo](#class-rawacceptedorderinfo) + * [types.RawOrderEvent](#class-raworderevent) + * [types.RawOrderInfo](#class-raworderinfo) + * [types.RawRejectedOrderInfo](#class-rawrejectedorderinfo) + * [types.RawValidationResults](#class-rawvalidationresults) + * [types.RejectedOrderInfo](#class-rejectedorderinfo) + * [types.RejectedStatus](#class-rejectedstatus) + * [types.StringifiedSignedOrder](#class-stringifiedsignedorder) + * [types.ValidationResults](#class-validationresults) + * [types.WSMessage](#class-wsmessage) + * [types.WSOpts](#class-wsopts) + * [ws_client](modules/_ws_client_.md) + * [ws_client.WSClient](#class-wsclient) +* [Classes]() + * [ws_client.WSClient](#class-wsclient) +* [Enums]() + * [types.OrderEventKind](#class-ordereventkind) + * [types.RejectedCode](#class-rejectedcode) + * [types.RejectedKind](#class-rejectedkind) +* [Interfaces]() + * [types.AcceptedOrderInfo](#class-acceptedorderinfo) + * [types.ClientConfig](#class-clientconfig) + * [types.GetOrdersResponse](#class-getordersresponse) + * [types.GetStatsResponse](#class-getstatsresponse) + * [types.HeartbeatEventPayload](#class-heartbeateventpayload) + * [types.LatestBlock](#class-latestblock) + * [types.OrderEvent](#class-orderevent) + * [types.OrderEventPayload](#class-ordereventpayload) + * [types.OrderInfo](#class-orderinfo) + * [types.RawAcceptedOrderInfo](#class-rawacceptedorderinfo) + * [types.RawOrderEvent](#class-raworderevent) + * [types.RawOrderInfo](#class-raworderinfo) + * [types.RawRejectedOrderInfo](#class-rawrejectedorderinfo) + * [types.RawValidationResults](#class-rawvalidationresults) + * [types.RejectedOrderInfo](#class-rejectedorderinfo) + * [types.RejectedStatus](#class-rejectedstatus) + * [types.StringifiedSignedOrder](#class-stringifiedsignedorder) + * [types.ValidationResults](#class-validationresults) + * [types.WSMessage](#class-wsmessage) + * [types.WSOpts](#class-wsopts) + +
+ diff --git a/docs/json_rpc_clients/typescript/classes/_ws_client_.wsclient.md b/docs/json_rpc_clients/typescript/classes/_ws_client_.wsclient.md deleted file mode 100644 index 90ef25cbf..000000000 --- a/docs/json_rpc_clients/typescript/classes/_ws_client_.wsclient.md +++ /dev/null @@ -1,186 +0,0 @@ -> # Class: WSClient - -This class includes all the functionality related to interacting with a Mesh JSON RPC -websocket endpoint. - -## Hierarchy - -* **WSClient** - -## Index - -### Constructors - -* [constructor](_ws_client_.wsclient.md#constructor) - -### Methods - -* [addOrdersAsync](_ws_client_.wsclient.md#addordersasync) -* [destroy](_ws_client_.wsclient.md#destroy) -* [getOrdersAsync](_ws_client_.wsclient.md#getordersasync) -* [onClose](_ws_client_.wsclient.md#onclose) -* [onReconnected](_ws_client_.wsclient.md#onreconnected) -* [subscribeToOrdersAsync](_ws_client_.wsclient.md#subscribetoordersasync) -* [unsubscribeAsync](_ws_client_.wsclient.md#unsubscribeasync) - -## Constructors - -### constructor - -\+ **new WSClient**(`url`: string, `wsOpts?`: [WSOpts](../interfaces/_types_.wsopts.md)): *[WSClient](_ws_client_.wsclient.md)* - -*Defined in [ws_client.ts:55](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/ws_client.ts#L55)* - -Instantiates a new WSClient instance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`url` | string | WS server endpoint | -`wsOpts?` | [WSOpts](../interfaces/_types_.wsopts.md) | WebSocket options | - -**Returns:** *[WSClient](_ws_client_.wsclient.md)* - -An instance of WSClient - -## Methods - -### addOrdersAsync - -▸ **addOrdersAsync**(`signedOrders`: `SignedOrder`[]): *`Promise`* - -*Defined in [ws_client.ts:80](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/ws_client.ts#L80)* - -Adds an array of 0x signed orders to the Mesh node. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrders` | `SignedOrder`[] | signedOrders to add | - -**Returns:** *`Promise`* - -validation results - -___ - -### destroy - -▸ **destroy**(): *void* - -*Defined in [ws_client.ts:193](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/ws_client.ts#L193)* - -destroy unsubscribes all active subscriptions, closes the websocket connection -and stops the internal heartbeat connection liveness check. - -**Returns:** *void* - -___ - -### getOrdersAsync - -▸ **getOrdersAsync**(`perPage`: number): *`Promise`* - -*Defined in [ws_client.ts:105](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/ws_client.ts#L105)* - -Get all 0x signed orders currently stored in the Mesh node - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`perPage` | number | 200 | number of signedOrders to fetch per paginated request | - -**Returns:** *`Promise`* - -all orders, their hash and their fillableTakerAssetAmount - -___ - -### onClose - -▸ **onClose**(`cb`: function): *void* - -*Defined in [ws_client.ts:175](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/ws_client.ts#L175)* - -Get notified when the underlying WS connection closes normally. If it closes with an -error, WSClient automatically attempts to re-connect without emitting a `close` event. - -**Parameters:** - -▪ **cb**: *function* - -callback to call when WS connection closes - -▸ (): *void* - -**Returns:** *void* - -___ - -### onReconnected - -▸ **onReconnected**(`cb`: function): *void* - -*Defined in [ws_client.ts:184](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/ws_client.ts#L184)* - -Get notified when a connection to the underlying WS connection is re-established - -**Parameters:** - -▪ **cb**: *function* - -callback to call with the error when it occurs - -▸ (): *void* - -**Returns:** *void* - -___ - -### subscribeToOrdersAsync - -▸ **subscribeToOrdersAsync**(`cb`: function): *`Promise`* - -*Defined in [ws_client.ts:136](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/ws_client.ts#L136)* - -Subscribe to the 'orders' topic and receive order events from Mesh. This method returns a -subscriptionId that can be used to `unsubscribe()` from this subscription. - -**Parameters:** - -▪ **cb**: *function* - -callback function where you'd like to get notified about order events - -▸ (`orderEvents`: [OrderEvent](../interfaces/_types_.orderevent.md)[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderEvents` | [OrderEvent](../interfaces/_types_.orderevent.md)[] | - -**Returns:** *`Promise`* - -subscriptionId - -___ - -### unsubscribeAsync - -▸ **unsubscribeAsync**(`subscriptionId`: string): *`Promise`* - -*Defined in [ws_client.ts:165](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/ws_client.ts#L165)* - -Unsubscribe from a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionId` | string | identifier of the subscription to cancel | - -**Returns:** *`Promise`* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/enums/_types_.ordereventkind.md b/docs/json_rpc_clients/typescript/enums/_types_.ordereventkind.md deleted file mode 100644 index 8e717585f..000000000 --- a/docs/json_rpc_clients/typescript/enums/_types_.ordereventkind.md +++ /dev/null @@ -1,78 +0,0 @@ -> # Enumeration: OrderEventKind - -## Index - -### Enumeration members - -* [Added](_types_.ordereventkind.md#added) -* [Cancelled](_types_.ordereventkind.md#cancelled) -* [Expired](_types_.ordereventkind.md#expired) -* [FillabilityIncreased](_types_.ordereventkind.md#fillabilityincreased) -* [Filled](_types_.ordereventkind.md#filled) -* [FullyFilled](_types_.ordereventkind.md#fullyfilled) -* [Invalid](_types_.ordereventkind.md#invalid) -* [Unfunded](_types_.ordereventkind.md#unfunded) - -## Enumeration members - -### Added - -• **Added**: = "ADDED" - -*Defined in [types.ts:55](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L55)* - -___ - -### Cancelled - -• **Cancelled**: = "CANCELLED" - -*Defined in [types.ts:58](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L58)* - -___ - -### Expired - -• **Expired**: = "EXPIRED" - -*Defined in [types.ts:59](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L59)* - -___ - -### FillabilityIncreased - -• **FillabilityIncreased**: = "FILLABILITY_INCREASED" - -*Defined in [types.ts:61](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L61)* - -___ - -### Filled - -• **Filled**: = "FILLED" - -*Defined in [types.ts:56](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L56)* - -___ - -### FullyFilled - -• **FullyFilled**: = "FULLY_FILLED" - -*Defined in [types.ts:57](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L57)* - -___ - -### Invalid - -• **Invalid**: = "INVALID" - -*Defined in [types.ts:54](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L54)* - -___ - -### Unfunded - -• **Unfunded**: = "UNFUNDED" - -*Defined in [types.ts:60](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L60)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/enums/_types_.rejectedcode.md b/docs/json_rpc_clients/typescript/enums/_types_.rejectedcode.md deleted file mode 100644 index b8fd7aba7..000000000 --- a/docs/json_rpc_clients/typescript/enums/_types_.rejectedcode.md +++ /dev/null @@ -1,132 +0,0 @@ -> # Enumeration: RejectedCode - -## Index - -### Enumeration members - -* [InternalError](_types_.rejectedcode.md#internalerror) -* [MaxOrderSizeExceeded](_types_.rejectedcode.md#maxordersizeexceeded) -* [NetworkRequestFailed](_types_.rejectedcode.md#networkrequestfailed) -* [OrderAlreadyStored](_types_.rejectedcode.md#orderalreadystored) -* [OrderCancelled](_types_.rejectedcode.md#ordercancelled) -* [OrderExpired](_types_.rejectedcode.md#orderexpired) -* [OrderForIncorrectNetwork](_types_.rejectedcode.md#orderforincorrectnetwork) -* [OrderFullyFilled](_types_.rejectedcode.md#orderfullyfilled) -* [OrderHasInvalidMakerAssetAmount](_types_.rejectedcode.md#orderhasinvalidmakerassetamount) -* [OrderHasInvalidMakerAssetData](_types_.rejectedcode.md#orderhasinvalidmakerassetdata) -* [OrderHasInvalidSignature](_types_.rejectedcode.md#orderhasinvalidsignature) -* [OrderHasInvalidTakerAssetAmount](_types_.rejectedcode.md#orderhasinvalidtakerassetamount) -* [OrderHasInvalidTakerAssetData](_types_.rejectedcode.md#orderhasinvalidtakerassetdata) -* [OrderUnfunded](_types_.rejectedcode.md#orderunfunded) - -## Enumeration members - -### InternalError - -• **InternalError**: = "InternalError" - -*Defined in [types.ts:109](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L109)* - -___ - -### MaxOrderSizeExceeded - -• **MaxOrderSizeExceeded**: = "MaxOrderSizeExceeded" - -*Defined in [types.ts:110](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L110)* - -___ - -### NetworkRequestFailed - -• **NetworkRequestFailed**: = "NetworkRequestFailed" - -*Defined in [types.ts:113](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L113)* - -___ - -### OrderAlreadyStored - -• **OrderAlreadyStored**: = "OrderAlreadyStored" - -*Defined in [types.ts:111](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L111)* - -___ - -### OrderCancelled - -• **OrderCancelled**: = "OrderCancelled" - -*Defined in [types.ts:118](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L118)* - -___ - -### OrderExpired - -• **OrderExpired**: = "OrderExpired" - -*Defined in [types.ts:116](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L116)* - -___ - -### OrderForIncorrectNetwork - -• **OrderForIncorrectNetwork**: = "OrderForIncorrectNetwork" - -*Defined in [types.ts:112](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L112)* - -___ - -### OrderFullyFilled - -• **OrderFullyFilled**: = "OrderFullyFilled" - -*Defined in [types.ts:117](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L117)* - -___ - -### OrderHasInvalidMakerAssetAmount - -• **OrderHasInvalidMakerAssetAmount**: = "OrderHasInvalidMakerAssetAmount" - -*Defined in [types.ts:114](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L114)* - -___ - -### OrderHasInvalidMakerAssetData - -• **OrderHasInvalidMakerAssetData**: = "OrderHasInvalidMakerAssetData" - -*Defined in [types.ts:120](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L120)* - -___ - -### OrderHasInvalidSignature - -• **OrderHasInvalidSignature**: = "OrderHasInvalidSignature" - -*Defined in [types.ts:122](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L122)* - -___ - -### OrderHasInvalidTakerAssetAmount - -• **OrderHasInvalidTakerAssetAmount**: = "OrderHasInvalidTakerAssetAmount" - -*Defined in [types.ts:115](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L115)* - -___ - -### OrderHasInvalidTakerAssetData - -• **OrderHasInvalidTakerAssetData**: = "OrderHasInvalidTakerAssetData" - -*Defined in [types.ts:121](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L121)* - -___ - -### OrderUnfunded - -• **OrderUnfunded**: = "OrderUnfunded" - -*Defined in [types.ts:119](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L119)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/enums/_types_.rejectedkind.md b/docs/json_rpc_clients/typescript/enums/_types_.rejectedkind.md deleted file mode 100644 index 04a406c28..000000000 --- a/docs/json_rpc_clients/typescript/enums/_types_.rejectedkind.md +++ /dev/null @@ -1,33 +0,0 @@ -> # Enumeration: RejectedKind - -## Index - -### Enumeration members - -* [MeshError](_types_.rejectedkind.md#mesherror) -* [MeshValidation](_types_.rejectedkind.md#meshvalidation) -* [ZeroexValidation](_types_.rejectedkind.md#zeroexvalidation) - -## Enumeration members - -### MeshError - -• **MeshError**: = "MESH_ERROR" - -*Defined in [types.ts:104](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L104)* - -___ - -### MeshValidation - -• **MeshValidation**: = "MESH_VALIDATION" - -*Defined in [types.ts:105](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L105)* - -___ - -### ZeroexValidation - -• **ZeroexValidation**: = "ZEROEX_VALIDATION" - -*Defined in [types.ts:103](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L103)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/globals.md b/docs/json_rpc_clients/typescript/globals.md deleted file mode 100644 index 8619217c3..000000000 --- a/docs/json_rpc_clients/typescript/globals.md +++ /dev/null @@ -1,9 +0,0 @@ -> # @0x/mesh-rpc-client - -## Index - -### External modules - -* ["index"](modules/_index_.md) -* ["types"](modules/_types_.md) -* ["ws_client"](modules/_ws_client_.md) \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.acceptedorderinfo.md b/docs/json_rpc_clients/typescript/interfaces/_types_.acceptedorderinfo.md deleted file mode 100644 index 1a72054de..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.acceptedorderinfo.md +++ /dev/null @@ -1,37 +0,0 @@ -> # Interface: AcceptedOrderInfo - -## Hierarchy - -* **AcceptedOrderInfo** - -## Index - -### Properties - -* [fillableTakerAssetAmount](_types_.acceptedorderinfo.md#fillabletakerassetamount) -* [orderHash](_types_.acceptedorderinfo.md#orderhash) -* [signedOrder](_types_.acceptedorderinfo.md#signedorder) - -## Properties - -### fillableTakerAssetAmount - -• **fillableTakerAssetAmount**: *`BigNumber`* - -*Defined in [types.ts:99](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L99)* - -___ - -### orderHash - -• **orderHash**: *string* - -*Defined in [types.ts:97](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L97)* - -___ - -### signedOrder - -• **signedOrder**: *`SignedOrder`* - -*Defined in [types.ts:98](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L98)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.clientconfig.md b/docs/json_rpc_clients/typescript/interfaces/_types_.clientconfig.md deleted file mode 100644 index f1af94b43..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.clientconfig.md +++ /dev/null @@ -1,85 +0,0 @@ -> # Interface: ClientConfig - -WebSocketClient configs -Source: https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketClient.md#client-config-options - -## Hierarchy - -* **ClientConfig** - -## Index - -### Properties - -* [assembleFragments](_types_.clientconfig.md#optional-assemblefragments) -* [closeTimeout](_types_.clientconfig.md#optional-closetimeout) -* [fragmentOutgoingMessages](_types_.clientconfig.md#optional-fragmentoutgoingmessages) -* [fragmentationThreshold](_types_.clientconfig.md#optional-fragmentationthreshold) -* [maxReceivedFrameSize](_types_.clientconfig.md#optional-maxreceivedframesize) -* [maxReceivedMessageSize](_types_.clientconfig.md#optional-maxreceivedmessagesize) -* [tlsOptions](_types_.clientconfig.md#optional-tlsoptions) -* [webSocketVersion](_types_.clientconfig.md#optional-websocketversion) - -## Properties - -### `Optional` assembleFragments - -• **assembleFragments**? : *undefined | false | true* - -*Defined in [types.ts:14](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L14)* - -___ - -### `Optional` closeTimeout - -• **closeTimeout**? : *undefined | number* - -*Defined in [types.ts:15](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L15)* - -___ - -### `Optional` fragmentOutgoingMessages - -• **fragmentOutgoingMessages**? : *undefined | false | true* - -*Defined in [types.ts:12](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L12)* - -___ - -### `Optional` fragmentationThreshold - -• **fragmentationThreshold**? : *undefined | number* - -*Defined in [types.ts:13](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L13)* - -___ - -### `Optional` maxReceivedFrameSize - -• **maxReceivedFrameSize**? : *undefined | number* - -*Defined in [types.ts:10](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L10)* - -___ - -### `Optional` maxReceivedMessageSize - -• **maxReceivedMessageSize**? : *undefined | number* - -*Defined in [types.ts:11](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L11)* - -___ - -### `Optional` tlsOptions - -• **tlsOptions**? : *any* - -*Defined in [types.ts:16](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L16)* - -___ - -### `Optional` webSocketVersion - -• **webSocketVersion**? : *undefined | number* - -*Defined in [types.ts:9](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L9)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.getordersresponse.md b/docs/json_rpc_clients/typescript/interfaces/_types_.getordersresponse.md deleted file mode 100644 index 037c09c1e..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.getordersresponse.md +++ /dev/null @@ -1,28 +0,0 @@ -> # Interface: GetOrdersResponse - -## Hierarchy - -* **GetOrdersResponse** - -## Index - -### Properties - -* [ordersInfos](_types_.getordersresponse.md#ordersinfos) -* [snapshotID](_types_.getordersresponse.md#snapshotid) - -## Properties - -### ordersInfos - -• **ordersInfos**: *[RawAcceptedOrderInfo](_types_.rawacceptedorderinfo.md)[]* - -*Defined in [types.ts:156](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L156)* - -___ - -### snapshotID - -• **snapshotID**: *string* - -*Defined in [types.ts:155](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L155)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.heartbeateventpayload.md b/docs/json_rpc_clients/typescript/interfaces/_types_.heartbeateventpayload.md deleted file mode 100644 index d8db9159c..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.heartbeateventpayload.md +++ /dev/null @@ -1,28 +0,0 @@ -> # Interface: HeartbeatEventPayload - -## Hierarchy - -* **HeartbeatEventPayload** - -## Index - -### Properties - -* [result](_types_.heartbeateventpayload.md#result) -* [subscription](_types_.heartbeateventpayload.md#subscription) - -## Properties - -### result - -• **result**: *string* - -*Defined in [types.ts:71](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L71)* - -___ - -### subscription - -• **subscription**: *string* - -*Defined in [types.ts:70](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L70)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.orderevent.md b/docs/json_rpc_clients/typescript/interfaces/_types_.orderevent.md deleted file mode 100644 index 96a9e26d1..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.orderevent.md +++ /dev/null @@ -1,55 +0,0 @@ -> # Interface: OrderEvent - -## Hierarchy - -* **OrderEvent** - -## Index - -### Properties - -* [fillableTakerAssetAmount](_types_.orderevent.md#fillabletakerassetamount) -* [kind](_types_.orderevent.md#kind) -* [orderHash](_types_.orderevent.md#orderhash) -* [signedOrder](_types_.orderevent.md#signedorder) -* [txHashes](_types_.orderevent.md#txhashes) - -## Properties - -### fillableTakerAssetAmount - -• **fillableTakerAssetAmount**: *`BigNumber`* - -*Defined in [types.ts:86](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L86)* - -___ - -### kind - -• **kind**: *[OrderEventKind](../enums/_types_.ordereventkind.md)* - -*Defined in [types.ts:85](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L85)* - -___ - -### orderHash - -• **orderHash**: *string* - -*Defined in [types.ts:83](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L83)* - -___ - -### signedOrder - -• **signedOrder**: *`SignedOrder`* - -*Defined in [types.ts:84](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L84)* - -___ - -### txHashes - -• **txHashes**: *string[]* - -*Defined in [types.ts:87](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L87)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.ordereventpayload.md b/docs/json_rpc_clients/typescript/interfaces/_types_.ordereventpayload.md deleted file mode 100644 index 5dd0e8252..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.ordereventpayload.md +++ /dev/null @@ -1,28 +0,0 @@ -> # Interface: OrderEventPayload - -## Hierarchy - -* **OrderEventPayload** - -## Index - -### Properties - -* [result](_types_.ordereventpayload.md#result) -* [subscription](_types_.ordereventpayload.md#subscription) - -## Properties - -### result - -• **result**: *[RawOrderEvent](_types_.raworderevent.md)[]* - -*Defined in [types.ts:66](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L66)* - -___ - -### subscription - -• **subscription**: *string* - -*Defined in [types.ts:65](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L65)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.rawacceptedorderinfo.md b/docs/json_rpc_clients/typescript/interfaces/_types_.rawacceptedorderinfo.md deleted file mode 100644 index 28b3cdf73..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.rawacceptedorderinfo.md +++ /dev/null @@ -1,37 +0,0 @@ -> # Interface: RawAcceptedOrderInfo - -## Hierarchy - -* **RawAcceptedOrderInfo** - -## Index - -### Properties - -* [fillableTakerAssetAmount](_types_.rawacceptedorderinfo.md#fillabletakerassetamount) -* [orderHash](_types_.rawacceptedorderinfo.md#orderhash) -* [signedOrder](_types_.rawacceptedorderinfo.md#signedorder) - -## Properties - -### fillableTakerAssetAmount - -• **fillableTakerAssetAmount**: *string* - -*Defined in [types.ts:93](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L93)* - -___ - -### orderHash - -• **orderHash**: *string* - -*Defined in [types.ts:91](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L91)* - -___ - -### signedOrder - -• **signedOrder**: *[StringifiedSignedOrder](_types_.stringifiedsignedorder.md)* - -*Defined in [types.ts:92](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L92)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.raworderevent.md b/docs/json_rpc_clients/typescript/interfaces/_types_.raworderevent.md deleted file mode 100644 index 16dd62d19..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.raworderevent.md +++ /dev/null @@ -1,55 +0,0 @@ -> # Interface: RawOrderEvent - -## Hierarchy - -* **RawOrderEvent** - -## Index - -### Properties - -* [fillableTakerAssetAmount](_types_.raworderevent.md#fillabletakerassetamount) -* [kind](_types_.raworderevent.md#kind) -* [orderHash](_types_.raworderevent.md#orderhash) -* [signedOrder](_types_.raworderevent.md#signedorder) -* [txHashes](_types_.raworderevent.md#txhashes) - -## Properties - -### fillableTakerAssetAmount - -• **fillableTakerAssetAmount**: *string* - -*Defined in [types.ts:78](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L78)* - -___ - -### kind - -• **kind**: *[OrderEventKind](../enums/_types_.ordereventkind.md)* - -*Defined in [types.ts:77](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L77)* - -___ - -### orderHash - -• **orderHash**: *string* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L75)* - -___ - -### signedOrder - -• **signedOrder**: *[StringifiedSignedOrder](_types_.stringifiedsignedorder.md)* - -*Defined in [types.ts:76](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L76)* - -___ - -### txHashes - -• **txHashes**: *string[]* - -*Defined in [types.ts:79](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L79)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.rawrejectedorderinfo.md b/docs/json_rpc_clients/typescript/interfaces/_types_.rawrejectedorderinfo.md deleted file mode 100644 index f0fc0d386..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.rawrejectedorderinfo.md +++ /dev/null @@ -1,46 +0,0 @@ -> # Interface: RawRejectedOrderInfo - -## Hierarchy - -* **RawRejectedOrderInfo** - -## Index - -### Properties - -* [kind](_types_.rawrejectedorderinfo.md#kind) -* [orderHash](_types_.rawrejectedorderinfo.md#orderhash) -* [signedOrder](_types_.rawrejectedorderinfo.md#signedorder) -* [status](_types_.rawrejectedorderinfo.md#status) - -## Properties - -### kind - -• **kind**: *[RejectedKind](../enums/_types_.rejectedkind.md)* - -*Defined in [types.ts:133](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L133)* - -___ - -### orderHash - -• **orderHash**: *string* - -*Defined in [types.ts:131](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L131)* - -___ - -### signedOrder - -• **signedOrder**: *[StringifiedSignedOrder](_types_.stringifiedsignedorder.md)* - -*Defined in [types.ts:132](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L132)* - -___ - -### status - -• **status**: *[RejectedStatus](_types_.rejectedstatus.md)* - -*Defined in [types.ts:134](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L134)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.rawvalidationresults.md b/docs/json_rpc_clients/typescript/interfaces/_types_.rawvalidationresults.md deleted file mode 100644 index 9a305405c..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.rawvalidationresults.md +++ /dev/null @@ -1,28 +0,0 @@ -> # Interface: RawValidationResults - -## Hierarchy - -* **RawValidationResults** - -## Index - -### Properties - -* [accepted](_types_.rawvalidationresults.md#accepted) -* [rejected](_types_.rawvalidationresults.md#rejected) - -## Properties - -### accepted - -• **accepted**: *[RawAcceptedOrderInfo](_types_.rawacceptedorderinfo.md)[]* - -*Defined in [types.ts:145](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L145)* - -___ - -### rejected - -• **rejected**: *[RawRejectedOrderInfo](_types_.rawrejectedorderinfo.md)[]* - -*Defined in [types.ts:146](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L146)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.rejectedorderinfo.md b/docs/json_rpc_clients/typescript/interfaces/_types_.rejectedorderinfo.md deleted file mode 100644 index 2cf103e36..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.rejectedorderinfo.md +++ /dev/null @@ -1,46 +0,0 @@ -> # Interface: RejectedOrderInfo - -## Hierarchy - -* **RejectedOrderInfo** - -## Index - -### Properties - -* [kind](_types_.rejectedorderinfo.md#kind) -* [orderHash](_types_.rejectedorderinfo.md#orderhash) -* [signedOrder](_types_.rejectedorderinfo.md#signedorder) -* [status](_types_.rejectedorderinfo.md#status) - -## Properties - -### kind - -• **kind**: *[RejectedKind](../enums/_types_.rejectedkind.md)* - -*Defined in [types.ts:140](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L140)* - -___ - -### orderHash - -• **orderHash**: *string* - -*Defined in [types.ts:138](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L138)* - -___ - -### signedOrder - -• **signedOrder**: *`SignedOrder`* - -*Defined in [types.ts:139](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L139)* - -___ - -### status - -• **status**: *[RejectedStatus](_types_.rejectedstatus.md)* - -*Defined in [types.ts:141](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L141)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.rejectedstatus.md b/docs/json_rpc_clients/typescript/interfaces/_types_.rejectedstatus.md deleted file mode 100644 index 1eb8178d9..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.rejectedstatus.md +++ /dev/null @@ -1,28 +0,0 @@ -> # Interface: RejectedStatus - -## Hierarchy - -* **RejectedStatus** - -## Index - -### Properties - -* [code](_types_.rejectedstatus.md#code) -* [message](_types_.rejectedstatus.md#message) - -## Properties - -### code - -• **code**: *[RejectedCode](../enums/_types_.rejectedcode.md)* - -*Defined in [types.ts:126](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L126)* - -___ - -### message - -• **message**: *string* - -*Defined in [types.ts:127](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L127)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.stringifiedsignedorder.md b/docs/json_rpc_clients/typescript/interfaces/_types_.stringifiedsignedorder.md deleted file mode 100644 index 51f8672b4..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.stringifiedsignedorder.md +++ /dev/null @@ -1,136 +0,0 @@ -> # Interface: StringifiedSignedOrder - -## Hierarchy - -* **StringifiedSignedOrder** - -## Index - -### Properties - -* [exchangeAddress](_types_.stringifiedsignedorder.md#exchangeaddress) -* [expirationTimeSeconds](_types_.stringifiedsignedorder.md#expirationtimeseconds) -* [feeRecipientAddress](_types_.stringifiedsignedorder.md#feerecipientaddress) -* [makerAddress](_types_.stringifiedsignedorder.md#makeraddress) -* [makerAssetAmount](_types_.stringifiedsignedorder.md#makerassetamount) -* [makerAssetData](_types_.stringifiedsignedorder.md#makerassetdata) -* [makerFee](_types_.stringifiedsignedorder.md#makerfee) -* [salt](_types_.stringifiedsignedorder.md#salt) -* [senderAddress](_types_.stringifiedsignedorder.md#senderaddress) -* [signature](_types_.stringifiedsignedorder.md#signature) -* [takerAddress](_types_.stringifiedsignedorder.md#takeraddress) -* [takerAssetAmount](_types_.stringifiedsignedorder.md#takerassetamount) -* [takerAssetData](_types_.stringifiedsignedorder.md#takerassetdata) -* [takerFee](_types_.stringifiedsignedorder.md#takerfee) - -## Properties - -### exchangeAddress - -• **exchangeAddress**: *string* - -*Defined in [types.ts:47](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L47)* - -___ - -### expirationTimeSeconds - -• **expirationTimeSeconds**: *string* - -*Defined in [types.ts:49](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L49)* - -___ - -### feeRecipientAddress - -• **feeRecipientAddress**: *string* - -*Defined in [types.ts:48](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L48)* - -___ - -### makerAddress - -• **makerAddress**: *string* - -*Defined in [types.ts:38](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L38)* - -___ - -### makerAssetAmount - -• **makerAssetAmount**: *string* - -*Defined in [types.ts:42](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L42)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Defined in [types.ts:44](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L44)* - -___ - -### makerFee - -• **makerFee**: *string* - -*Defined in [types.ts:40](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L40)* - -___ - -### salt - -• **salt**: *string* - -*Defined in [types.ts:46](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L46)* - -___ - -### senderAddress - -• **senderAddress**: *string* - -*Defined in [types.ts:37](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L37)* - -___ - -### signature - -• **signature**: *string* - -*Defined in [types.ts:50](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L50)* - -___ - -### takerAddress - -• **takerAddress**: *string* - -*Defined in [types.ts:39](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L39)* - -___ - -### takerAssetAmount - -• **takerAssetAmount**: *string* - -*Defined in [types.ts:43](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L43)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Defined in [types.ts:45](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L45)* - -___ - -### takerFee - -• **takerFee**: *string* - -*Defined in [types.ts:41](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L41)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.validationresults.md b/docs/json_rpc_clients/typescript/interfaces/_types_.validationresults.md deleted file mode 100644 index 8cb823637..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.validationresults.md +++ /dev/null @@ -1,28 +0,0 @@ -> # Interface: ValidationResults - -## Hierarchy - -* **ValidationResults** - -## Index - -### Properties - -* [accepted](_types_.validationresults.md#accepted) -* [rejected](_types_.validationresults.md#rejected) - -## Properties - -### accepted - -• **accepted**: *[AcceptedOrderInfo](_types_.acceptedorderinfo.md)[]* - -*Defined in [types.ts:150](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L150)* - -___ - -### rejected - -• **rejected**: *[RejectedOrderInfo](_types_.rejectedorderinfo.md)[]* - -*Defined in [types.ts:151](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L151)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.wsmessage.md b/docs/json_rpc_clients/typescript/interfaces/_types_.wsmessage.md deleted file mode 100644 index 294626f28..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.wsmessage.md +++ /dev/null @@ -1,28 +0,0 @@ -> # Interface: WSMessage - -## Hierarchy - -* **WSMessage** - -## Index - -### Properties - -* [type](_types_.wsmessage.md#type) -* [utf8Data](_types_.wsmessage.md#utf8data) - -## Properties - -### type - -• **type**: *string* - -*Defined in [types.ts:160](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L160)* - -___ - -### utf8Data - -• **utf8Data**: *string* - -*Defined in [types.ts:161](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L161)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/interfaces/_types_.wsopts.md b/docs/json_rpc_clients/typescript/interfaces/_types_.wsopts.md deleted file mode 100644 index 2c7760e57..000000000 --- a/docs/json_rpc_clients/typescript/interfaces/_types_.wsopts.md +++ /dev/null @@ -1,63 +0,0 @@ -> # Interface: WSOpts - -timeout: timeout in milliseconds to enforce on every WS request that expects a response -headers: Request headers (e.g., authorization) -protocol: requestOptions should be either null or an object specifying additional configuration options to be -passed to http.request or https.request. This can be used to pass a custom agent to enable WebSocketClient usage -from behind an HTTP or HTTPS proxy server using koichik/node-tunnel or similar. -clientConfig: The client configs documented here: https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketClient.md -reconnectAfter: time in milliseconds after which to attempt to reconnect to WS server after an error occurred (default: 5000) - -## Hierarchy - -* **WSOpts** - -## Index - -### Properties - -* [clientConfig](_types_.wsopts.md#optional-clientconfig) -* [headers](_types_.wsopts.md#optional-headers) -* [protocol](_types_.wsopts.md#optional-protocol) -* [reconnectAfter](_types_.wsopts.md#optional-reconnectafter) -* [timeout](_types_.wsopts.md#optional-timeout) - -## Properties - -### `Optional` clientConfig - -• **clientConfig**? : *[ClientConfig](_types_.clientconfig.md)* - -*Defined in [types.ts:32](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L32)* - -___ - -### `Optional` headers - -• **headers**? : *undefined | `__type`* - -*Defined in [types.ts:30](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L30)* - -___ - -### `Optional` protocol - -• **protocol**? : *undefined | string* - -*Defined in [types.ts:31](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L31)* - -___ - -### `Optional` reconnectAfter - -• **reconnectAfter**? : *undefined | number* - -*Defined in [types.ts:33](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L33)* - -___ - -### `Optional` timeout - -• **timeout**? : *undefined | number* - -*Defined in [types.ts:29](https://github.com/0xProject/0x-mesh/blob/7038c73/rpc/clients/typescript/src/types.ts#L29)* \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/modules/_index_.md b/docs/json_rpc_clients/typescript/modules/_index_.md deleted file mode 100644 index 5ac526bdc..000000000 --- a/docs/json_rpc_clients/typescript/modules/_index_.md +++ /dev/null @@ -1 +0,0 @@ -> # External module: "index" \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/modules/_types_.md b/docs/json_rpc_clients/typescript/modules/_types_.md deleted file mode 100644 index df415c5be..000000000 --- a/docs/json_rpc_clients/typescript/modules/_types_.md +++ /dev/null @@ -1,28 +0,0 @@ -> # External module: "types" - -## Index - -### Enumerations - -* [OrderEventKind](../enums/_types_.ordereventkind.md) -* [RejectedCode](../enums/_types_.rejectedcode.md) -* [RejectedKind](../enums/_types_.rejectedkind.md) - -### Interfaces - -* [AcceptedOrderInfo](../interfaces/_types_.acceptedorderinfo.md) -* [ClientConfig](../interfaces/_types_.clientconfig.md) -* [GetOrdersResponse](../interfaces/_types_.getordersresponse.md) -* [HeartbeatEventPayload](../interfaces/_types_.heartbeateventpayload.md) -* [OrderEvent](../interfaces/_types_.orderevent.md) -* [OrderEventPayload](../interfaces/_types_.ordereventpayload.md) -* [RawAcceptedOrderInfo](../interfaces/_types_.rawacceptedorderinfo.md) -* [RawOrderEvent](../interfaces/_types_.raworderevent.md) -* [RawRejectedOrderInfo](../interfaces/_types_.rawrejectedorderinfo.md) -* [RawValidationResults](../interfaces/_types_.rawvalidationresults.md) -* [RejectedOrderInfo](../interfaces/_types_.rejectedorderinfo.md) -* [RejectedStatus](../interfaces/_types_.rejectedstatus.md) -* [StringifiedSignedOrder](../interfaces/_types_.stringifiedsignedorder.md) -* [ValidationResults](../interfaces/_types_.validationresults.md) -* [WSMessage](../interfaces/_types_.wsmessage.md) -* [WSOpts](../interfaces/_types_.wsopts.md) \ No newline at end of file diff --git a/docs/json_rpc_clients/typescript/modules/_ws_client_.md b/docs/json_rpc_clients/typescript/modules/_ws_client_.md deleted file mode 100644 index 9ed6f9872..000000000 --- a/docs/json_rpc_clients/typescript/modules/_ws_client_.md +++ /dev/null @@ -1,7 +0,0 @@ -> # External module: "ws_client" - -## Index - -### Classes - -* [WSClient](../classes/_ws_client_.wsclient.md) \ No newline at end of file From a17c27bbfdb52f703958dbb0c217ad343f64dbb6 Mon Sep 17 00:00:00 2001 From: fabioberger Date: Fri, 2 Aug 2019 23:38:52 +0200 Subject: [PATCH 03/12] Fix linter --- rpc/clients/typescript/scripts/post_process_docs.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/rpc/clients/typescript/scripts/post_process_docs.ts b/rpc/clients/typescript/scripts/post_process_docs.ts index 39861aecd..3d93fcfa7 100644 --- a/rpc/clients/typescript/scripts/post_process_docs.ts +++ b/rpc/clients/typescript/scripts/post_process_docs.ts @@ -14,15 +14,15 @@ function main(): void { throw err; } (paths as any).sort((firstEl: string, secondEl: string) => { - const firstIsFile = firstEl.includes('.md'); - const secondIsFile = secondEl.includes('.md'); - if ((firstIsFile && secondIsFile) || (!firstIsFile && !secondIsFile)) { + const isFirstAFile = firstEl.includes('.md'); + const isSecondAFile = secondEl.includes('.md'); + if ((isFirstAFile && isSecondAFile) || (!isFirstAFile && !isSecondAFile)) { return 0; } - if (firstIsFile) { + if (isFirstAFile) { return -1; } - if (secondIsFile) { + if (isSecondAFile) { return 1; } return undefined; From 924b3be1a5481b13b9fb64f72faad837fba50c25 Mon Sep 17 00:00:00 2001 From: fabioberger Date: Sat, 3 Aug 2019 15:26:04 +0200 Subject: [PATCH 04/12] Move typedoc call into script --- rpc/clients/typescript/package.json | 13 +- .../typescript/scripts/post_process_docs.ts | 63 ------ rpc/clients/typescript/scripts/ts_doc_gen.ts | 93 ++++++++ rpc/clients/typescript/src/globals.d.ts | 2 + rpc/clients/typescript/yarn.lock | 198 +++++++++++++++++- 5 files changed, 295 insertions(+), 74 deletions(-) delete mode 100644 rpc/clients/typescript/scripts/post_process_docs.ts create mode 100644 rpc/clients/typescript/scripts/ts_doc_gen.ts diff --git a/rpc/clients/typescript/package.json b/rpc/clients/typescript/package.json index c4436ba5c..388ed3f84 100644 --- a/rpc/clients/typescript/package.json +++ b/rpc/clients/typescript/package.json @@ -22,11 +22,7 @@ "fix": "tslint --fix --format stylish --project .", "test": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --exit", "script:processDocs": "node ./lib/scripts/post_process_docs.js", - "docs:generate": "typedoc --theme markdown --platform gitbook --excludePrivate --excludeProtected --excludeExternals --excludeNotExported --target ES5 --module commonjs --out ${npm_package_config_docspath} ./src", - "docs:md": "rm -rf ${npm_package_config_docspath}; yarn docs:generate; yarn script:processDocs;" - }, - "config": { - "docspath": "../../../docs/json_rpc_clients/typescript/" + "docs:md": "yarn script:processDocs;" }, "repository": { "type": "git", @@ -47,14 +43,17 @@ "@0x/utils": "^4.4.2", "@0x/web3-providers-fork": "0.0.7", "uuid": "^3.3.2", - "websocket": "^1.0.29" + "websocket": "^1.0.29", + "yargs": "^10.0.3" }, "devDependencies": { "@0x/tslint-config": "^3.0.1", "@types/glob": "^7.1.1", "@types/mocha": "^2.2.42", + "@types/rimraf": "^2.0.2", "@types/uuid": "^3.4.3", "@types/websocket": "^0.0.40", + "@types/yargs": "^11.0.0", "chai": "^4.0.1", "chai-as-promised": "^7.1.0", "chai-bignumber": "^3.0.0", @@ -62,6 +61,8 @@ "glob": "^7.1.4", "make-promises-safe": "^1.1.0", "mocha": "^4.1.0", + "promisify-child-process": "^3.1.1", + "rimraf": "^2.6.3", "shx": "^0.2.2", "tslint": "5.11.0", "typedoc": "^0.15.0", diff --git a/rpc/clients/typescript/scripts/post_process_docs.ts b/rpc/clients/typescript/scripts/post_process_docs.ts deleted file mode 100644 index 3d93fcfa7..000000000 --- a/rpc/clients/typescript/scripts/post_process_docs.ts +++ /dev/null @@ -1,63 +0,0 @@ -import * as fs from 'fs'; -import * as glob from 'glob'; - -function main(): void { - // Concat all TS Client MD files together - const tsClientDocsRoot = `${process.cwd()}/../../../docs/json_rpc_clients/typescript`; - const allMdPath = `${tsClientDocsRoot}/all.md`; - - if (fs.existsSync(allMdPath)) { - fs.unlinkSync(allMdPath); - } - glob(`${tsClientDocsRoot}/**/*`, (err: Error | null, paths: string[]) => { - if (err !== null) { - throw err; - } - (paths as any).sort((firstEl: string, secondEl: string) => { - const isFirstAFile = firstEl.includes('.md'); - const isSecondAFile = secondEl.includes('.md'); - if ((isFirstAFile && isSecondAFile) || (!isFirstAFile && !isSecondAFile)) { - return 0; - } - if (isFirstAFile) { - return -1; - } - if (isSecondAFile) { - return 1; - } - return undefined; - }); - for (const path of paths) { - if (path.includes('.md', 1)) { - if (!path.includes('README.md', 1) && !path.includes('all.md', 1) && !path.includes('/modules/', 1) && !path.includes('globals.md', 1)) { - // Read file content and concat to new file - const content = fs.readFileSync(path); - fs.appendFileSync(allMdPath, content); - fs.appendFileSync(allMdPath, '\n'); - fs.appendFileSync(allMdPath, '\n'); - fs.appendFileSync(allMdPath, '
'); - fs.appendFileSync(allMdPath, '\n'); - fs.appendFileSync(allMdPath, '\n'); - } - if (!path.includes('README.md', 1)) { - fs.unlinkSync(path); - } - } else { - fs.rmdirSync(path); - } - } - - // Find/replace relative links with hash links - const docsBuff = fs.readFileSync(allMdPath); - let docs = docsBuff.toString(); - docs = docs.replace(/\]\(((?!.*(github.com)).*)(#.*\))/g, ']($3'); - docs = docs.replace(/\]\(..\/interfaces\/.*?\.(.*?)\.md\)/g, '](#interface-$1)'); - docs = docs.replace(/\]\(..\/classes\/.*?\.(.*?)\.md\)/g, '](#class-$1)'); - docs = docs.replace(/\]\(..\/enums\/.*?\.(.*?)\.md\)/g, '](#enumeration-$1)'); - docs = docs.replace(/\]\(_types_\.(.*?)\.md\)/g, '](#interface-$1)'); - docs = docs.replace(/\]\(.*\.(.*?)\.md\)/g, '](#class-$1)'); - fs.writeFileSync(allMdPath, docs); - }); -} - -main(); diff --git a/rpc/clients/typescript/scripts/ts_doc_gen.ts b/rpc/clients/typescript/scripts/ts_doc_gen.ts new file mode 100644 index 000000000..cd4c87e9c --- /dev/null +++ b/rpc/clients/typescript/scripts/ts_doc_gen.ts @@ -0,0 +1,93 @@ +import { logUtils, promisify } from '@0x/utils'; +import * as fs from 'fs'; +import * as glob from 'glob'; +import { exec as execAsync } from 'promisify-child-process'; +import * as rimraf from 'rimraf'; +import * as yargs from 'yargs'; + +const rimrafAsync = promisify(rimraf); + +(async () => { + + const args = yargs + .option('sourceDir', { + alias: ['s', 'src'], + describe: 'Folder where the source TS files are located', + type: 'string', + normalize: true, + demandOption: true, + }) + .option('output', { + alias: ['o', 'out'], + describe: 'Folder where to put the output doc files', + type: 'string', + normalize: true, + demandOption: true, + }) + .example( + "$0 --src 'src' --out 'docs'", + 'Full usage example', + ).argv; + + await rimrafAsync(args.output); + try { + await execAsync(`./node_modules/typedoc/bin/typedoc --theme markdown --platform gitbook --excludePrivate --excludeProtected --excludeExternals --excludeNotExported --target ES5 --module commonjs --hideGenerator --out ${args.output} ${args.sourceDir}`); + } catch (err) { + logUtils.log('typedoc command failed: ', err); + process.exit(1); + } + + // Concat all TS Client MD files together into a single reference doc + const referencePath = `${args.output}/reference.md`; + await rimrafAsync(referencePath); + glob(`${args.output}/**/*`, (err: Error | null, paths: string[]) => { + if (err !== null) { + throw err; + } + (paths as any).sort((firstEl: string, secondEl: string) => { + const isFirstAFile = firstEl.includes('.md'); + const isSecondAFile = secondEl.includes('.md'); + if ((isFirstAFile && isSecondAFile) || (!isFirstAFile && !isSecondAFile)) { + return 0; + } + if (isFirstAFile) { + return -1; + } + if (isSecondAFile) { + return 1; + } + return undefined; + }); + for (const path of paths) { + if (path.includes('.md', 1)) { + if (!path.includes('README.md', 1) && !path.includes('/modules/', 1) && !path.includes('globals.md', 1)) { + // Read file content and concat to new file + const content = fs.readFileSync(path); + fs.appendFileSync(referencePath, content); + fs.appendFileSync(referencePath, '\n'); + fs.appendFileSync(referencePath, '\n'); + fs.appendFileSync(referencePath, '
'); + fs.appendFileSync(referencePath, '\n'); + fs.appendFileSync(referencePath, '\n'); + } + if (!path.includes('README.md', 1)) { + fs.unlinkSync(path); + } + } else { + fs.rmdirSync(path); + } + } + + // Find/replace relative links with hash links + const docsBuff = fs.readFileSync(referencePath); + let docs = docsBuff.toString(); + docs = docs.replace(/\]\(((?!.*(github.com)).*)(#.*\))/g, ']($3'); + docs = docs.replace(/\]\(..\/interfaces\/.*?\.(.*?)\.md\)/g, '](#interface-$1)'); + docs = docs.replace(/\]\(..\/classes\/.*?\.(.*?)\.md\)/g, '](#class-$1)'); + docs = docs.replace(/\]\(..\/enums\/.*?\.(.*?)\.md\)/g, '](#enumeration-$1)'); + docs = docs.replace(/\]\(_types_\.(.*?)\.md\)/g, '](#interface-$1)'); + docs = docs.replace(/\]\(.*\.(.*?)\.md\)/g, '](#class-$1)'); + fs.writeFileSync(referencePath, docs); + logUtils.log('TS doc generation complete!'); + }); +})(); diff --git a/rpc/clients/typescript/src/globals.d.ts b/rpc/clients/typescript/src/globals.d.ts index 783b92913..219ef8f08 100644 --- a/rpc/clients/typescript/src/globals.d.ts +++ b/rpc/clients/typescript/src/globals.d.ts @@ -2,3 +2,5 @@ declare module '*.json' { const value: any; export default value; } + +declare module 'promisify-child-process'; diff --git a/rpc/clients/typescript/yarn.lock b/rpc/clients/typescript/yarn.lock index 70c456aca..8ca4bc794 100644 --- a/rpc/clients/typescript/yarn.lock +++ b/rpc/clients/typescript/yarn.lock @@ -209,7 +209,7 @@ ethers "~4.0.4" lodash "^4.17.11" -"@babel/runtime@^7.3.1": +"@babel/runtime@^7.1.5", "@babel/runtime@^7.3.1": version "7.5.5" resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.5.5.tgz#74fba56d35efbeca444091c7850ccd494fd2f132" integrity sha512-28QvEGyQyNkB0/m2B4FU7IEZGK2NUrcMtT6BZEFALTguLk+AUT6ofsHtPk5QyjAdUkpMJ+/Em+quwz4HOt30AQ== @@ -304,7 +304,7 @@ resolved "https://registry.yarnpkg.com/@types/events/-/events-3.0.0.tgz#2862f3f58a9a7f7c3e78d79f130dd4d71c25c2a7" integrity sha512-EaObqwIvayI5a8dCzhFrjKzVwKLxjoG9T6Ppd5CEo07LRKfQ8Yokw54r5+Wq7FaBQ+yXRvQAYPrHwya1/UFt9g== -"@types/glob@^7.1.1": +"@types/glob@*", "@types/glob@^7.1.1": version "7.1.1" resolved "https://registry.yarnpkg.com/@types/glob/-/glob-7.1.1.tgz#aa59a1c6e3fbc421e07ccd31a944c30eba521575" integrity sha512-1Bh06cbWJUHMC97acuD6UMG29nMt0Aqz1vF3guLfG+kHHJhy3AyohZFFxYk2f7Q1SQIrNwvncxAE0N/9s70F2w== @@ -353,6 +353,14 @@ "@types/prop-types" "*" csstype "^2.2.0" +"@types/rimraf@^2.0.2": + version "2.0.2" + resolved "https://registry.yarnpkg.com/@types/rimraf/-/rimraf-2.0.2.tgz#7f0fc3cf0ff0ad2a99bb723ae1764f30acaf8b6e" + integrity sha512-Hm/bnWq0TCy7jmjeN5bKYij9vw5GrDFWME4IuxV08278NtU/VdGbzsBohcCUJ7+QMqmUq5hpRKB39HeQWJjztQ== + dependencies: + "@types/glob" "*" + "@types/node" "*" + "@types/uuid@^3.4.3": version "3.4.5" resolved "https://registry.yarnpkg.com/@types/uuid/-/uuid-3.4.5.tgz#d4dc10785b497a1474eae0ba7f0cb09c0ddfd6eb" @@ -375,6 +383,11 @@ "@types/events" "*" "@types/node" "*" +"@types/yargs@^11.0.0": + version "11.1.2" + resolved "https://registry.yarnpkg.com/@types/yargs/-/yargs-11.1.2.tgz#fd4b676846fe731a5de5c6d2e5ef6a377262fc30" + integrity sha512-zG61PAp2OcoIBjRV44wftJj6AJgzJrOc32LCYOBqk9bdgcdzK5DCJHV9QZJ60+Fu+fOn79g8Ks3Gixm4CfkZ+w== + abbrev@1: version "1.1.1" resolved "https://registry.yarnpkg.com/abbrev/-/abbrev-1.1.1.tgz#f8f2c887ad10bf67f634f005b6987fed3179aac8" @@ -1618,6 +1631,11 @@ camelcase@^3.0.0: resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-3.0.0.tgz#32fc4b9fcdaf845fcdf7e73bb97cac2261f0ab0a" integrity sha1-MvxLn82vhF/N9+c7uXysImHwqwo= +camelcase@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-4.1.0.tgz#d545635be1e33c542649c69173e5de6acfae34dd" + integrity sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0= + caniuse-lite@^1.0.30000844: version "1.0.30000984" resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30000984.tgz#dc96c3c469e9bcfc6ad5bdd24c77ec918ea76fe0" @@ -1735,6 +1753,15 @@ cliui@^3.2.0: strip-ansi "^3.0.1" wrap-ansi "^2.0.0" +cliui@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-4.1.0.tgz#348422dbe82d800b3022eef4f6ac10bf2e4d1b49" + integrity sha512-4FG+RSG9DL7uEwRUZXZn3SS34DiDPfzP0VOiEwtUWlE+AR2EIg+hSyvrIgUUfhdgR/UkAeW2QHgeP+hWrXs7jQ== + dependencies: + string-width "^2.1.1" + strip-ansi "^4.0.0" + wrap-ansi "^2.0.0" + clone-buffer@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/clone-buffer/-/clone-buffer-1.0.0.tgz#e3e25b207ac4e701af721e2cb5a16792cac3dc58" @@ -1959,6 +1986,15 @@ cross-fetch@^2.1.0, cross-fetch@^2.1.1: node-fetch "2.1.2" whatwg-fetch "2.0.4" +cross-spawn@^5.0.1: + version "5.1.0" + resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-5.1.0.tgz#e8bd0efee58fcff6f8f94510a0a554bbfa235449" + integrity sha1-6L0O/uWPz/b4+UUQoKVUu/ojVEk= + dependencies: + lru-cache "^4.0.1" + shebang-command "^1.2.0" + which "^1.2.9" + crypto-browserify@3.12.0: version "3.12.0" resolved "https://registry.yarnpkg.com/crypto-browserify/-/crypto-browserify-3.12.0.tgz#396cf9f3137f03e4b8e532c58f698254e00f80ec" @@ -2860,6 +2896,19 @@ evp_bytestokey@^1.0.0, evp_bytestokey@^1.0.3: md5.js "^1.3.4" safe-buffer "^5.1.1" +execa@^0.7.0: + version "0.7.0" + resolved "https://registry.yarnpkg.com/execa/-/execa-0.7.0.tgz#944becd34cc41ee32a63a9faf27ad5a65fc59777" + integrity sha1-lEvs00zEHuMqY6n68nrVpl/Fl3c= + dependencies: + cross-spawn "^5.0.1" + get-stream "^3.0.0" + is-stream "^1.1.0" + npm-run-path "^2.0.0" + p-finally "^1.0.0" + signal-exit "^3.0.0" + strip-eof "^1.0.0" + expand-brackets@^2.1.4: version "2.1.4" resolved "https://registry.yarnpkg.com/expand-brackets/-/expand-brackets-2.1.4.tgz#b77735e315ce30f6b6eff0f83b04151a22449622" @@ -3057,6 +3106,13 @@ find-up@^1.0.0: path-exists "^2.0.0" pinkie-promise "^2.0.0" +find-up@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-2.1.0.tgz#45d1b7e506c717ddd482775a2b77920a3c0c57a7" + integrity sha1-RdG35QbHF93UgndaK3eSCjwMV6c= + dependencies: + locate-path "^2.0.0" + findup-sync@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/findup-sync/-/findup-sync-2.0.0.tgz#9326b1488c22d1a6088650a86901b2d9a90a2cbc" @@ -4459,6 +4515,14 @@ load-json-file@^1.0.0: pinkie-promise "^2.0.0" strip-bom "^2.0.0" +locate-path@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-2.0.0.tgz#2b568b265eec944c6d9c0de9c3dbbbca0354cd8e" + integrity sha1-K1aLJl7slExtnA3pw9u7ygNUzY4= + dependencies: + p-locate "^2.0.0" + path-exists "^3.0.0" + lodash.values@^4.3.0: version "4.3.0" resolved "https://registry.yarnpkg.com/lodash.values/-/lodash.values-4.3.0.tgz#a3a6c2b0ebecc5c2cba1c17e6e620fe81b53d347" @@ -4503,6 +4567,14 @@ lru-cache@^3.2.0: dependencies: pseudomap "^1.0.1" +lru-cache@^4.0.1: + version "4.1.5" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-4.1.5.tgz#8bbe50ea85bed59bc9e33dcab8235ee9bcf443cd" + integrity sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g== + dependencies: + pseudomap "^1.0.2" + yallist "^2.1.2" + lru-cache@^5.1.1: version "5.1.1" resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-5.1.1.tgz#1da27e6710271947695daf6848e847f01d84b920" @@ -4585,6 +4657,13 @@ media-typer@0.3.0: resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748" integrity sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g= +mem@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/mem/-/mem-1.1.0.tgz#5edd52b485ca1d900fe64895505399a0dfa45f76" + integrity sha1-Xt1StIXKHZAP5kiVUFOZoN+kX3Y= + dependencies: + mimic-fn "^1.0.0" + memdown@^1.0.0: version "1.4.1" resolved "https://registry.yarnpkg.com/memdown/-/memdown-1.4.1.tgz#b4e4e192174664ffbae41361aa500f3119efe215" @@ -4677,6 +4756,11 @@ mime@1.6.0: resolved "https://registry.yarnpkg.com/mime/-/mime-1.6.0.tgz#32cd9e5c64553bd58d19a568af452acff04981b1" integrity sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg== +mimic-fn@^1.0.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-1.2.0.tgz#820c86a39334640e99516928bd03fca88057d022" + integrity sha512-jf84uxzwiuiIVKiOLpfYk7N46TSy8ubTonmneY9vrpHNAnp0QBt2BxWV9dO3/j+BoVAb+a5G6YDPW3M5HOdMWQ== + mimic-response@^1.0.0: version "1.0.1" resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-1.0.1.tgz#4923538878eef42063cb8a3e3b0798781487ab1b" @@ -4974,6 +5058,13 @@ npm-packlist@^1.1.6: ignore-walk "^3.0.1" npm-bundled "^1.0.1" +npm-run-path@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-2.0.2.tgz#35a9232dfa35d7067b4cb2ddf2357b1871536c5f" + integrity sha1-NakjLfo11wZ7TLLd8jV7GHFTbF8= + dependencies: + path-key "^2.0.0" + npmlog@^4.0.1, npmlog@^4.0.2: version "4.1.2" resolved "https://registry.yarnpkg.com/npmlog/-/npmlog-4.1.2.tgz#08a7f2a8bf734604779a9efa4ad5cc717abb954b" @@ -5129,6 +5220,15 @@ os-locale@^1.4.0: dependencies: lcid "^1.0.0" +os-locale@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/os-locale/-/os-locale-2.1.0.tgz#42bc2900a6b5b8bd17376c8e882b65afccf24bf2" + integrity sha512-3sslG3zJbEYcaC4YVAvDorjGxc7tv6KVATnLPZONiljsUncvihe9BQoVCEs0RZ1kmf4Hk9OBqlZfJZWI4GanKA== + dependencies: + execa "^0.7.0" + lcid "^1.0.0" + mem "^1.1.0" + os-tmpdir@^1.0.0, os-tmpdir@^1.0.1: version "1.0.2" resolved "https://registry.yarnpkg.com/os-tmpdir/-/os-tmpdir-1.0.2.tgz#bbe67406c79aa85c5cfec766fe5734555dfa1274" @@ -5152,6 +5252,20 @@ p-finally@^1.0.0: resolved "https://registry.yarnpkg.com/p-finally/-/p-finally-1.0.0.tgz#3fbcfb15b899a44123b34b6dcc18b724336a2cae" integrity sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4= +p-limit@^1.1.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-1.3.0.tgz#b86bd5f0c25690911c7590fcbfc2010d54b3ccb8" + integrity sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q== + dependencies: + p-try "^1.0.0" + +p-locate@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-2.0.0.tgz#20a0103b222a70c8fd39cc2e580680f3dde5ec43" + integrity sha1-IKAQOyIqcMj9OcwuWAaA893l7EM= + dependencies: + p-limit "^1.1.0" + p-timeout@^1.1.1: version "1.2.1" resolved "https://registry.yarnpkg.com/p-timeout/-/p-timeout-1.2.1.tgz#5eb3b353b7fce99f101a1038880bb054ebbea386" @@ -5159,6 +5273,11 @@ p-timeout@^1.1.1: dependencies: p-finally "^1.0.0" +p-try@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/p-try/-/p-try-1.0.0.tgz#cbc79cdbaf8fd4228e13f621f2b1a237c1b207b3" + integrity sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M= + parse-asn1@^5.0.0: version "5.1.4" resolved "https://registry.yarnpkg.com/parse-asn1/-/parse-asn1-5.1.4.tgz#37f6628f823fbdeb2273b4d540434a22f3ef1fcc" @@ -5227,11 +5346,21 @@ path-exists@^2.0.0: dependencies: pinkie-promise "^2.0.0" +path-exists@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-3.0.0.tgz#ce0ebeaa5f78cb18925ea7d810d7b59b010fd515" + integrity sha1-zg6+ql94yxiSXqfYENe1mwEP1RU= + path-is-absolute@^1.0.0, path-is-absolute@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" integrity sha1-F0uSaHNVNP+8es5r9TpanhtcX18= +path-key@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/path-key/-/path-key-2.0.1.tgz#411cadb574c5a140d3a4b1910d40d80cc9f40b40" + integrity sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A= + path-parse@^1.0.6: version "1.0.6" resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.6.tgz#d62dbb5679405d72c4737ec58600e9ddcf06d24c" @@ -5386,6 +5515,13 @@ promise-to-callback@^1.0.0: is-fn "^1.0.0" set-immediate-shim "^1.0.1" +promisify-child-process@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/promisify-child-process/-/promisify-child-process-3.1.1.tgz#3a029c1d97bdb8bbcc8862c765b91f1cee0f2691" + integrity sha512-683UHZEP4Bm75BvBujEe87AdE9lxnoWpcU5pEw4FG9HCSwwZC9pF7HUj3QmlDAvhyvulkWHLZs1lVRBNTvkbXQ== + dependencies: + "@babel/runtime" "^7.1.5" + proxy-addr@~2.0.5: version "2.0.5" resolved "https://registry.yarnpkg.com/proxy-addr/-/proxy-addr-2.0.5.tgz#34cbd64a2d81f4b1fd21e76f9f06c8a45299ee34" @@ -5399,7 +5535,7 @@ prr@~1.0.1: resolved "https://registry.yarnpkg.com/prr/-/prr-1.0.1.tgz#d3fc114ba06995a45ec6893f484ceb1d78f5f476" integrity sha1-0/wRS6BplaRexok/SEzrHXj19HY= -pseudomap@^1.0.1: +pseudomap@^1.0.1, pseudomap@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/pseudomap/-/pseudomap-1.0.2.tgz#f052a28da70e618917ef0a8ac34c1ae5a68286b3" integrity sha1-8FKijacOYYkX7wqKw0wa5aaChrM= @@ -6073,6 +6209,18 @@ sha3@^1.2.2: dependencies: nan "2.13.2" +shebang-command@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-1.2.0.tgz#44aac65b695b03398968c39f363fee5deafdf1ea" + integrity sha1-RKrGW2lbAzmJaMOfNj/uXer98eo= + dependencies: + shebang-regex "^1.0.0" + +shebang-regex@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-1.0.0.tgz#da42f49740c0b42db2ca9728571cb190c98efea3" + integrity sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM= + shelljs@^0.7.3: version "0.7.8" resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.7.8.tgz#decbcf874b0d1e5fb72e14b164a9683048e9acb3" @@ -6311,7 +6459,7 @@ string-width@^1.0.1, string-width@^1.0.2: is-fullwidth-code-point "^1.0.0" strip-ansi "^3.0.0" -"string-width@^1.0.2 || 2": +"string-width@^1.0.2 || 2", string-width@^2.0.0, string-width@^2.1.1: version "2.1.1" resolved "https://registry.yarnpkg.com/string-width/-/string-width-2.1.1.tgz#ab93f27a8dc13d28cac815c462143a6d9012ae9e" integrity sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw== @@ -6368,6 +6516,11 @@ strip-dirs@^2.0.0: dependencies: is-natural-number "^4.0.1" +strip-eof@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/strip-eof/-/strip-eof-1.0.0.tgz#bb43ff5598a6eb05d89b59fcd129c983313606bf" + integrity sha1-u0P/VZim6wXYm1n80SnJgzE2Br8= + strip-hex-prefix@1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/strip-hex-prefix/-/strip-hex-prefix-1.0.0.tgz#0c5f155fef1151373377de9dbb588da05500e36f" @@ -7469,12 +7622,17 @@ which-module@^1.0.0: resolved "https://registry.yarnpkg.com/which-module/-/which-module-1.0.0.tgz#bba63ca861948994ff307736089e3b96026c2a4f" integrity sha1-u6Y8qGGUiZT/MHc2CJ47lgJsKk8= +which-module@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/which-module/-/which-module-2.0.0.tgz#d9ef07dce77b9902b8a3a8fa4b31c3e3f7e6e87a" + integrity sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho= + which-pm-runs@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/which-pm-runs/-/which-pm-runs-1.0.0.tgz#670b3afbc552e0b55df6b7780ca74615f23ad1cb" integrity sha1-Zws6+8VS4LVd9rd4DKdGFfI60cs= -which@^1.2.14: +which@^1.2.14, which@^1.2.9: version "1.3.1" resolved "https://registry.yarnpkg.com/which/-/which-1.3.1.tgz#a45043d54f5805316da8d62f9f50918d3da70b0a" integrity sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ== @@ -7586,6 +7744,11 @@ yaeti@^0.0.6: resolved "https://registry.yarnpkg.com/yaeti/-/yaeti-0.0.6.tgz#f26f484d72684cf42bedfb76970aa1608fbf9577" integrity sha1-8m9ITXJoTPQr7ft2lwqhYI+/lXc= +yallist@^2.1.2: + version "2.1.2" + resolved "https://registry.yarnpkg.com/yallist/-/yallist-2.1.2.tgz#1c11f9218f076089a47dd512f93c6699a6a81d52" + integrity sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI= + yallist@^3.0.0, yallist@^3.0.2, yallist@^3.0.3: version "3.0.3" resolved "https://registry.yarnpkg.com/yallist/-/yallist-3.0.3.tgz#b4b049e314be545e3ce802236d6cd22cd91c3de9" @@ -7598,6 +7761,31 @@ yargs-parser@^5.0.0: dependencies: camelcase "^3.0.0" +yargs-parser@^8.1.0: + version "8.1.0" + resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-8.1.0.tgz#f1376a33b6629a5d063782944da732631e966950" + integrity sha512-yP+6QqN8BmrgW2ggLtTbdrOyBNSI7zBa4IykmiV5R1wl1JWNxQvWhMfMdmzIYtKU7oP3OOInY/tl2ov3BDjnJQ== + dependencies: + camelcase "^4.1.0" + +yargs@^10.0.3: + version "10.1.2" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-10.1.2.tgz#454d074c2b16a51a43e2fb7807e4f9de69ccb5c5" + integrity sha512-ivSoxqBGYOqQVruxD35+EyCFDYNEFL/Uo6FcOnz+9xZdZzK0Zzw4r4KhbrME1Oo2gOggwJod2MnsdamSG7H9ig== + dependencies: + cliui "^4.0.0" + decamelize "^1.1.1" + find-up "^2.1.0" + get-caller-file "^1.0.1" + os-locale "^2.0.0" + require-directory "^2.1.1" + require-main-filename "^1.0.1" + set-blocking "^2.0.0" + string-width "^2.0.0" + which-module "^2.0.0" + y18n "^3.2.1" + yargs-parser "^8.1.0" + yargs@^7.1.0: version "7.1.0" resolved "https://registry.yarnpkg.com/yargs/-/yargs-7.1.0.tgz#6ba318eb16961727f5d284f8ea003e8d6154d0c8" From e57317fb9c1cf3ddab14a97c933e7d13f7acfec4 Mon Sep 17 00:00:00 2001 From: fabioberger Date: Sat, 3 Aug 2019 15:26:30 +0200 Subject: [PATCH 05/12] rename `all.md` to `reference.md` --- docs/SUMMARY.md | 2 +- .../typescript/{all.md => reference.md} | 234 +++++++++--------- 2 files changed, 118 insertions(+), 118 deletions(-) rename docs/json_rpc_clients/typescript/{all.md => reference.md} (81%) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 81f81a199..f98b3938b 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -14,7 +14,7 @@ * [Golang client](https://godoc.org/github.com/0xProject/0x-mesh/rpc) * [TypeScript client](json_rpc_clients/typescript/README.md) - * [Doc reference](json_rpc_clients/typescript/all.md) + * [Doc reference](json_rpc_clients/typescript/reference.md) ## Contributing diff --git a/docs/json_rpc_clients/typescript/all.md b/docs/json_rpc_clients/typescript/reference.md similarity index 81% rename from docs/json_rpc_clients/typescript/all.md rename to docs/json_rpc_clients/typescript/reference.md index 003a51ac8..d96c0ab68 100644 --- a/docs/json_rpc_clients/typescript/all.md +++ b/docs/json_rpc_clients/typescript/reference.md @@ -30,7 +30,7 @@ websocket endpoint. \+ **new WSClient**(`url`: string, `wsOpts?`: [WSOpts](#class-wsclient)* -*Defined in [ws_client.ts:71](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L71)* +*Defined in [ws_client.ts:71](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L71)* Instantiates a new WSClient instance @@ -51,7 +51,7 @@ An instance of WSClient ▸ **addOrdersAsync**(`signedOrders`: `SignedOrder`[]): *`Promise`* -*Defined in [ws_client.ts:96](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L96)* +*Defined in [ws_client.ts:96](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L96)* Adds an array of 0x signed orders to the Mesh node. @@ -71,7 +71,7 @@ ___ ▸ **destroy**(): *void* -*Defined in [ws_client.ts:213](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L213)* +*Defined in [ws_client.ts:213](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L213)* destroy unsubscribes all active subscriptions, closes the websocket connection and stops the internal heartbeat connection liveness check. @@ -84,7 +84,7 @@ ___ ▸ **getOrdersAsync**(`perPage`: number): *`Promise`* -*Defined in [ws_client.ts:125](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L125)* +*Defined in [ws_client.ts:125](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L125)* Get all 0x signed orders currently stored in the Mesh node @@ -104,7 +104,7 @@ ___ ▸ **getStatsAsync**(): *`Promise`* -*Defined in [ws_client.ts:116](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L116)* +*Defined in [ws_client.ts:116](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L116)* **Returns:** *`Promise`* @@ -114,7 +114,7 @@ ___ ▸ **onClose**(`cb`: function): *void* -*Defined in [ws_client.ts:195](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L195)* +*Defined in [ws_client.ts:195](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L195)* Get notified when the underlying WS connection closes normally. If it closes with an error, WSClient automatically attempts to re-connect without emitting a `close` event. @@ -135,7 +135,7 @@ ___ ▸ **onReconnected**(`cb`: function): *void* -*Defined in [ws_client.ts:204](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L204)* +*Defined in [ws_client.ts:204](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L204)* Get notified when a connection to the underlying WS connection is re-established @@ -155,7 +155,7 @@ ___ ▸ **subscribeToOrdersAsync**(`cb`: function): *`Promise`* -*Defined in [ws_client.ts:156](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L156)* +*Defined in [ws_client.ts:156](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L156)* Subscribe to the 'orders' topic and receive order events from Mesh. This method returns a subscriptionId that can be used to `unsubscribe()` from this subscription. @@ -184,7 +184,7 @@ ___ ▸ **unsubscribeAsync**(`subscriptionId`: string): *`Promise`* -*Defined in [ws_client.ts:185](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/ws_client.ts#L185)* +*Defined in [ws_client.ts:185](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L185)* Unsubscribe from a subscription @@ -219,7 +219,7 @@ Name | Type | Description | • **Added**: = "ADDED" -*Defined in [types.ts:55](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L55)* +*Defined in [types.ts:55](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L55)* ___ @@ -227,7 +227,7 @@ ___ • **Cancelled**: = "CANCELLED" -*Defined in [types.ts:58](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L58)* +*Defined in [types.ts:58](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L58)* ___ @@ -235,7 +235,7 @@ ___ • **Expired**: = "EXPIRED" -*Defined in [types.ts:59](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L59)* +*Defined in [types.ts:59](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L59)* ___ @@ -243,7 +243,7 @@ ___ • **FillabilityIncreased**: = "FILLABILITY_INCREASED" -*Defined in [types.ts:61](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L61)* +*Defined in [types.ts:61](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L61)* ___ @@ -251,7 +251,7 @@ ___ • **Filled**: = "FILLED" -*Defined in [types.ts:56](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L56)* +*Defined in [types.ts:56](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L56)* ___ @@ -259,7 +259,7 @@ ___ • **FullyFilled**: = "FULLY_FILLED" -*Defined in [types.ts:57](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L57)* +*Defined in [types.ts:57](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L57)* ___ @@ -267,7 +267,7 @@ ___ • **Invalid**: = "INVALID" -*Defined in [types.ts:54](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L54)* +*Defined in [types.ts:54](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L54)* ___ @@ -275,7 +275,7 @@ ___ • **Unfunded**: = "UNFUNDED" -*Defined in [types.ts:60](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L60)* +*Defined in [types.ts:60](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L60)*
@@ -306,7 +306,7 @@ ___ • **InternalError**: = "InternalError" -*Defined in [types.ts:123](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L123)* +*Defined in [types.ts:123](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L123)* ___ @@ -314,7 +314,7 @@ ___ • **MaxOrderSizeExceeded**: = "MaxOrderSizeExceeded" -*Defined in [types.ts:124](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L124)* +*Defined in [types.ts:124](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L124)* ___ @@ -322,7 +322,7 @@ ___ • **NetworkRequestFailed**: = "NetworkRequestFailed" -*Defined in [types.ts:127](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L127)* +*Defined in [types.ts:127](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L127)* ___ @@ -330,7 +330,7 @@ ___ • **OrderAlreadyStored**: = "OrderAlreadyStored" -*Defined in [types.ts:125](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L125)* +*Defined in [types.ts:125](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L125)* ___ @@ -338,7 +338,7 @@ ___ • **OrderCancelled**: = "OrderCancelled" -*Defined in [types.ts:132](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L132)* +*Defined in [types.ts:132](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L132)* ___ @@ -346,7 +346,7 @@ ___ • **OrderExpired**: = "OrderExpired" -*Defined in [types.ts:130](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L130)* +*Defined in [types.ts:130](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L130)* ___ @@ -354,7 +354,7 @@ ___ • **OrderForIncorrectNetwork**: = "OrderForIncorrectNetwork" -*Defined in [types.ts:126](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L126)* +*Defined in [types.ts:126](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L126)* ___ @@ -362,7 +362,7 @@ ___ • **OrderFullyFilled**: = "OrderFullyFilled" -*Defined in [types.ts:131](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L131)* +*Defined in [types.ts:131](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L131)* ___ @@ -370,7 +370,7 @@ ___ • **OrderHasInvalidMakerAssetAmount**: = "OrderHasInvalidMakerAssetAmount" -*Defined in [types.ts:128](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L128)* +*Defined in [types.ts:128](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L128)* ___ @@ -378,7 +378,7 @@ ___ • **OrderHasInvalidMakerAssetData**: = "OrderHasInvalidMakerAssetData" -*Defined in [types.ts:134](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L134)* +*Defined in [types.ts:134](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L134)* ___ @@ -386,7 +386,7 @@ ___ • **OrderHasInvalidSignature**: = "OrderHasInvalidSignature" -*Defined in [types.ts:136](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L136)* +*Defined in [types.ts:136](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L136)* ___ @@ -394,7 +394,7 @@ ___ • **OrderHasInvalidTakerAssetAmount**: = "OrderHasInvalidTakerAssetAmount" -*Defined in [types.ts:129](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L129)* +*Defined in [types.ts:129](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L129)* ___ @@ -402,7 +402,7 @@ ___ • **OrderHasInvalidTakerAssetData**: = "OrderHasInvalidTakerAssetData" -*Defined in [types.ts:135](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L135)* +*Defined in [types.ts:135](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L135)* ___ @@ -410,7 +410,7 @@ ___ • **OrderUnfunded**: = "OrderUnfunded" -*Defined in [types.ts:133](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L133)* +*Defined in [types.ts:133](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L133)*
@@ -430,7 +430,7 @@ ___ • **MeshError**: = "MESH_ERROR" -*Defined in [types.ts:118](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L118)* +*Defined in [types.ts:118](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L118)* ___ @@ -438,7 +438,7 @@ ___ • **MeshValidation**: = "MESH_VALIDATION" -*Defined in [types.ts:119](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L119)* +*Defined in [types.ts:119](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L119)* ___ @@ -446,7 +446,7 @@ ___ • **ZeroexValidation**: = "ZEROEX_VALIDATION" -*Defined in [types.ts:117](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L117)* +*Defined in [types.ts:117](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L117)*
@@ -471,7 +471,7 @@ ___ • **fillableTakerAssetAmount**: *`BigNumber`* -*Defined in [types.ts:100](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L100)* +*Defined in [types.ts:100](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L100)* ___ @@ -479,7 +479,7 @@ ___ • **isNew**: *boolean* -*Defined in [types.ts:101](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L101)* +*Defined in [types.ts:101](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L101)* ___ @@ -487,7 +487,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:98](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L98)* +*Defined in [types.ts:98](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L98)* ___ @@ -495,7 +495,7 @@ ___ • **signedOrder**: *`SignedOrder`* -*Defined in [types.ts:99](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L99)* +*Defined in [types.ts:99](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L99)*
@@ -527,7 +527,7 @@ Source: https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocket • **assembleFragments**? : *undefined | false | true* -*Defined in [types.ts:14](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L14)* ___ @@ -535,7 +535,7 @@ ___ • **closeTimeout**? : *undefined | number* -*Defined in [types.ts:15](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L15)* ___ @@ -543,7 +543,7 @@ ___ • **fragmentOutgoingMessages**? : *undefined | false | true* -*Defined in [types.ts:12](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L12)* ___ @@ -551,7 +551,7 @@ ___ • **fragmentationThreshold**? : *undefined | number* -*Defined in [types.ts:13](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L13)* ___ @@ -559,7 +559,7 @@ ___ • **maxReceivedFrameSize**? : *undefined | number* -*Defined in [types.ts:10](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L10)* ___ @@ -567,7 +567,7 @@ ___ • **maxReceivedMessageSize**? : *undefined | number* -*Defined in [types.ts:11](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L11)* ___ @@ -575,7 +575,7 @@ ___ • **tlsOptions**? : *any* -*Defined in [types.ts:16](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L16)* ___ @@ -583,7 +583,7 @@ ___ • **webSocketVersion**? : *undefined | number* -*Defined in [types.ts:9](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L9)*
@@ -606,7 +606,7 @@ ___ • **ordersInfos**: *[RawAcceptedOrderInfo](#interface-rawacceptedorderinfo)[]* -*Defined in [types.ts:170](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L170)* +*Defined in [types.ts:170](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L170)* ___ @@ -614,7 +614,7 @@ ___ • **snapshotID**: *string* -*Defined in [types.ts:169](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L169)* +*Defined in [types.ts:169](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L169)*
@@ -643,7 +643,7 @@ ___ • **EthereumNetworkID**: *number* -*Defined in [types.ts:188](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L188)* +*Defined in [types.ts:188](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L188)* ___ @@ -651,7 +651,7 @@ ___ • **LatestBlock**: *[LatestBlock](#interface-latestblock)* -*Defined in [types.ts:189](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L189)* +*Defined in [types.ts:189](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L189)* ___ @@ -659,7 +659,7 @@ ___ • **NumOrders**: *number* -*Defined in [types.ts:191](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L191)* +*Defined in [types.ts:191](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L191)* ___ @@ -667,7 +667,7 @@ ___ • **NumPeers**: *number* -*Defined in [types.ts:190](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L190)* +*Defined in [types.ts:190](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L190)* ___ @@ -675,7 +675,7 @@ ___ • **PeerID**: *string* -*Defined in [types.ts:187](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L187)* +*Defined in [types.ts:187](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L187)* ___ @@ -683,7 +683,7 @@ ___ • **PubSubTopic**: *string* -*Defined in [types.ts:185](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L185)* +*Defined in [types.ts:185](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L185)* ___ @@ -691,7 +691,7 @@ ___ • **Rendezvous**: *string* -*Defined in [types.ts:186](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L186)* +*Defined in [types.ts:186](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L186)* ___ @@ -699,7 +699,7 @@ ___ • **Version**: *string* -*Defined in [types.ts:184](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L184)* +*Defined in [types.ts:184](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L184)*
@@ -722,7 +722,7 @@ ___ • **result**: *string* -*Defined in [types.ts:71](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L71)* +*Defined in [types.ts:71](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L71)* ___ @@ -730,7 +730,7 @@ ___ • **subscription**: *string* -*Defined in [types.ts:70](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L70)* +*Defined in [types.ts:70](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L70)*
@@ -753,7 +753,7 @@ ___ • **hash**: *string* -*Defined in [types.ts:180](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L180)* +*Defined in [types.ts:180](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L180)* ___ @@ -761,7 +761,7 @@ ___ • **number**: *number* -*Defined in [types.ts:179](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L179)* +*Defined in [types.ts:179](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L179)*
@@ -787,7 +787,7 @@ ___ • **fillableTakerAssetAmount**: *`BigNumber`* -*Defined in [types.ts:86](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L86)* +*Defined in [types.ts:86](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L86)* ___ @@ -795,7 +795,7 @@ ___ • **kind**: *[OrderEventKind](#enumeration-ordereventkind)* -*Defined in [types.ts:85](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L85)* +*Defined in [types.ts:85](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L85)* ___ @@ -803,7 +803,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:83](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L83)* +*Defined in [types.ts:83](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L83)* ___ @@ -811,7 +811,7 @@ ___ • **signedOrder**: *`SignedOrder`* -*Defined in [types.ts:84](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L84)* +*Defined in [types.ts:84](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L84)* ___ @@ -819,7 +819,7 @@ ___ • **txHashes**: *string[]* -*Defined in [types.ts:87](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L87)* +*Defined in [types.ts:87](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L87)*
@@ -842,7 +842,7 @@ ___ • **result**: *[RawOrderEvent](#interface-raworderevent)[]* -*Defined in [types.ts:66](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L66)* ___ @@ -850,7 +850,7 @@ ___ • **subscription**: *string* -*Defined in [types.ts:65](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L65)*
@@ -874,7 +874,7 @@ ___ • **fillableTakerAssetAmount**: *`BigNumber`* -*Defined in [types.ts:113](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L113)* +*Defined in [types.ts:113](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L113)* ___ @@ -882,7 +882,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:111](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L111)* +*Defined in [types.ts:111](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L111)* ___ @@ -890,7 +890,7 @@ ___ • **signedOrder**: *`SignedOrder`* -*Defined in [types.ts:112](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L112)* +*Defined in [types.ts:112](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L112)*
@@ -915,7 +915,7 @@ ___ • **fillableTakerAssetAmount**: *string* -*Defined in [types.ts:93](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L93)* +*Defined in [types.ts:93](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L93)* ___ @@ -923,7 +923,7 @@ ___ • **isNew**: *boolean* -*Defined in [types.ts:94](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L94)* +*Defined in [types.ts:94](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L94)* ___ @@ -931,7 +931,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:91](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L91)* +*Defined in [types.ts:91](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L91)* ___ @@ -939,7 +939,7 @@ ___ • **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* -*Defined in [types.ts:92](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L92)* +*Defined in [types.ts:92](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L92)*
@@ -965,7 +965,7 @@ ___ • **fillableTakerAssetAmount**: *string* -*Defined in [types.ts:78](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L78)* +*Defined in [types.ts:78](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L78)* ___ @@ -973,7 +973,7 @@ ___ • **kind**: *[OrderEventKind](#enumeration-ordereventkind)* -*Defined in [types.ts:77](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L77)* +*Defined in [types.ts:77](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L77)* ___ @@ -981,7 +981,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:75](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L75)* ___ @@ -989,7 +989,7 @@ ___ • **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* -*Defined in [types.ts:76](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L76)* ___ @@ -997,7 +997,7 @@ ___ • **txHashes**: *string[]* -*Defined in [types.ts:79](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L79)* +*Defined in [types.ts:79](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L79)*
@@ -1021,7 +1021,7 @@ ___ • **fillableTakerAssetAmount**: *string* -*Defined in [types.ts:107](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L107)* +*Defined in [types.ts:107](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L107)* ___ @@ -1029,7 +1029,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:105](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L105)* +*Defined in [types.ts:105](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L105)* ___ @@ -1037,7 +1037,7 @@ ___ • **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* -*Defined in [types.ts:106](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L106)* +*Defined in [types.ts:106](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L106)*
@@ -1062,7 +1062,7 @@ ___ • **kind**: *[RejectedKind](#enumeration-rejectedkind)* -*Defined in [types.ts:147](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L147)* +*Defined in [types.ts:147](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L147)* ___ @@ -1070,7 +1070,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:145](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L145)* +*Defined in [types.ts:145](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L145)* ___ @@ -1078,7 +1078,7 @@ ___ • **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* -*Defined in [types.ts:146](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L146)* +*Defined in [types.ts:146](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L146)* ___ @@ -1086,7 +1086,7 @@ ___ • **status**: *[RejectedStatus](#interface-rejectedstatus)* -*Defined in [types.ts:148](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L148)* +*Defined in [types.ts:148](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L148)*
@@ -1109,7 +1109,7 @@ ___ • **accepted**: *[RawAcceptedOrderInfo](#interface-rawacceptedorderinfo)[]* -*Defined in [types.ts:159](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L159)* +*Defined in [types.ts:159](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L159)* ___ @@ -1117,7 +1117,7 @@ ___ • **rejected**: *[RawRejectedOrderInfo](#interface-rawrejectedorderinfo)[]* -*Defined in [types.ts:160](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L160)* +*Defined in [types.ts:160](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L160)*
@@ -1142,7 +1142,7 @@ ___ • **kind**: *[RejectedKind](#enumeration-rejectedkind)* -*Defined in [types.ts:154](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L154)* +*Defined in [types.ts:154](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L154)* ___ @@ -1150,7 +1150,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:152](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L152)* +*Defined in [types.ts:152](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L152)* ___ @@ -1158,7 +1158,7 @@ ___ • **signedOrder**: *`SignedOrder`* -*Defined in [types.ts:153](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L153)* +*Defined in [types.ts:153](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L153)* ___ @@ -1166,7 +1166,7 @@ ___ • **status**: *[RejectedStatus](#interface-rejectedstatus)* -*Defined in [types.ts:155](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L155)* +*Defined in [types.ts:155](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L155)*
@@ -1189,7 +1189,7 @@ ___ • **code**: *[RejectedCode](#enumeration-rejectedcode)* -*Defined in [types.ts:140](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L140)* +*Defined in [types.ts:140](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L140)* ___ @@ -1197,7 +1197,7 @@ ___ • **message**: *string* -*Defined in [types.ts:141](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L141)* +*Defined in [types.ts:141](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L141)*
@@ -1232,7 +1232,7 @@ ___ • **exchangeAddress**: *string* -*Defined in [types.ts:47](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L47)* ___ @@ -1240,7 +1240,7 @@ ___ • **expirationTimeSeconds**: *string* -*Defined in [types.ts:49](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L49)* ___ @@ -1248,7 +1248,7 @@ ___ • **feeRecipientAddress**: *string* -*Defined in [types.ts:48](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L48)* ___ @@ -1256,7 +1256,7 @@ ___ • **makerAddress**: *string* -*Defined in [types.ts:38](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L38)* ___ @@ -1264,7 +1264,7 @@ ___ • **makerAssetAmount**: *string* -*Defined in [types.ts:42](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L42)* ___ @@ -1272,7 +1272,7 @@ ___ • **makerAssetData**: *string* -*Defined in [types.ts:44](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L44)* +*Defined in [types.ts:44](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L44)* ___ @@ -1280,7 +1280,7 @@ ___ • **makerFee**: *string* -*Defined in [types.ts:40](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L40)* ___ @@ -1288,7 +1288,7 @@ ___ • **salt**: *string* -*Defined in [types.ts:46](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L46)* ___ @@ -1296,7 +1296,7 @@ ___ • **senderAddress**: *string* -*Defined in [types.ts:37](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L37)* ___ @@ -1304,7 +1304,7 @@ ___ • **signature**: *string* -*Defined in [types.ts:50](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L50)* ___ @@ -1312,7 +1312,7 @@ ___ • **takerAddress**: *string* -*Defined in [types.ts:39](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L39)* ___ @@ -1320,7 +1320,7 @@ ___ • **takerAssetAmount**: *string* -*Defined in [types.ts:43](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L43)* +*Defined in [types.ts:43](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L43)* ___ @@ -1328,7 +1328,7 @@ ___ • **takerAssetData**: *string* -*Defined in [types.ts:45](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L45)* ___ @@ -1336,7 +1336,7 @@ ___ • **takerFee**: *string* -*Defined in [types.ts:41](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L41)*
@@ -1359,7 +1359,7 @@ ___ • **accepted**: *[AcceptedOrderInfo](#interface-acceptedorderinfo)[]* -*Defined in [types.ts:164](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L164)* +*Defined in [types.ts:164](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L164)* ___ @@ -1367,7 +1367,7 @@ ___ • **rejected**: *[RejectedOrderInfo](#interface-rejectedorderinfo)[]* -*Defined in [types.ts:165](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L165)* +*Defined in [types.ts:165](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L165)*
@@ -1390,7 +1390,7 @@ ___ • **type**: *string* -*Defined in [types.ts:174](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L174)* +*Defined in [types.ts:174](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L174)* ___ @@ -1398,7 +1398,7 @@ ___ • **utf8Data**: *string* -*Defined in [types.ts:175](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L175)* +*Defined in [types.ts:175](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L175)*
@@ -1432,7 +1432,7 @@ reconnectAfter: time in milliseconds after which to attempt to reconnect to WS s • **clientConfig**? : *[ClientConfig](#interface-clientconfig)* -*Defined in [types.ts:32](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L32)* ___ @@ -1440,7 +1440,7 @@ ___ • **headers**? : *undefined | `__type`* -*Defined in [types.ts:30](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L30)* ___ @@ -1448,7 +1448,7 @@ ___ • **protocol**? : *undefined | string* -*Defined in [types.ts:31](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L31)* +*Defined in [types.ts:31](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L31)* ___ @@ -1456,7 +1456,7 @@ ___ • **reconnectAfter**? : *undefined | number* -*Defined in [types.ts:33](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L33)* +*Defined in [types.ts:33](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L33)* ___ @@ -1464,7 +1464,7 @@ ___ • **timeout**? : *undefined | number* -*Defined in [types.ts:29](https://github.com/0xProject/0x-mesh/blob/e786ffe/rpc/clients/typescript/src/types.ts#L29)* +*Defined in [types.ts:29](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L29)*
From dc8327a6d3f0a70bf7af10fb899254a8469db9ff Mon Sep 17 00:00:00 2001 From: fabioberger Date: Sat, 3 Aug 2019 15:29:25 +0200 Subject: [PATCH 06/12] Make glob call async --- rpc/clients/typescript/scripts/ts_doc_gen.ts | 32 +++++++++----------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/rpc/clients/typescript/scripts/ts_doc_gen.ts b/rpc/clients/typescript/scripts/ts_doc_gen.ts index cd4c87e9c..5368fbfa0 100644 --- a/rpc/clients/typescript/scripts/ts_doc_gen.ts +++ b/rpc/clients/typescript/scripts/ts_doc_gen.ts @@ -6,6 +6,7 @@ import * as rimraf from 'rimraf'; import * as yargs from 'yargs'; const rimrafAsync = promisify(rimraf); +const globAsync = promisify(glob); (async () => { @@ -40,11 +41,9 @@ const rimrafAsync = promisify(rimraf); // Concat all TS Client MD files together into a single reference doc const referencePath = `${args.output}/reference.md`; await rimrafAsync(referencePath); - glob(`${args.output}/**/*`, (err: Error | null, paths: string[]) => { - if (err !== null) { - throw err; - } - (paths as any).sort((firstEl: string, secondEl: string) => { + const paths = await globAsync(`${args.output}/**/*`) as string[]; + + (paths as any).sort((firstEl: string, secondEl: string) => { const isFirstAFile = firstEl.includes('.md'); const isSecondAFile = secondEl.includes('.md'); if ((isFirstAFile && isSecondAFile) || (!isFirstAFile && !isSecondAFile)) { @@ -58,7 +57,7 @@ const rimrafAsync = promisify(rimraf); } return undefined; }); - for (const path of paths) { + for (const path of paths) { if (path.includes('.md', 1)) { if (!path.includes('README.md', 1) && !path.includes('/modules/', 1) && !path.includes('globals.md', 1)) { // Read file content and concat to new file @@ -79,15 +78,14 @@ const rimrafAsync = promisify(rimraf); } // Find/replace relative links with hash links - const docsBuff = fs.readFileSync(referencePath); - let docs = docsBuff.toString(); - docs = docs.replace(/\]\(((?!.*(github.com)).*)(#.*\))/g, ']($3'); - docs = docs.replace(/\]\(..\/interfaces\/.*?\.(.*?)\.md\)/g, '](#interface-$1)'); - docs = docs.replace(/\]\(..\/classes\/.*?\.(.*?)\.md\)/g, '](#class-$1)'); - docs = docs.replace(/\]\(..\/enums\/.*?\.(.*?)\.md\)/g, '](#enumeration-$1)'); - docs = docs.replace(/\]\(_types_\.(.*?)\.md\)/g, '](#interface-$1)'); - docs = docs.replace(/\]\(.*\.(.*?)\.md\)/g, '](#class-$1)'); - fs.writeFileSync(referencePath, docs); - logUtils.log('TS doc generation complete!'); - }); + const docsBuff = fs.readFileSync(referencePath); + let docs = docsBuff.toString(); + docs = docs.replace(/\]\(((?!.*(github.com)).*)(#.*\))/g, ']($3'); + docs = docs.replace(/\]\(..\/interfaces\/.*?\.(.*?)\.md\)/g, '](#interface-$1)'); + docs = docs.replace(/\]\(..\/classes\/.*?\.(.*?)\.md\)/g, '](#class-$1)'); + docs = docs.replace(/\]\(..\/enums\/.*?\.(.*?)\.md\)/g, '](#enumeration-$1)'); + docs = docs.replace(/\]\(_types_\.(.*?)\.md\)/g, '](#interface-$1)'); + docs = docs.replace(/\]\(.*\.(.*?)\.md\)/g, '](#class-$1)'); + fs.writeFileSync(referencePath, docs); + logUtils.log('TS doc generation complete!'); })(); From 43c0360c1f20517235411856659861bdf6fdce52 Mon Sep 17 00:00:00 2001 From: fabioberger Date: Sat, 3 Aug 2019 15:46:45 +0200 Subject: [PATCH 07/12] Add s3 doc upload step --- rpc/clients/typescript/package.json | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/rpc/clients/typescript/package.json b/rpc/clients/typescript/package.json index 388ed3f84..b93067e2e 100644 --- a/rpc/clients/typescript/package.json +++ b/rpc/clients/typescript/package.json @@ -1,6 +1,6 @@ { "name": "@0x/mesh-rpc-client", - "version": "development", + "version": "2.0.0-beta", "engines": { "node": ">=6.12" }, @@ -21,8 +21,12 @@ "lint": "tslint --format stylish --project .", "fix": "tslint --fix --format stylish --project .", "test": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --exit", - "script:processDocs": "node ./lib/scripts/post_process_docs.js", - "docs:md": "yarn script:processDocs;" + "script:tsDocGen": "node ./lib/scripts/ts_doc_gen.js", + "s3:sync": "aws s3 sync ${npm_package_config_docsPath} s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers", + "docs:md": "yarn script:tsDocGen --sourceDir=./src --output=${npm_package_config_docsPath}; yarn s3:sync" + }, + "config": { + "docsPath": "../../../docs/json_rpc_clients/typescript" }, "repository": { "type": "git", From a02e98a069b9b3ccbe6bd3d9acace7d77ac5e9ac Mon Sep 17 00:00:00 2001 From: fabioberger Date: Sat, 3 Aug 2019 16:33:46 +0200 Subject: [PATCH 08/12] Replace ts_doc_gen script with @0x/ts-doc-gen dep --- .gitignore | 1 + rpc/clients/typescript/package.json | 18 +--- rpc/clients/typescript/scripts/ts_doc_gen.ts | 91 -------------------- rpc/clients/typescript/tsconfig.json | 2 +- rpc/clients/typescript/yarn.lock | 44 ++++------ 5 files changed, 24 insertions(+), 132 deletions(-) delete mode 100644 rpc/clients/typescript/scripts/ts_doc_gen.ts diff --git a/.gitignore b/.gitignore index 458f8a4bf..b7def18bf 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ examples/javascript_websocket_client/node_modules examples/javascript_websocket_client/lib rpc/clients/typescript/node_modules rpc/clients/typescript/lib +rpc/clients/typescript/yarn-error.log diff --git a/rpc/clients/typescript/package.json b/rpc/clients/typescript/package.json index b93067e2e..3122a99e2 100644 --- a/rpc/clients/typescript/package.json +++ b/rpc/clients/typescript/package.json @@ -17,13 +17,11 @@ "types": "lib/src/index.d.ts", "scripts": { "build": "tsc -b", - "clean": "shx rm -rf lib test_temp generated_docs", + "clean": "shx rm -rf lib", "lint": "tslint --format stylish --project .", - "fix": "tslint --fix --format stylish --project .", "test": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --exit", - "script:tsDocGen": "node ./lib/scripts/ts_doc_gen.js", "s3:sync": "aws s3 sync ${npm_package_config_docsPath} s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers", - "docs:md": "yarn script:tsDocGen --sourceDir=./src --output=${npm_package_config_docsPath}; yarn s3:sync" + "docs:md": "ts-doc-gen --sourceDir=./src --output=${npm_package_config_docsPath}; yarn s3:sync" }, "config": { "docsPath": "../../../docs/json_rpc_clients/typescript" @@ -47,30 +45,22 @@ "@0x/utils": "^4.4.2", "@0x/web3-providers-fork": "0.0.7", "uuid": "^3.3.2", - "websocket": "^1.0.29", - "yargs": "^10.0.3" + "websocket": "^1.0.29" }, "devDependencies": { + "@0x/ts-doc-gen": "^0.0.2", "@0x/tslint-config": "^3.0.1", - "@types/glob": "^7.1.1", "@types/mocha": "^2.2.42", - "@types/rimraf": "^2.0.2", "@types/uuid": "^3.4.3", "@types/websocket": "^0.0.40", - "@types/yargs": "^11.0.0", "chai": "^4.0.1", "chai-as-promised": "^7.1.0", "chai-bignumber": "^3.0.0", "dirty-chai": "^2.0.1", - "glob": "^7.1.4", "make-promises-safe": "^1.1.0", "mocha": "^4.1.0", - "promisify-child-process": "^3.1.1", - "rimraf": "^2.6.3", "shx": "^0.2.2", "tslint": "5.11.0", - "typedoc": "^0.15.0", - "typedoc-plugin-markdown": "^2.1.0", "typescript": "3.0.1" }, "publishConfig": { diff --git a/rpc/clients/typescript/scripts/ts_doc_gen.ts b/rpc/clients/typescript/scripts/ts_doc_gen.ts deleted file mode 100644 index 5368fbfa0..000000000 --- a/rpc/clients/typescript/scripts/ts_doc_gen.ts +++ /dev/null @@ -1,91 +0,0 @@ -import { logUtils, promisify } from '@0x/utils'; -import * as fs from 'fs'; -import * as glob from 'glob'; -import { exec as execAsync } from 'promisify-child-process'; -import * as rimraf from 'rimraf'; -import * as yargs from 'yargs'; - -const rimrafAsync = promisify(rimraf); -const globAsync = promisify(glob); - -(async () => { - - const args = yargs - .option('sourceDir', { - alias: ['s', 'src'], - describe: 'Folder where the source TS files are located', - type: 'string', - normalize: true, - demandOption: true, - }) - .option('output', { - alias: ['o', 'out'], - describe: 'Folder where to put the output doc files', - type: 'string', - normalize: true, - demandOption: true, - }) - .example( - "$0 --src 'src' --out 'docs'", - 'Full usage example', - ).argv; - - await rimrafAsync(args.output); - try { - await execAsync(`./node_modules/typedoc/bin/typedoc --theme markdown --platform gitbook --excludePrivate --excludeProtected --excludeExternals --excludeNotExported --target ES5 --module commonjs --hideGenerator --out ${args.output} ${args.sourceDir}`); - } catch (err) { - logUtils.log('typedoc command failed: ', err); - process.exit(1); - } - - // Concat all TS Client MD files together into a single reference doc - const referencePath = `${args.output}/reference.md`; - await rimrafAsync(referencePath); - const paths = await globAsync(`${args.output}/**/*`) as string[]; - - (paths as any).sort((firstEl: string, secondEl: string) => { - const isFirstAFile = firstEl.includes('.md'); - const isSecondAFile = secondEl.includes('.md'); - if ((isFirstAFile && isSecondAFile) || (!isFirstAFile && !isSecondAFile)) { - return 0; - } - if (isFirstAFile) { - return -1; - } - if (isSecondAFile) { - return 1; - } - return undefined; - }); - for (const path of paths) { - if (path.includes('.md', 1)) { - if (!path.includes('README.md', 1) && !path.includes('/modules/', 1) && !path.includes('globals.md', 1)) { - // Read file content and concat to new file - const content = fs.readFileSync(path); - fs.appendFileSync(referencePath, content); - fs.appendFileSync(referencePath, '\n'); - fs.appendFileSync(referencePath, '\n'); - fs.appendFileSync(referencePath, '
'); - fs.appendFileSync(referencePath, '\n'); - fs.appendFileSync(referencePath, '\n'); - } - if (!path.includes('README.md', 1)) { - fs.unlinkSync(path); - } - } else { - fs.rmdirSync(path); - } - } - - // Find/replace relative links with hash links - const docsBuff = fs.readFileSync(referencePath); - let docs = docsBuff.toString(); - docs = docs.replace(/\]\(((?!.*(github.com)).*)(#.*\))/g, ']($3'); - docs = docs.replace(/\]\(..\/interfaces\/.*?\.(.*?)\.md\)/g, '](#interface-$1)'); - docs = docs.replace(/\]\(..\/classes\/.*?\.(.*?)\.md\)/g, '](#class-$1)'); - docs = docs.replace(/\]\(..\/enums\/.*?\.(.*?)\.md\)/g, '](#enumeration-$1)'); - docs = docs.replace(/\]\(_types_\.(.*?)\.md\)/g, '](#interface-$1)'); - docs = docs.replace(/\]\(.*\.(.*?)\.md\)/g, '](#class-$1)'); - fs.writeFileSync(referencePath, docs); - logUtils.log('TS doc generation complete!'); -})(); diff --git a/rpc/clients/typescript/tsconfig.json b/rpc/clients/typescript/tsconfig.json index 06a983871..a80ae3ea7 100644 --- a/rpc/clients/typescript/tsconfig.json +++ b/rpc/clients/typescript/tsconfig.json @@ -15,5 +15,5 @@ "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], "strict": true, }, - "include": ["./src/**/*", "./test/**/*", "./scripts/**/*"], + "include": ["./src/**/*", "./test/**/*"], } diff --git a/rpc/clients/typescript/yarn.lock b/rpc/clients/typescript/yarn.lock index 8ca4bc794..48646455c 100644 --- a/rpc/clients/typescript/yarn.lock +++ b/rpc/clients/typescript/yarn.lock @@ -128,6 +128,20 @@ optionalDependencies: "@ledgerhq/hw-transport-node-hid" "^4.3.0" +"@0x/ts-doc-gen@^0.0.2": + version "0.0.2" + resolved "https://registry.yarnpkg.com/@0x/ts-doc-gen/-/ts-doc-gen-0.0.2.tgz#04ef1bd4d40297864fe92ac604d9e64e52c6f226" + integrity sha512-qfpWfirTj1AKSj5x5gOk1opAvCWw6xwa5BcPs/CQeHtd0I7DWW1Ld6AosZnqk2wUGS0axXBAIz0AhC9GIYgLOg== + dependencies: + "@0x/typescript-typings" "^4.2.2" + "@0x/utils" "^4.3.3" + glob "^7.1.4" + promisify-child-process "^3.1.1" + rimraf "^2.6.3" + typedoc "^0.15.0" + typedoc-plugin-markdown "^2.1.0" + yargs "^10.0.3" + "@0x/tslint-config@^3.0.1": version "3.0.1" resolved "https://registry.yarnpkg.com/@0x/tslint-config/-/tslint-config-3.0.1.tgz#396038f617371ff6bc2dc36c2b5162b13835576f" @@ -304,15 +318,6 @@ resolved "https://registry.yarnpkg.com/@types/events/-/events-3.0.0.tgz#2862f3f58a9a7f7c3e78d79f130dd4d71c25c2a7" integrity sha512-EaObqwIvayI5a8dCzhFrjKzVwKLxjoG9T6Ppd5CEo07LRKfQ8Yokw54r5+Wq7FaBQ+yXRvQAYPrHwya1/UFt9g== -"@types/glob@*", "@types/glob@^7.1.1": - version "7.1.1" - resolved "https://registry.yarnpkg.com/@types/glob/-/glob-7.1.1.tgz#aa59a1c6e3fbc421e07ccd31a944c30eba521575" - integrity sha512-1Bh06cbWJUHMC97acuD6UMG29nMt0Aqz1vF3guLfG+kHHJhy3AyohZFFxYk2f7Q1SQIrNwvncxAE0N/9s70F2w== - dependencies: - "@types/events" "*" - "@types/minimatch" "*" - "@types/node" "*" - "@types/hdkey@^0.7.0": version "0.7.0" resolved "https://registry.yarnpkg.com/@types/hdkey/-/hdkey-0.7.0.tgz#6734d138e3c597f241be8fae2e60c2949bc3af87" @@ -320,7 +325,7 @@ dependencies: "@types/node" "*" -"@types/minimatch@*", "@types/minimatch@3.0.3": +"@types/minimatch@3.0.3": version "3.0.3" resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d" integrity sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA== @@ -353,14 +358,6 @@ "@types/prop-types" "*" csstype "^2.2.0" -"@types/rimraf@^2.0.2": - version "2.0.2" - resolved "https://registry.yarnpkg.com/@types/rimraf/-/rimraf-2.0.2.tgz#7f0fc3cf0ff0ad2a99bb723ae1764f30acaf8b6e" - integrity sha512-Hm/bnWq0TCy7jmjeN5bKYij9vw5GrDFWME4IuxV08278NtU/VdGbzsBohcCUJ7+QMqmUq5hpRKB39HeQWJjztQ== - dependencies: - "@types/glob" "*" - "@types/node" "*" - "@types/uuid@^3.4.3": version "3.4.5" resolved "https://registry.yarnpkg.com/@types/uuid/-/uuid-3.4.5.tgz#d4dc10785b497a1474eae0ba7f0cb09c0ddfd6eb" @@ -383,11 +380,6 @@ "@types/events" "*" "@types/node" "*" -"@types/yargs@^11.0.0": - version "11.1.2" - resolved "https://registry.yarnpkg.com/@types/yargs/-/yargs-11.1.2.tgz#fd4b676846fe731a5de5c6d2e5ef6a377262fc30" - integrity sha512-zG61PAp2OcoIBjRV44wftJj6AJgzJrOc32LCYOBqk9bdgcdzK5DCJHV9QZJ60+Fu+fOn79g8Ks3Gixm4CfkZ+w== - abbrev@1: version "1.1.1" resolved "https://registry.yarnpkg.com/abbrev/-/abbrev-1.1.1.tgz#f8f2c887ad10bf67f634f005b6987fed3179aac8" @@ -3708,9 +3700,9 @@ heap@0.2.6: integrity sha1-CH4fELBGky/IWU3Z5tN4r8nR5aw= highlight.js@^9.15.8: - version "9.15.8" - resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.15.8.tgz#f344fda123f36f1a65490e932cf90569e4999971" - integrity sha512-RrapkKQWwE+wKdF73VsOa2RQdIoO3mxwJ4P8mhbI6KYJUraUHRKM5w5zQQKXNk0xNL4UVRdulV9SBJcmzJNzVA== + version "9.15.9" + resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.15.9.tgz#865257da1dbb4a58c4552d46c4b3854f77f0e6d5" + integrity sha512-M0zZvfLr5p0keDMCAhNBp03XJbKBxUx5AfyfufMdFMEP4N/Xj6dh0IqC75ys7BAzceR34NgcvXjupRVaHBPPVQ== hmac-drbg@^1.0.0: version "1.0.1" From 40206395220a06b3309d4a1e22c399628d0ede5e Mon Sep 17 00:00:00 2001 From: fabioberger Date: Sat, 3 Aug 2019 16:34:54 +0200 Subject: [PATCH 09/12] revert version --- rpc/clients/typescript/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rpc/clients/typescript/package.json b/rpc/clients/typescript/package.json index 3122a99e2..f4e33da3c 100644 --- a/rpc/clients/typescript/package.json +++ b/rpc/clients/typescript/package.json @@ -1,6 +1,6 @@ { "name": "@0x/mesh-rpc-client", - "version": "2.0.0-beta", + "version": "development", "engines": { "node": ">=6.12" }, From d6bacaee7667ac084f7e129537980904f7cb7d9f Mon Sep 17 00:00:00 2001 From: fabioberger Date: Sat, 3 Aug 2019 16:35:32 +0200 Subject: [PATCH 10/12] Small fixes --- rpc/clients/typescript/src/globals.d.ts | 2 -- rpc/clients/typescript/tsconfig.json | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/rpc/clients/typescript/src/globals.d.ts b/rpc/clients/typescript/src/globals.d.ts index 219ef8f08..783b92913 100644 --- a/rpc/clients/typescript/src/globals.d.ts +++ b/rpc/clients/typescript/src/globals.d.ts @@ -2,5 +2,3 @@ declare module '*.json' { const value: any; export default value; } - -declare module 'promisify-child-process'; diff --git a/rpc/clients/typescript/tsconfig.json b/rpc/clients/typescript/tsconfig.json index a80ae3ea7..432648e84 100644 --- a/rpc/clients/typescript/tsconfig.json +++ b/rpc/clients/typescript/tsconfig.json @@ -15,5 +15,5 @@ "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], "strict": true, }, - "include": ["./src/**/*", "./test/**/*"], + "include": ["./src/**/*", "./test/**/*"] } From 3c0943a1b6e28d8a72f0494ead79a3dbb03b7876 Mon Sep 17 00:00:00 2001 From: fabioberger Date: Sat, 3 Aug 2019 17:13:07 +0200 Subject: [PATCH 11/12] Update ts-doc-gen dep --- rpc/clients/typescript/package.json | 2 +- rpc/clients/typescript/yarn.lock | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/rpc/clients/typescript/package.json b/rpc/clients/typescript/package.json index f4e33da3c..c2a05e940 100644 --- a/rpc/clients/typescript/package.json +++ b/rpc/clients/typescript/package.json @@ -48,7 +48,7 @@ "websocket": "^1.0.29" }, "devDependencies": { - "@0x/ts-doc-gen": "^0.0.2", + "@0x/ts-doc-gen": "^0.0.3", "@0x/tslint-config": "^3.0.1", "@types/mocha": "^2.2.42", "@types/uuid": "^3.4.3", diff --git a/rpc/clients/typescript/yarn.lock b/rpc/clients/typescript/yarn.lock index 48646455c..dd7f36fc1 100644 --- a/rpc/clients/typescript/yarn.lock +++ b/rpc/clients/typescript/yarn.lock @@ -128,10 +128,10 @@ optionalDependencies: "@ledgerhq/hw-transport-node-hid" "^4.3.0" -"@0x/ts-doc-gen@^0.0.2": - version "0.0.2" - resolved "https://registry.yarnpkg.com/@0x/ts-doc-gen/-/ts-doc-gen-0.0.2.tgz#04ef1bd4d40297864fe92ac604d9e64e52c6f226" - integrity sha512-qfpWfirTj1AKSj5x5gOk1opAvCWw6xwa5BcPs/CQeHtd0I7DWW1Ld6AosZnqk2wUGS0axXBAIz0AhC9GIYgLOg== +"@0x/ts-doc-gen@^0.0.3": + version "0.0.3" + resolved "https://registry.yarnpkg.com/@0x/ts-doc-gen/-/ts-doc-gen-0.0.3.tgz#460ffb10554f0491b8d9c92fa407e68b179e4b28" + integrity sha512-4UkL4u8BXOUkkL2++Ej4tWxkqaSGGykK+q6DaI2aWHahjr3GAcKSfCxFkjOW1pQvO2jdgbJWIg6vxBv8fEcQcA== dependencies: "@0x/typescript-typings" "^4.2.2" "@0x/utils" "^4.3.3" @@ -162,7 +162,7 @@ bignumber.js "~8.0.2" ethereum-types "^2.1.4" -"@0x/typescript-typings@^4.2.4": +"@0x/typescript-typings@^4.2.2", "@0x/typescript-typings@^4.2.4": version "4.2.4" resolved "https://registry.yarnpkg.com/@0x/typescript-typings/-/typescript-typings-4.2.4.tgz#0858639ddfdf7e9e1a3f9fd8f7d8f2e8ebfdce85" integrity sha512-yIg8q/bj9+Y0OzNuq59D3JDe4OoQR3bU2QKy+7d8NV6CIfA0GqfWWS+JFdUB45S45qT5P0EmThh/szQ7zuW4oQ== @@ -173,7 +173,7 @@ ethereum-types "^2.1.4" popper.js "1.14.3" -"@0x/utils@^4.4.2": +"@0x/utils@^4.3.3", "@0x/utils@^4.4.2": version "4.4.2" resolved "https://registry.yarnpkg.com/@0x/utils/-/utils-4.4.2.tgz#8c7899f0f768859a92e805cfa93e57f921cf6122" integrity sha512-kR0KncZP/m+V5HDUlNNOgcQXmnLA2e7lfovUxNI1XWB8djXDlB42ukqK8A4KRtxlt+A8CsXR64OcXvO8c6wQgA== From 9343a84542a9e8b7c9836a7e85f9e8431f114d8e Mon Sep 17 00:00:00 2001 From: fabioberger Date: Sat, 3 Aug 2019 22:13:10 +0200 Subject: [PATCH 12/12] Update ts-docs-gen package and fix reference generation --- docs/json_rpc_clients/typescript/reference.md | 295 +++++++----------- rpc/clients/typescript/package.json | 4 +- rpc/clients/typescript/yarn.lock | 8 +- 3 files changed, 124 insertions(+), 183 deletions(-) diff --git a/docs/json_rpc_clients/typescript/reference.md b/docs/json_rpc_clients/typescript/reference.md index d96c0ab68..225f02036 100644 --- a/docs/json_rpc_clients/typescript/reference.md +++ b/docs/json_rpc_clients/typescript/reference.md @@ -28,9 +28,9 @@ websocket endpoint. ### constructor -\+ **new WSClient**(`url`: string, `wsOpts?`: [WSOpts](#class-wsclient)* +\+ **new WSClient**(`url`: string, `wsOpts?`: [WSOpts](#interface-wsopts)): *[WSClient](#class-wsclient)* -*Defined in [ws_client.ts:71](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L71)* +*Defined in [ws_client.ts:71](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/ws_client.ts#L71)* Instantiates a new WSClient instance @@ -51,7 +51,7 @@ An instance of WSClient ▸ **addOrdersAsync**(`signedOrders`: `SignedOrder`[]): *`Promise`* -*Defined in [ws_client.ts:96](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L96)* +*Defined in [ws_client.ts:96](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/ws_client.ts#L96)* Adds an array of 0x signed orders to the Mesh node. @@ -71,7 +71,7 @@ ___ ▸ **destroy**(): *void* -*Defined in [ws_client.ts:213](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L213)* +*Defined in [ws_client.ts:213](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/ws_client.ts#L213)* destroy unsubscribes all active subscriptions, closes the websocket connection and stops the internal heartbeat connection liveness check. @@ -84,7 +84,7 @@ ___ ▸ **getOrdersAsync**(`perPage`: number): *`Promise`* -*Defined in [ws_client.ts:125](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L125)* +*Defined in [ws_client.ts:125](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/ws_client.ts#L125)* Get all 0x signed orders currently stored in the Mesh node @@ -104,7 +104,7 @@ ___ ▸ **getStatsAsync**(): *`Promise`* -*Defined in [ws_client.ts:116](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L116)* +*Defined in [ws_client.ts:116](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/ws_client.ts#L116)* **Returns:** *`Promise`* @@ -114,7 +114,7 @@ ___ ▸ **onClose**(`cb`: function): *void* -*Defined in [ws_client.ts:195](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L195)* +*Defined in [ws_client.ts:195](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/ws_client.ts#L195)* Get notified when the underlying WS connection closes normally. If it closes with an error, WSClient automatically attempts to re-connect without emitting a `close` event. @@ -135,7 +135,7 @@ ___ ▸ **onReconnected**(`cb`: function): *void* -*Defined in [ws_client.ts:204](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L204)* +*Defined in [ws_client.ts:204](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/ws_client.ts#L204)* Get notified when a connection to the underlying WS connection is re-established @@ -155,7 +155,7 @@ ___ ▸ **subscribeToOrdersAsync**(`cb`: function): *`Promise`* -*Defined in [ws_client.ts:156](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L156)* +*Defined in [ws_client.ts:156](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/ws_client.ts#L156)* Subscribe to the 'orders' topic and receive order events from Mesh. This method returns a subscriptionId that can be used to `unsubscribe()` from this subscription. @@ -184,7 +184,7 @@ ___ ▸ **unsubscribeAsync**(`subscriptionId`: string): *`Promise`* -*Defined in [ws_client.ts:185](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/ws_client.ts#L185)* +*Defined in [ws_client.ts:185](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/ws_client.ts#L185)* Unsubscribe from a subscription @@ -219,7 +219,7 @@ Name | Type | Description | • **Added**: = "ADDED" -*Defined in [types.ts:55](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L55)* +*Defined in [types.ts:55](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L55)* ___ @@ -227,7 +227,7 @@ ___ • **Cancelled**: = "CANCELLED" -*Defined in [types.ts:58](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L58)* +*Defined in [types.ts:58](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L58)* ___ @@ -235,7 +235,7 @@ ___ • **Expired**: = "EXPIRED" -*Defined in [types.ts:59](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L59)* +*Defined in [types.ts:59](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L59)* ___ @@ -243,7 +243,7 @@ ___ • **FillabilityIncreased**: = "FILLABILITY_INCREASED" -*Defined in [types.ts:61](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L61)* +*Defined in [types.ts:61](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L61)* ___ @@ -251,7 +251,7 @@ ___ • **Filled**: = "FILLED" -*Defined in [types.ts:56](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L56)* +*Defined in [types.ts:56](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L56)* ___ @@ -259,7 +259,7 @@ ___ • **FullyFilled**: = "FULLY_FILLED" -*Defined in [types.ts:57](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L57)* +*Defined in [types.ts:57](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L57)* ___ @@ -267,7 +267,7 @@ ___ • **Invalid**: = "INVALID" -*Defined in [types.ts:54](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L54)* +*Defined in [types.ts:54](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L54)* ___ @@ -275,7 +275,7 @@ ___ • **Unfunded**: = "UNFUNDED" -*Defined in [types.ts:60](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L60)* +*Defined in [types.ts:60](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L60)*
@@ -306,7 +306,7 @@ ___ • **InternalError**: = "InternalError" -*Defined in [types.ts:123](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L123)* +*Defined in [types.ts:123](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L123)* ___ @@ -314,7 +314,7 @@ ___ • **MaxOrderSizeExceeded**: = "MaxOrderSizeExceeded" -*Defined in [types.ts:124](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L124)* +*Defined in [types.ts:124](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L124)* ___ @@ -322,7 +322,7 @@ ___ • **NetworkRequestFailed**: = "NetworkRequestFailed" -*Defined in [types.ts:127](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L127)* +*Defined in [types.ts:127](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L127)* ___ @@ -330,7 +330,7 @@ ___ • **OrderAlreadyStored**: = "OrderAlreadyStored" -*Defined in [types.ts:125](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L125)* +*Defined in [types.ts:125](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L125)* ___ @@ -338,7 +338,7 @@ ___ • **OrderCancelled**: = "OrderCancelled" -*Defined in [types.ts:132](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L132)* +*Defined in [types.ts:132](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L132)* ___ @@ -346,7 +346,7 @@ ___ • **OrderExpired**: = "OrderExpired" -*Defined in [types.ts:130](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L130)* +*Defined in [types.ts:130](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L130)* ___ @@ -354,7 +354,7 @@ ___ • **OrderForIncorrectNetwork**: = "OrderForIncorrectNetwork" -*Defined in [types.ts:126](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L126)* +*Defined in [types.ts:126](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L126)* ___ @@ -362,7 +362,7 @@ ___ • **OrderFullyFilled**: = "OrderFullyFilled" -*Defined in [types.ts:131](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L131)* +*Defined in [types.ts:131](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L131)* ___ @@ -370,7 +370,7 @@ ___ • **OrderHasInvalidMakerAssetAmount**: = "OrderHasInvalidMakerAssetAmount" -*Defined in [types.ts:128](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L128)* +*Defined in [types.ts:128](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L128)* ___ @@ -378,7 +378,7 @@ ___ • **OrderHasInvalidMakerAssetData**: = "OrderHasInvalidMakerAssetData" -*Defined in [types.ts:134](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L134)* +*Defined in [types.ts:134](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L134)* ___ @@ -386,7 +386,7 @@ ___ • **OrderHasInvalidSignature**: = "OrderHasInvalidSignature" -*Defined in [types.ts:136](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L136)* +*Defined in [types.ts:136](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L136)* ___ @@ -394,7 +394,7 @@ ___ • **OrderHasInvalidTakerAssetAmount**: = "OrderHasInvalidTakerAssetAmount" -*Defined in [types.ts:129](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L129)* +*Defined in [types.ts:129](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L129)* ___ @@ -402,7 +402,7 @@ ___ • **OrderHasInvalidTakerAssetData**: = "OrderHasInvalidTakerAssetData" -*Defined in [types.ts:135](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L135)* +*Defined in [types.ts:135](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L135)* ___ @@ -410,7 +410,7 @@ ___ • **OrderUnfunded**: = "OrderUnfunded" -*Defined in [types.ts:133](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L133)* +*Defined in [types.ts:133](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L133)*
@@ -430,7 +430,7 @@ ___ • **MeshError**: = "MESH_ERROR" -*Defined in [types.ts:118](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L118)* +*Defined in [types.ts:118](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L118)* ___ @@ -438,7 +438,7 @@ ___ • **MeshValidation**: = "MESH_VALIDATION" -*Defined in [types.ts:119](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L119)* +*Defined in [types.ts:119](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L119)* ___ @@ -446,7 +446,7 @@ ___ • **ZeroexValidation**: = "ZEROEX_VALIDATION" -*Defined in [types.ts:117](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L117)* +*Defined in [types.ts:117](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L117)*
@@ -471,7 +471,7 @@ ___ • **fillableTakerAssetAmount**: *`BigNumber`* -*Defined in [types.ts:100](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L100)* +*Defined in [types.ts:100](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L100)* ___ @@ -479,7 +479,7 @@ ___ • **isNew**: *boolean* -*Defined in [types.ts:101](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L101)* +*Defined in [types.ts:101](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L101)* ___ @@ -487,7 +487,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:98](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L98)* +*Defined in [types.ts:98](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L98)* ___ @@ -495,7 +495,7 @@ ___ • **signedOrder**: *`SignedOrder`* -*Defined in [types.ts:99](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L99)* +*Defined in [types.ts:99](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L99)*
@@ -527,7 +527,7 @@ Source: https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocket • **assembleFragments**? : *undefined | false | true* -*Defined in [types.ts:14](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L14)* ___ @@ -535,7 +535,7 @@ ___ • **closeTimeout**? : *undefined | number* -*Defined in [types.ts:15](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L15)* ___ @@ -543,7 +543,7 @@ ___ • **fragmentOutgoingMessages**? : *undefined | false | true* -*Defined in [types.ts:12](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L12)* ___ @@ -551,7 +551,7 @@ ___ • **fragmentationThreshold**? : *undefined | number* -*Defined in [types.ts:13](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L13)* ___ @@ -559,7 +559,7 @@ ___ • **maxReceivedFrameSize**? : *undefined | number* -*Defined in [types.ts:10](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L10)* ___ @@ -567,7 +567,7 @@ ___ • **maxReceivedMessageSize**? : *undefined | number* -*Defined in [types.ts:11](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L11)* ___ @@ -575,7 +575,7 @@ ___ • **tlsOptions**? : *any* -*Defined in [types.ts:16](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L16)* ___ @@ -583,7 +583,7 @@ ___ • **webSocketVersion**? : *undefined | number* -*Defined in [types.ts:9](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L9)*
@@ -606,7 +606,7 @@ ___ • **ordersInfos**: *[RawAcceptedOrderInfo](#interface-rawacceptedorderinfo)[]* -*Defined in [types.ts:170](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L170)* +*Defined in [types.ts:170](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L170)* ___ @@ -614,7 +614,7 @@ ___ • **snapshotID**: *string* -*Defined in [types.ts:169](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L169)* +*Defined in [types.ts:169](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L169)*
@@ -643,7 +643,7 @@ ___ • **EthereumNetworkID**: *number* -*Defined in [types.ts:188](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L188)* +*Defined in [types.ts:188](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L188)* ___ @@ -651,7 +651,7 @@ ___ • **LatestBlock**: *[LatestBlock](#interface-latestblock)* -*Defined in [types.ts:189](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L189)* +*Defined in [types.ts:189](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L189)* ___ @@ -659,7 +659,7 @@ ___ • **NumOrders**: *number* -*Defined in [types.ts:191](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L191)* +*Defined in [types.ts:191](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L191)* ___ @@ -667,7 +667,7 @@ ___ • **NumPeers**: *number* -*Defined in [types.ts:190](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L190)* +*Defined in [types.ts:190](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L190)* ___ @@ -675,7 +675,7 @@ ___ • **PeerID**: *string* -*Defined in [types.ts:187](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L187)* +*Defined in [types.ts:187](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L187)* ___ @@ -683,7 +683,7 @@ ___ • **PubSubTopic**: *string* -*Defined in [types.ts:185](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L185)* +*Defined in [types.ts:185](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L185)* ___ @@ -691,7 +691,7 @@ ___ • **Rendezvous**: *string* -*Defined in [types.ts:186](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L186)* +*Defined in [types.ts:186](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L186)* ___ @@ -699,7 +699,7 @@ ___ • **Version**: *string* -*Defined in [types.ts:184](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L184)* +*Defined in [types.ts:184](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L184)*
@@ -722,7 +722,7 @@ ___ • **result**: *string* -*Defined in [types.ts:71](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L71)* +*Defined in [types.ts:71](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L71)* ___ @@ -730,7 +730,7 @@ ___ • **subscription**: *string* -*Defined in [types.ts:70](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L70)* +*Defined in [types.ts:70](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L70)*
@@ -753,7 +753,7 @@ ___ • **hash**: *string* -*Defined in [types.ts:180](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L180)* +*Defined in [types.ts:180](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L180)* ___ @@ -761,7 +761,7 @@ ___ • **number**: *number* -*Defined in [types.ts:179](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L179)* +*Defined in [types.ts:179](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L179)*
@@ -787,7 +787,7 @@ ___ • **fillableTakerAssetAmount**: *`BigNumber`* -*Defined in [types.ts:86](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L86)* +*Defined in [types.ts:86](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L86)* ___ @@ -795,7 +795,7 @@ ___ • **kind**: *[OrderEventKind](#enumeration-ordereventkind)* -*Defined in [types.ts:85](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L85)* +*Defined in [types.ts:85](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L85)* ___ @@ -803,7 +803,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:83](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L83)* +*Defined in [types.ts:83](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L83)* ___ @@ -811,7 +811,7 @@ ___ • **signedOrder**: *`SignedOrder`* -*Defined in [types.ts:84](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L84)* +*Defined in [types.ts:84](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L84)* ___ @@ -819,7 +819,7 @@ ___ • **txHashes**: *string[]* -*Defined in [types.ts:87](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L87)* +*Defined in [types.ts:87](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L87)*
@@ -842,7 +842,7 @@ ___ • **result**: *[RawOrderEvent](#interface-raworderevent)[]* -*Defined in [types.ts:66](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L66)* ___ @@ -850,7 +850,7 @@ ___ • **subscription**: *string* -*Defined in [types.ts:65](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L65)*
@@ -874,7 +874,7 @@ ___ • **fillableTakerAssetAmount**: *`BigNumber`* -*Defined in [types.ts:113](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L113)* +*Defined in [types.ts:113](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L113)* ___ @@ -882,7 +882,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:111](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L111)* +*Defined in [types.ts:111](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L111)* ___ @@ -890,7 +890,7 @@ ___ • **signedOrder**: *`SignedOrder`* -*Defined in [types.ts:112](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L112)* +*Defined in [types.ts:112](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L112)*
@@ -915,7 +915,7 @@ ___ • **fillableTakerAssetAmount**: *string* -*Defined in [types.ts:93](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L93)* +*Defined in [types.ts:93](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L93)* ___ @@ -923,7 +923,7 @@ ___ • **isNew**: *boolean* -*Defined in [types.ts:94](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L94)* +*Defined in [types.ts:94](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L94)* ___ @@ -931,7 +931,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:91](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L91)* +*Defined in [types.ts:91](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L91)* ___ @@ -939,7 +939,7 @@ ___ • **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* -*Defined in [types.ts:92](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L92)* +*Defined in [types.ts:92](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L92)*
@@ -965,7 +965,7 @@ ___ • **fillableTakerAssetAmount**: *string* -*Defined in [types.ts:78](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L78)* +*Defined in [types.ts:78](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L78)* ___ @@ -973,7 +973,7 @@ ___ • **kind**: *[OrderEventKind](#enumeration-ordereventkind)* -*Defined in [types.ts:77](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L77)* +*Defined in [types.ts:77](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L77)* ___ @@ -981,7 +981,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:75](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L75)* ___ @@ -989,7 +989,7 @@ ___ • **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* -*Defined in [types.ts:76](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L76)* ___ @@ -997,7 +997,7 @@ ___ • **txHashes**: *string[]* -*Defined in [types.ts:79](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L79)* +*Defined in [types.ts:79](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L79)*
@@ -1021,7 +1021,7 @@ ___ • **fillableTakerAssetAmount**: *string* -*Defined in [types.ts:107](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L107)* +*Defined in [types.ts:107](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L107)* ___ @@ -1029,7 +1029,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:105](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L105)* +*Defined in [types.ts:105](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L105)* ___ @@ -1037,7 +1037,7 @@ ___ • **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* -*Defined in [types.ts:106](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L106)* +*Defined in [types.ts:106](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L106)*
@@ -1062,7 +1062,7 @@ ___ • **kind**: *[RejectedKind](#enumeration-rejectedkind)* -*Defined in [types.ts:147](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L147)* +*Defined in [types.ts:147](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L147)* ___ @@ -1070,7 +1070,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:145](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L145)* +*Defined in [types.ts:145](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L145)* ___ @@ -1078,7 +1078,7 @@ ___ • **signedOrder**: *[StringifiedSignedOrder](#interface-stringifiedsignedorder)* -*Defined in [types.ts:146](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L146)* +*Defined in [types.ts:146](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L146)* ___ @@ -1086,7 +1086,7 @@ ___ • **status**: *[RejectedStatus](#interface-rejectedstatus)* -*Defined in [types.ts:148](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L148)* +*Defined in [types.ts:148](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L148)*
@@ -1109,7 +1109,7 @@ ___ • **accepted**: *[RawAcceptedOrderInfo](#interface-rawacceptedorderinfo)[]* -*Defined in [types.ts:159](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L159)* +*Defined in [types.ts:159](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L159)* ___ @@ -1117,7 +1117,7 @@ ___ • **rejected**: *[RawRejectedOrderInfo](#interface-rawrejectedorderinfo)[]* -*Defined in [types.ts:160](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L160)* +*Defined in [types.ts:160](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L160)*
@@ -1142,7 +1142,7 @@ ___ • **kind**: *[RejectedKind](#enumeration-rejectedkind)* -*Defined in [types.ts:154](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L154)* +*Defined in [types.ts:154](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L154)* ___ @@ -1150,7 +1150,7 @@ ___ • **orderHash**: *string* -*Defined in [types.ts:152](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L152)* +*Defined in [types.ts:152](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L152)* ___ @@ -1158,7 +1158,7 @@ ___ • **signedOrder**: *`SignedOrder`* -*Defined in [types.ts:153](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L153)* +*Defined in [types.ts:153](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L153)* ___ @@ -1166,7 +1166,7 @@ ___ • **status**: *[RejectedStatus](#interface-rejectedstatus)* -*Defined in [types.ts:155](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L155)* +*Defined in [types.ts:155](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L155)*
@@ -1189,7 +1189,7 @@ ___ • **code**: *[RejectedCode](#enumeration-rejectedcode)* -*Defined in [types.ts:140](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L140)* +*Defined in [types.ts:140](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L140)* ___ @@ -1197,7 +1197,7 @@ ___ • **message**: *string* -*Defined in [types.ts:141](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L141)* +*Defined in [types.ts:141](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L141)*
@@ -1232,7 +1232,7 @@ ___ • **exchangeAddress**: *string* -*Defined in [types.ts:47](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L47)* ___ @@ -1240,7 +1240,7 @@ ___ • **expirationTimeSeconds**: *string* -*Defined in [types.ts:49](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L49)* ___ @@ -1248,7 +1248,7 @@ ___ • **feeRecipientAddress**: *string* -*Defined in [types.ts:48](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L48)* ___ @@ -1256,7 +1256,7 @@ ___ • **makerAddress**: *string* -*Defined in [types.ts:38](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L38)* ___ @@ -1264,7 +1264,7 @@ ___ • **makerAssetAmount**: *string* -*Defined in [types.ts:42](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L42)* ___ @@ -1272,7 +1272,7 @@ ___ • **makerAssetData**: *string* -*Defined in [types.ts:44](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L44)* +*Defined in [types.ts:44](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L44)* ___ @@ -1280,7 +1280,7 @@ ___ • **makerFee**: *string* -*Defined in [types.ts:40](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L40)* ___ @@ -1288,7 +1288,7 @@ ___ • **salt**: *string* -*Defined in [types.ts:46](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L46)* ___ @@ -1296,7 +1296,7 @@ ___ • **senderAddress**: *string* -*Defined in [types.ts:37](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L37)* ___ @@ -1304,7 +1304,7 @@ ___ • **signature**: *string* -*Defined in [types.ts:50](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L50)* ___ @@ -1312,7 +1312,7 @@ ___ • **takerAddress**: *string* -*Defined in [types.ts:39](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L39)* ___ @@ -1320,7 +1320,7 @@ ___ • **takerAssetAmount**: *string* -*Defined in [types.ts:43](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L43)* +*Defined in [types.ts:43](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L43)* ___ @@ -1328,7 +1328,7 @@ ___ • **takerAssetData**: *string* -*Defined in [types.ts:45](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L45)* ___ @@ -1336,7 +1336,7 @@ ___ • **takerFee**: *string* -*Defined in [types.ts:41](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L41)*
@@ -1359,7 +1359,7 @@ ___ • **accepted**: *[AcceptedOrderInfo](#interface-acceptedorderinfo)[]* -*Defined in [types.ts:164](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L164)* +*Defined in [types.ts:164](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L164)* ___ @@ -1367,7 +1367,7 @@ ___ • **rejected**: *[RejectedOrderInfo](#interface-rejectedorderinfo)[]* -*Defined in [types.ts:165](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L165)* +*Defined in [types.ts:165](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L165)*
@@ -1390,7 +1390,7 @@ ___ • **type**: *string* -*Defined in [types.ts:174](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L174)* +*Defined in [types.ts:174](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L174)* ___ @@ -1398,7 +1398,7 @@ ___ • **utf8Data**: *string* -*Defined in [types.ts:175](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L175)* +*Defined in [types.ts:175](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L175)*
@@ -1432,7 +1432,7 @@ reconnectAfter: time in milliseconds after which to attempt to reconnect to WS s • **clientConfig**? : *[ClientConfig](#interface-clientconfig)* -*Defined in [types.ts:32](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L32)* ___ @@ -1440,7 +1440,7 @@ ___ • **headers**? : *undefined | `__type`* -*Defined in [types.ts:30](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L30)* ___ @@ -1448,7 +1448,7 @@ ___ • **protocol**? : *undefined | string* -*Defined in [types.ts:31](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L31)* +*Defined in [types.ts:31](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L31)* ___ @@ -1456,7 +1456,7 @@ ___ • **reconnectAfter**? : *undefined | number* -*Defined in [types.ts:33](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L33)* +*Defined in [types.ts:33](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L33)* ___ @@ -1464,66 +1464,7 @@ ___ • **timeout**? : *undefined | number* -*Defined in [types.ts:29](https://github.com/0xProject/0x-mesh/blob/fd452af/rpc/clients/typescript/src/types.ts#L29)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [index](modules/_index_.md) - * [types](modules/_types_.md) - * [types.OrderEventKind](#class-ordereventkind) - * [types.RejectedCode](#class-rejectedcode) - * [types.RejectedKind](#class-rejectedkind) - * [types.AcceptedOrderInfo](#class-acceptedorderinfo) - * [types.ClientConfig](#class-clientconfig) - * [types.GetOrdersResponse](#class-getordersresponse) - * [types.GetStatsResponse](#class-getstatsresponse) - * [types.HeartbeatEventPayload](#class-heartbeateventpayload) - * [types.LatestBlock](#class-latestblock) - * [types.OrderEvent](#class-orderevent) - * [types.OrderEventPayload](#class-ordereventpayload) - * [types.OrderInfo](#class-orderinfo) - * [types.RawAcceptedOrderInfo](#class-rawacceptedorderinfo) - * [types.RawOrderEvent](#class-raworderevent) - * [types.RawOrderInfo](#class-raworderinfo) - * [types.RawRejectedOrderInfo](#class-rawrejectedorderinfo) - * [types.RawValidationResults](#class-rawvalidationresults) - * [types.RejectedOrderInfo](#class-rejectedorderinfo) - * [types.RejectedStatus](#class-rejectedstatus) - * [types.StringifiedSignedOrder](#class-stringifiedsignedorder) - * [types.ValidationResults](#class-validationresults) - * [types.WSMessage](#class-wsmessage) - * [types.WSOpts](#class-wsopts) - * [ws_client](modules/_ws_client_.md) - * [ws_client.WSClient](#class-wsclient) -* [Classes]() - * [ws_client.WSClient](#class-wsclient) -* [Enums]() - * [types.OrderEventKind](#class-ordereventkind) - * [types.RejectedCode](#class-rejectedcode) - * [types.RejectedKind](#class-rejectedkind) -* [Interfaces]() - * [types.AcceptedOrderInfo](#class-acceptedorderinfo) - * [types.ClientConfig](#class-clientconfig) - * [types.GetOrdersResponse](#class-getordersresponse) - * [types.GetStatsResponse](#class-getstatsresponse) - * [types.HeartbeatEventPayload](#class-heartbeateventpayload) - * [types.LatestBlock](#class-latestblock) - * [types.OrderEvent](#class-orderevent) - * [types.OrderEventPayload](#class-ordereventpayload) - * [types.OrderInfo](#class-orderinfo) - * [types.RawAcceptedOrderInfo](#class-rawacceptedorderinfo) - * [types.RawOrderEvent](#class-raworderevent) - * [types.RawOrderInfo](#class-raworderinfo) - * [types.RawRejectedOrderInfo](#class-rawrejectedorderinfo) - * [types.RawValidationResults](#class-rawvalidationresults) - * [types.RejectedOrderInfo](#class-rejectedorderinfo) - * [types.RejectedStatus](#class-rejectedstatus) - * [types.StringifiedSignedOrder](#class-stringifiedsignedorder) - * [types.ValidationResults](#class-validationresults) - * [types.WSMessage](#class-wsmessage) - * [types.WSOpts](#class-wsopts) +*Defined in [types.ts:29](https://github.com/0xProject/0x-mesh/blob/3c0943a/rpc/clients/typescript/src/types.ts#L29)*
diff --git a/rpc/clients/typescript/package.json b/rpc/clients/typescript/package.json index c2a05e940..8d581fd5c 100644 --- a/rpc/clients/typescript/package.json +++ b/rpc/clients/typescript/package.json @@ -21,7 +21,7 @@ "lint": "tslint --format stylish --project .", "test": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --exit", "s3:sync": "aws s3 sync ${npm_package_config_docsPath} s3://docs-markdown/${npm_package_name}/v${npm_package_version} --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers", - "docs:md": "ts-doc-gen --sourceDir=./src --output=${npm_package_config_docsPath}; yarn s3:sync" + "docs:md": "ts-doc-gen --sourceDir=./src --output=${npm_package_config_docsPath}" }, "config": { "docsPath": "../../../docs/json_rpc_clients/typescript" @@ -48,7 +48,7 @@ "websocket": "^1.0.29" }, "devDependencies": { - "@0x/ts-doc-gen": "^0.0.3", + "@0x/ts-doc-gen": "^0.0.7", "@0x/tslint-config": "^3.0.1", "@types/mocha": "^2.2.42", "@types/uuid": "^3.4.3", diff --git a/rpc/clients/typescript/yarn.lock b/rpc/clients/typescript/yarn.lock index dd7f36fc1..7baf735a4 100644 --- a/rpc/clients/typescript/yarn.lock +++ b/rpc/clients/typescript/yarn.lock @@ -128,10 +128,10 @@ optionalDependencies: "@ledgerhq/hw-transport-node-hid" "^4.3.0" -"@0x/ts-doc-gen@^0.0.3": - version "0.0.3" - resolved "https://registry.yarnpkg.com/@0x/ts-doc-gen/-/ts-doc-gen-0.0.3.tgz#460ffb10554f0491b8d9c92fa407e68b179e4b28" - integrity sha512-4UkL4u8BXOUkkL2++Ej4tWxkqaSGGykK+q6DaI2aWHahjr3GAcKSfCxFkjOW1pQvO2jdgbJWIg6vxBv8fEcQcA== +"@0x/ts-doc-gen@^0.0.7": + version "0.0.7" + resolved "https://registry.yarnpkg.com/@0x/ts-doc-gen/-/ts-doc-gen-0.0.7.tgz#1856870fcd182ebe5caa81b71bbd5d460228f3c9" + integrity sha512-sMclk5BiAt2DlnoevYxas7n+X38CTqIsyTvfpOED08g/Te7p2bwk0KEI4JeN5rOdpZAp4jJAkZGPsvzIVlEQdw== dependencies: "@0x/typescript-typings" "^4.2.2" "@0x/utils" "^4.3.3"