diff options
author | Brandon Millman <brandon@0xproject.com> | 2017-12-13 02:23:17 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-12-13 02:23:17 +0800 |
commit | caeb5cb6ab2b578e7f18667bdc9f2852876b4fe7 (patch) | |
tree | fc48c8035b51064c3c053203bfe919942928e51c | |
parent | 4f72c527def4adef60200b60f9bf6221956af7a3 (diff) | |
parent | d1fb61e0def4ccb491fc27bdf6394634e6c15768 (diff) | |
download | dexon-0x-contracts-caeb5cb6ab2b578e7f18667bdc9f2852876b4fe7.tar.gz dexon-0x-contracts-caeb5cb6ab2b578e7f18667bdc9f2852876b4fe7.tar.zst dexon-0x-contracts-caeb5cb6ab2b578e7f18667bdc9f2852876b4fe7.zip |
Merge pull request #261 from 0xProject/feature/addWebSocketDocs
Add WebSocketOrderbookChannel to connect docs
-rw-r--r-- | packages/website/ts/containers/connect_documentation.tsx | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/packages/website/ts/containers/connect_documentation.tsx b/packages/website/ts/containers/connect_documentation.tsx index b074d955b..8ecc1e37c 100644 --- a/packages/website/ts/containers/connect_documentation.tsx +++ b/packages/website/ts/containers/connect_documentation.tsx @@ -23,6 +23,7 @@ const connectDocSections = { introduction: 'introduction', installation: 'installation', httpClient: 'httpClient', + webSocketOrderbookChannel: 'webSocketOrderbookChannel', types: 'types', }; @@ -42,6 +43,9 @@ const docsInfoConfig: DocsInfoConfig = { httpClient: [ connectDocSections.httpClient, ], + webSocketOrderbookChannel: [ + connectDocSections.webSocketOrderbookChannel, + ], types: [ connectDocSections.types, ], @@ -56,6 +60,9 @@ const docsInfoConfig: DocsInfoConfig = { 'Client', 'FeesRequest', 'FeesResponse', + 'OrderbookChannel', + 'OrderbookChannelHandler', + 'OrderbookChannelSubscriptionOpts', 'OrderbookRequest', 'OrderbookResponse', 'OrdersRequest', @@ -64,14 +71,19 @@ const docsInfoConfig: DocsInfoConfig = { 'TokenTradeInfo', 'Order', 'SignedOrder', + 'ECSignature', ], sectionNameToModulePath: { [connectDocSections.httpClient]: ['"src/http_client"'], + [connectDocSections.webSocketOrderbookChannel]: ['"src/ws_orderbook_channel"'], [connectDocSections.types]: ['"src/types"'], }, menuSubsectionToVersionWhenIntroduced: {}, sections: connectDocSections, - visibleConstructors: [connectDocSections.httpClient], + visibleConstructors: [ + connectDocSections.httpClient, + connectDocSections.webSocketOrderbookChannel, + ], convertToDocAgnosticFormatFn: typeDocUtils.convertToDocAgnosticFormat.bind(typeDocUtils), }; const docsInfo = new DocsInfo(docsInfoConfig); |