aboutsummaryrefslogtreecommitdiffstats
path: root/packages/connect
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-04-18 17:19:27 +0800
committerGitHub <noreply@github.com>2018-04-18 17:19:27 +0800
commitf6f2991a442da156a3dbdeca84683a6c9f46d0e1 (patch)
tree4951024bfba56d5c3268556c4d4e2ca0ab4f6d17 /packages/connect
parent823f2db09fba8f19806ba3fa4bd679e12a58be3f (diff)
parent4ea222bbffd7a378712320a2f366d5bbee5920af (diff)
downloaddexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar
dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar.gz
dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar.bz2
dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar.lz
dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar.xz
dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.tar.zst
dexon-sol-tools-f6f2991a442da156a3dbdeca84683a6c9f46d0e1.zip
Merge pull request #535 from 0xProject/fix/commentRendering
Docs: Fix Type Comment Rendering
Diffstat (limited to 'packages/connect')
-rw-r--r--packages/connect/src/types.ts4
1 files changed, 2 insertions, 2 deletions
diff --git a/packages/connect/src/types.ts b/packages/connect/src/types.ts
index 5c344e328..b0467f22a 100644
--- a/packages/connect/src/types.ts
+++ b/packages/connect/src/types.ts
@@ -15,14 +15,14 @@ export interface OrderbookChannel {
close: () => void;
}
-/*
+/**
* heartbeatInterval: Interval in milliseconds that the orderbook channel should ping the underlying websocket. Default: 15000
*/
export interface WebSocketOrderbookChannelConfig {
heartbeatIntervalMs?: number;
}
-/*
+/**
* baseTokenAddress: The address of token designated as the baseToken in the currency pair calculation of price
* quoteTokenAddress: The address of token designated as the quoteToken in the currency pair calculation of price
* snapshot: If true, a snapshot of the orderbook will be sent before the updates to the orderbook