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

Add WebSocketOrderbookChannel to connect docs
This commit is contained in:
Brandon Millman
2017-12-12 10:23:17 -08:00
committed by GitHub

View File

@@ -23,6 +23,7 @@ const connectDocSections = {
introduction: 'introduction', introduction: 'introduction',
installation: 'installation', installation: 'installation',
httpClient: 'httpClient', httpClient: 'httpClient',
webSocketOrderbookChannel: 'webSocketOrderbookChannel',
types: 'types', types: 'types',
}; };
@@ -42,6 +43,9 @@ const docsInfoConfig: DocsInfoConfig = {
httpClient: [ httpClient: [
connectDocSections.httpClient, connectDocSections.httpClient,
], ],
webSocketOrderbookChannel: [
connectDocSections.webSocketOrderbookChannel,
],
types: [ types: [
connectDocSections.types, connectDocSections.types,
], ],
@@ -56,6 +60,9 @@ const docsInfoConfig: DocsInfoConfig = {
'Client', 'Client',
'FeesRequest', 'FeesRequest',
'FeesResponse', 'FeesResponse',
'OrderbookChannel',
'OrderbookChannelHandler',
'OrderbookChannelSubscriptionOpts',
'OrderbookRequest', 'OrderbookRequest',
'OrderbookResponse', 'OrderbookResponse',
'OrdersRequest', 'OrdersRequest',
@@ -64,14 +71,19 @@ const docsInfoConfig: DocsInfoConfig = {
'TokenTradeInfo', 'TokenTradeInfo',
'Order', 'Order',
'SignedOrder', 'SignedOrder',
'ECSignature',
], ],
sectionNameToModulePath: { sectionNameToModulePath: {
[connectDocSections.httpClient]: ['"src/http_client"'], [connectDocSections.httpClient]: ['"src/http_client"'],
[connectDocSections.webSocketOrderbookChannel]: ['"src/ws_orderbook_channel"'],
[connectDocSections.types]: ['"src/types"'], [connectDocSections.types]: ['"src/types"'],
}, },
menuSubsectionToVersionWhenIntroduced: {}, menuSubsectionToVersionWhenIntroduced: {},
sections: connectDocSections, sections: connectDocSections,
visibleConstructors: [connectDocSections.httpClient], visibleConstructors: [
connectDocSections.httpClient,
connectDocSections.webSocketOrderbookChannel,
],
convertToDocAgnosticFormatFn: typeDocUtils.convertToDocAgnosticFormat.bind(typeDocUtils), convertToDocAgnosticFormatFn: typeDocUtils.convertToDocAgnosticFormat.bind(typeDocUtils),
}; };
const docsInfo = new DocsInfo(docsInfoConfig); const docsInfo = new DocsInfo(docsInfoConfig);