crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #261 from 0xProject/feature/addWebSocketDocs

Browse Source 
Add WebSocketOrderbookChannel to connect docs
This commit is contained in:
Brandon Millman 2017-12-12 10:23:17 -08:00 committed by GitHub
commit caeb5cb6ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
packages/website/ts/containers/connect_documentation.tsx
View File

@ -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);