Parameters:
diff --git a/docs/WSv2.html b/docs/WSv2.html index a2af9c3a..61e1020d 100644 --- a/docs/WSv2.html +++ b/docs/WSv2.html @@ -27,7 +27,7 @@
(constant)
Source:
(constant) W
Source:
(constant) WS
Source:
Returns:
- (async) cancelOrder(order) → {Promise}
+ cancelFundingOffer(payload)
@@ -1401,7 +1401,7 @@ (async) ca
Source:
(async) ca
See:
@@ -1448,9 +1452,9 @@ (async) ca
- Cancels an order by ID and resolves the returned promise once the cancel is
-confirmed. Emits an error if not authenticated. The ID can be passed as a
-number, or taken from an order array/object.
+ Cancels funding offer by ID. Emits an error if not authenticated.
+The ID can be passed as a number, key/value pair object literal,
+an instance of FundingOffer class or an array
@@ -1461,6 +1465,15 @@ (async) ca
+ Example
+
+ ws.cancelFundingOffer({ id: 1234 })
+
+ws.onFundingOfferClose({ symbol: 'fUSD' }, (resp) => {
+ console.log('Funding offer status: ', resp.status)
+})
+
+
Parameters:
@@ -1488,12 +1501,15 @@ Parameters:
- orderpayload
+FundingOffer
+|
+
object
|
@@ -1510,7 +1526,8 @@ Parameters:
- order model, array, or ID to be cancelled
funding offer model,
+array or ID to cancel
@@ -1530,30 +1547,20 @@ Parameters:
-
-
-Returns:
+Throws:
-
- p
-
-
+
+
+ an error if not authenticated
+
+
-
- -
- Type
-
- -
-
-Promise
+
-
-
-
@@ -1562,7 +1569,7 @@ Returns:
- (async) cancelOrders(orders) → {Promise}
+ (async) cancelOrder(order) → {Promise}
@@ -1574,7 +1581,7 @@ (async) c
Source:
(async) c
- Cancels multiple orders, returns a promise that resolves once all
-operations are confirmed.
+ Cancels an order by ID and resolves the returned promise once the cancel is
+confirmed. Emits an error if not authenticated. The ID can be passed as a
+number, or taken from an order array/object.
@@ -1660,19 +1668,19 @@ Parameters:
- ordersorder
-Array.<object>
+object
|
-Array.<Array>
+Array
|
-Array.<number>
+number
@@ -1682,8 +1690,7 @@ Parameters:
- array of order models, arrays
-or IDs to be cancelled
order model, array, or ID to be cancelled
@@ -1735,7 +1742,7 @@ Returns:
- (async) close(code, reason) → {Promise}
+ (async) cancelOrders(orders) → {Promise}
@@ -1747,7 +1754,7 @@ (async) closeSource:
(async) closeSee:
+
+
+ - WSv2#submitOrder
+
+
@@ -1787,8 +1801,8 @@ (async) close
- Closes the active connection. If there is none, rejects with a promise.
-Resolves on success
+ Cancels multiple orders, returns a promise that resolves once all
+operations are confirmed.
(constant) WS
Source:
Returns:
- (async) cancelOrder(order) → {Promise}
+ cancelFundingOffer(payload)
@@ -1401,7 +1401,7 @@ (async) ca
Source:
(async) ca
See:
@@ -1448,9 +1452,9 @@ (async) ca
- Cancels an order by ID and resolves the returned promise once the cancel is
-confirmed. Emits an error if not authenticated. The ID can be passed as a
-number, or taken from an order array/object.
+ Cancels funding offer by ID. Emits an error if not authenticated.
+The ID can be passed as a number, key/value pair object literal,
+an instance of FundingOffer class or an array
@@ -1461,6 +1465,15 @@ (async) ca
+ Example
+
+ ws.cancelFundingOffer({ id: 1234 })
+
+ws.onFundingOfferClose({ symbol: 'fUSD' }, (resp) => {
+ console.log('Funding offer status: ', resp.status)
+})
+
+
Parameters:
@@ -1488,12 +1501,15 @@ Parameters:
- orderpayload
+FundingOffer
+|
+
object
|
@@ -1510,7 +1526,8 @@ Parameters:
- order model, array, or ID to be cancelled
funding offer model,
+array or ID to cancel
@@ -1530,30 +1547,20 @@ Parameters:
-
-
-Returns:
+Throws:
-
- p
-
-
+
+
+ an error if not authenticated
+
+
-
- -
- Type
-
- -
-
-Promise
+
-
-
-
@@ -1562,7 +1569,7 @@ Returns:
- (async) cancelOrders(orders) → {Promise}
+ (async) cancelOrder(order) → {Promise}
@@ -1574,7 +1581,7 @@ (async) c
Source:
(async) c
- Cancels multiple orders, returns a promise that resolves once all
-operations are confirmed.
+ Cancels an order by ID and resolves the returned promise once the cancel is
+confirmed. Emits an error if not authenticated. The ID can be passed as a
+number, or taken from an order array/object.
@@ -1660,19 +1668,19 @@ Parameters:
- ordersorder
-Array.<object>
+object
|
-Array.<Array>
+Array
|
-Array.<number>
+number
@@ -1682,8 +1690,7 @@ Parameters:
- array of order models, arrays
-or IDs to be cancelled
order model, array, or ID to be cancelled
@@ -1735,7 +1742,7 @@ Returns:
- (async) close(code, reason) → {Promise}
+ (async) cancelOrders(orders) → {Promise}
@@ -1747,7 +1754,7 @@ (async) closeSource:
(async) closeSee:
+
+
+ - WSv2#submitOrder
+
+
@@ -1787,8 +1801,8 @@ (async) close
- Closes the active connection. If there is none, rejects with a promise.
-Resolves on success
+ Cancels multiple orders, returns a promise that resolves once all
+operations are confirmed.
(async) ca
See:
@@ -1448,9 +1452,9 @@ (async) ca
- Cancels an order by ID and resolves the returned promise once the cancel is
-confirmed. Emits an error if not authenticated. The ID can be passed as a
-number, or taken from an order array/object.
+ Cancels funding offer by ID. Emits an error if not authenticated.
+The ID can be passed as a number, key/value pair object literal,
+an instance of FundingOffer class or an array
@@ -1461,6 +1465,15 @@ (async) ca
+ Example
+
+ ws.cancelFundingOffer({ id: 1234 })
+
+ws.onFundingOfferClose({ symbol: 'fUSD' }, (resp) => {
+ console.log('Funding offer status: ', resp.status)
+})
+
+
Parameters:
@@ -1488,12 +1501,15 @@ Parameters:
- orderpayload
+FundingOffer
+|
+
object
|
@@ -1510,7 +1526,8 @@ Parameters:
- order model, array, or ID to be cancelled
funding offer model,
+array or ID to cancel
@@ -1530,30 +1547,20 @@ Parameters:
-
-
-Returns:
+Throws:
-
- p
-
-
+
+
+ an error if not authenticated
+
+
-
- -
- Type
-
- -
-
-Promise
+
-
-
-
@@ -1562,7 +1569,7 @@ Returns:
- (async) cancelOrders(orders) → {Promise}
+ (async) cancelOrder(order) → {Promise}
@@ -1574,7 +1581,7 @@ (async) c
Source:
(async) c
- Cancels multiple orders, returns a promise that resolves once all
-operations are confirmed.
+ Cancels an order by ID and resolves the returned promise once the cancel is
+confirmed. Emits an error if not authenticated. The ID can be passed as a
+number, or taken from an order array/object.
@@ -1660,19 +1668,19 @@ Parameters:
- ordersorder
-Array.<object>
+object
|
-Array.<Array>
+Array
|
-Array.<number>
+number
@@ -1682,8 +1690,7 @@ Parameters:
- array of order models, arrays
-or IDs to be cancelled
order model, array, or ID to be cancelled
@@ -1735,7 +1742,7 @@ Returns:
- (async) close(code, reason) → {Promise}
+ (async) cancelOrders(orders) → {Promise}
@@ -1747,7 +1754,7 @@ (async) closeSource:
(async) closeSee:
+
+
+ - WSv2#submitOrder
+
+
@@ -1787,8 +1801,8 @@ (async) close
- Closes the active connection. If there is none, rejects with a promise.
-Resolves on success
+ Cancels multiple orders, returns a promise that resolves once all
+operations are confirmed.
Cancels an order by ID and resolves the returned promise once the cancel is -confirmed. Emits an error if not authenticated. The ID can be passed as a -number, or taken from an order array/object.
+Cancels funding offer by ID. Emits an error if not authenticated. +The ID can be passed as a number, key/value pair object literal, +an instance of FundingOffer class or an array
(async) ca
+ Example
+
+ ws.cancelFundingOffer({ id: 1234 })
+
+ws.onFundingOfferClose({ symbol: 'fUSD' }, (resp) => {
+ console.log('Funding offer status: ', resp.status)
+})
+
+
Parameters:
@@ -1488,12 +1501,15 @@ Parameters:
- orderpayload
+FundingOffer
+|
+
object
|
@@ -1510,7 +1526,8 @@ Parameters:
- order model, array, or ID to be cancelled
funding offer model,
+array or ID to cancel
@@ -1530,30 +1547,20 @@ Parameters:
-
-
-Returns:
+Throws:
-
- p
-
-
+
+
+ an error if not authenticated
+
+
-
- -
- Type
-
- -
-
-Promise
+
-
-
-
@@ -1562,7 +1569,7 @@ Returns:
- (async) cancelOrders(orders) → {Promise}
+ (async) cancelOrder(order) → {Promise}
@@ -1574,7 +1581,7 @@ (async) c
Source:
(async) c
- Cancels multiple orders, returns a promise that resolves once all
-operations are confirmed.
+ Cancels an order by ID and resolves the returned promise once the cancel is
+confirmed. Emits an error if not authenticated. The ID can be passed as a
+number, or taken from an order array/object.
@@ -1660,19 +1668,19 @@ Parameters:
- ordersorder
-Array.<object>
+object
|
-Array.<Array>
+Array
|
-Array.<number>
+number
@@ -1682,8 +1690,7 @@ Parameters:
- array of order models, arrays
-or IDs to be cancelled
order model, array, or ID to be cancelled
@@ -1735,7 +1742,7 @@ Returns:
- (async) close(code, reason) → {Promise}
+ (async) cancelOrders(orders) → {Promise}
@@ -1747,7 +1754,7 @@ (async) closeSource:
(async) closeSee:
+
+
+ - WSv2#submitOrder
+
+
@@ -1787,8 +1801,8 @@ (async) close
- Closes the active connection. If there is none, rejects with a promise.
-Resolves on success
+ Cancels multiple orders, returns a promise that resolves once all
+operations are confirmed.
ws.cancelFundingOffer({ id: 1234 })
+
+ws.onFundingOfferClose({ symbol: 'fUSD' }, (resp) => {
+ console.log('Funding offer status: ', resp.status)
+})orderpayloadParameters:
-order model, array, or ID to be cancelled
funding offer model, +array or ID to cancel
p
-an error if not authenticated
+ +(async) c
- Cancels multiple orders, returns a promise that resolves once all
-operations are confirmed.
+ Cancels an order by ID and resolves the returned promise once the cancel is
+confirmed. Emits an error if not authenticated. The ID can be passed as a
+number, or taken from an order array/object.
@@ -1660,19 +1668,19 @@ Parameters:
- ordersorder
-Array.<object>
+object
|
-Array.<Array>
+Array
|
-Array.<number>
+number
@@ -1682,8 +1690,7 @@ Parameters:
- array of order models, arrays
-or IDs to be cancelled
order model, array, or ID to be cancelled
@@ -1735,7 +1742,7 @@ Returns:
- (async) close(code, reason) → {Promise}
+ (async) cancelOrders(orders) → {Promise}
@@ -1747,7 +1754,7 @@ (async) closeSource:
(async) closeSee:
+
+
+ - WSv2#submitOrder
+
+
@@ -1787,8 +1801,8 @@ (async) close
- Closes the active connection. If there is none, rejects with a promise.
-Resolves on success
+ Cancels multiple orders, returns a promise that resolves once all
+operations are confirmed.
Cancels multiple orders, returns a promise that resolves once all -operations are confirmed.
+Cancels an order by ID and resolves the returned promise once the cancel is +confirmed. Emits an error if not authenticated. The ID can be passed as a +number, or taken from an order array/object.
ordersorderParameters:
-array of order models, arrays -or IDs to be cancelled
order model, array, or ID to be cancelled
(async) closeSee:
+
+
+ - WSv2#submitOrder
+
+
@@ -1787,8 +1801,8 @@ (async) close
- Closes the active connection. If there is none, rejects with a promise.
-Resolves on success
+ Cancels multiple orders, returns a promise that resolves once all
+operations are confirmed.
-
+
- WSv2#submitOrder +
(async) close
- Closes the active connection. If there is none, rejects with a promise.
-Resolves on success
+ Cancels multiple orders, returns a promise that resolves once all
+operations are confirmed.
Closes the active connection. If there is none, rejects with a promise. -Resolves on success
+Cancels multiple orders, returns a promise that resolves once all +operations are confirmed.
Parameters:
codeorderspassed to ws
reasonParameters:
-passed to ws
array of order models, arrays +or IDs to be cancelled
Returns:
-(async) enableFlag(flag) → {Promise}
+(async) close(code, reason) → {Promise}
@@ -1929,7 +1927,7 @@(async) ena
Source:
(async) ena
-
- See:
-
-
- - WSv2#flags
-
-
@@ -1976,7 +1967,8 @@ (async) ena
- Enables a configuration flag.
+ Closes the active connection. If there is none, rejects with a promise.
+Resolves on success
@@ -1987,18 +1979,6 @@ (async) ena
- Example
-
- const ws = new WSv2()
-
-ws.on('open', async () => {
- await ws.enableFlag(WSv2.flags.CHECKSUM)
- console.log('ob checkums enabled')
-})
-
-await ws.open()
-
-
Parameters:
@@ -2026,7 +2006,7 @@ Parameters:
- flagcode
@@ -2042,7 +2022,30 @@ Parameters:
- flag to update, as numeric value
passed to ws
+
+
+
+
+
+ reason
+
+
+string
+
+
+
+
+
+
+
+
+
+ passed to ws
@@ -2094,7 +2097,7 @@ Returns:
- (async) enableSequencing(args) → {Promise}
+ closeFundingCredit(payload)
@@ -2106,7 +2109,7 @@ (async) Source:
(async) See:
- - WSv2#flags
+ - WSv2#submitFundingOffer
+
+ - WSv2#cancelFundingOffer
+
+ - WSv2#closeFundingLoan
@@ -2153,9 +2160,9 @@ (async)
- Configures the seq flag to enable sequencing (packet number) for this
-connection. When enabled, the seq number will be the last value of
-channel packet arrays.
+ Cancels funding credit by ID. Emits an error if not authenticated.
+The ID can be passed as a number, key/value pair object literal,
+an instance of FundingCredit class or an array
-
-
- WSv2#flags -
(async) ena
- Enables a configuration flag.
+ Closes the active connection. If there is none, rejects with a promise.
+Resolves on success
@@ -1987,18 +1979,6 @@ (async) ena
- Example
-
- const ws = new WSv2()
-
-ws.on('open', async () => {
- await ws.enableFlag(WSv2.flags.CHECKSUM)
- console.log('ob checkums enabled')
-})
-
-await ws.open()
-
-
Parameters:
@@ -2026,7 +2006,7 @@ Parameters:
- flagcode
@@ -2042,7 +2022,30 @@ Parameters:
- flag to update, as numeric value
passed to ws
+
+
+
+
+
+ reason
+
+
+string
+
+
+
+
+
+
+
+
+
+ passed to ws
@@ -2094,7 +2097,7 @@ Returns:
- (async) enableSequencing(args) → {Promise}
+ closeFundingCredit(payload)
@@ -2106,7 +2109,7 @@ (async) Source:
(async) See:
- - WSv2#flags
+ - WSv2#submitFundingOffer
+
+ - WSv2#cancelFundingOffer
+
+ - WSv2#closeFundingLoan
@@ -2153,9 +2160,9 @@ (async)
- Configures the seq flag to enable sequencing (packet number) for this
-connection. When enabled, the seq number will be the last value of
-channel packet arrays.
+ Cancels funding credit by ID. Emits an error if not authenticated.
+The ID can be passed as a number, key/value pair object literal,
+an instance of FundingCredit class or an array
Enables a configuration flag.
+Closes the active connection. If there is none, rejects with a promise. +Resolves on success
Example
- -const ws = new WSv2()
-
-ws.on('open', async () => {
- await ws.enableFlag(WSv2.flags.CHECKSUM)
- console.log('ob checkums enabled')
-})
-
-await ws.open()Parameters:
@@ -2026,7 +2006,7 @@Parameters:
flagcodeParameters:
-flag to update, as numeric value
passed to ws
reasonpassed to ws
Returns:
-(async) enableSequencing(args) → {Promise}
+closeFundingCredit(payload)
@@ -2106,7 +2109,7 @@(async) Source:
(async) See:
- - WSv2#flags
+ - WSv2#submitFundingOffer
+
+ - WSv2#cancelFundingOffer
+
+ - WSv2#closeFundingLoan
@@ -2153,9 +2160,9 @@ (async)
- Configures the seq flag to enable sequencing (packet number) for this
-connection. When enabled, the seq number will be the last value of
-channel packet arrays.
+ Cancels funding credit by ID. Emits an error if not authenticated.
+The ID can be passed as a number, key/value pair object literal,
+an instance of FundingCredit class or an array
-
-
- WSv2#flags +
- WSv2#submitFundingOffer + +
- WSv2#cancelFundingOffer + +
- WSv2#closeFundingLoan