Skip to content

Commit c77d0d4

Browse files
committed
update docs
1 parent adcbda3 commit c77d0d4

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/jsdoc.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
* [.multiSend(fromAddress, outputs, memo, sequence)](#module_client.BncClient+multiSend) ⇒ <code>Promise</code>
6262
* [.cancelOrder(fromAddress, symbol, refid, sequence)](#module_client.BncClient+cancelOrder) ⇒ <code>Promise</code>
6363
* [.placeOrder(address, symbol, side, price, quantity, sequence, timeinforce)](#module_client.BncClient+placeOrder) ⇒ <code>Promise</code>
64+
* [.list(address, proposalId, baseAsset, quoteAsset, initPrice, sequence)](#module_client.BncClient+list) ⇒ <code>Promise</code>
6465
* [._prepareTransaction(msg, stdSignMsg, address, sequence, memo)](#module_client.BncClient+_prepareTransaction)[<code>Transaction</code>](#Transaction)
6566
* [.sendTransaction(tx, sync)](#module_client.BncClient+sendTransaction) ⇒ <code>Promise</code>
6667
* [.sendRawTransaction(signedBz, sync)](#module_client.BncClient+sendRawTransaction) ⇒ <code>Promise</code>
@@ -105,6 +106,7 @@ The Binance Chain client.
105106
* [.multiSend(fromAddress, outputs, memo, sequence)](#module_client.BncClient+multiSend) ⇒ <code>Promise</code>
106107
* [.cancelOrder(fromAddress, symbol, refid, sequence)](#module_client.BncClient+cancelOrder) ⇒ <code>Promise</code>
107108
* [.placeOrder(address, symbol, side, price, quantity, sequence, timeinforce)](#module_client.BncClient+placeOrder) ⇒ <code>Promise</code>
109+
* [.list(address, proposalId, baseAsset, quoteAsset, initPrice, sequence)](#module_client.BncClient+list) ⇒ <code>Promise</code>
108110
* [._prepareTransaction(msg, stdSignMsg, address, sequence, memo)](#module_client.BncClient+_prepareTransaction)[<code>Transaction</code>](#Transaction)
109111
* [.sendTransaction(tx, sync)](#module_client.BncClient+sendTransaction) ⇒ <code>Promise</code>
110112
* [.sendRawTransaction(signedBz, sync)](#module_client.BncClient+sendRawTransaction) ⇒ <code>Promise</code>
@@ -307,6 +309,21 @@ Place an order.
307309
| sequence | <code>Number</code> | <code></code> | optional sequence |
308310
| timeinforce | <code>Number</code> | <code>1</code> | (1-GTC(Good Till Expire), 3-IOC(Immediate or Cancel)) |
309311

312+
<a name="module_client.BncClient+list"></a>
313+
314+
#### bncClient.list(address, proposalId, baseAsset, quoteAsset, initPrice, sequence) ⇒ <code>Promise</code>
315+
**Kind**: instance method of [<code>BncClient</code>](#module_client.BncClient)
316+
**Returns**: <code>Promise</code> - resolves with response (success or fail)
317+
318+
| Param | Type | Default | Description |
319+
| --- | --- | --- | --- |
320+
| address | <code>String</code> | | |
321+
| proposalId | <code>Number</code> | | |
322+
| baseAsset | <code>String</code> | | |
323+
| quoteAsset | <code>String</code> | | |
324+
| initPrice | <code>Number</code> | | |
325+
| sequence | <code>Number</code> | <code></code> | optional sequence |
326+
310327
<a name="module_client.BncClient+_prepareTransaction"></a>
311328

312329
#### bncClient.\_prepareTransaction(msg, stdSignMsg, address, sequence, memo) ⇒ [<code>Transaction</code>](#Transaction)

0 commit comments

Comments
 (0)