Skip to content

Commit 341f677

Browse files
authored
fix(docs): fix htx docs, fix ccxt#25044 (ccxt#25051)
1 parent c31eab4 commit 341f677

File tree

5 files changed

+9
-38
lines changed

5 files changed

+9
-38
lines changed

js/src/hitbtc3.d.ts

Lines changed: 0 additions & 8 deletions
This file was deleted.

js/src/hitbtc3.js

Lines changed: 0 additions & 20 deletions
This file was deleted.

jsdoc2md.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,6 @@ console.log ('📰 rendering docs for each exchange...')
5858
const template = fs.readFileSync ('./wiki/spec.hbs', 'utf8')
5959

6060
const outputByExchange = await Promise.all (templateData.map (data => jsdoc2md.render ({ template, data, partial: exchangePartial, helper })))
61-
//const outputByExchange = await jsdoc2md.render ({ template, data: templateData[5], partial: exchangePartial, helper })
6261
// Group docs by method
6362
const groupedByMethod = templateData.reduce((acc, arr) => {
6463
arr.filter(obj => obj.kind === 'function' && !obj.ignore).forEach(obj => {

ts/src/htx.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import type { TransferEntry, Int, OrderSide, OrderType, Order, OHLCV, Trade, Fun
1111
// ---------------------------------------------------------------------------
1212

1313
/**
14-
* @class huobi
14+
* @class htx
1515
* @augments Exchange
1616
*/
1717
export default class htx extends Exchange {

ts/src/pro/htx.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ export default class htx extends htxRest {
134134

135135
/**
136136
* @method
137-
* @name huobi#watchTicker
137+
* @name htx#watchTicker
138138
* @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
139139
* @see https://www.htx.com/en-us/opend/newApiPages/?id=7ec53561-7773-11ed-9966-0242ac110003
140140
* @see https://www.htx.com/en-us/opend/newApiPages/?id=28c33ab2-77ae-11ed-9966-0242ac110003
@@ -206,7 +206,7 @@ export default class htx extends htxRest {
206206

207207
/**
208208
* @method
209-
* @name huobi#watchTrades
209+
* @name htx#watchTrades
210210
* @description get the list of most recent trades for a particular symbol
211211
* @see https://www.htx.com/en-us/opend/newApiPages/?id=7ec53b69-7773-11ed-9966-0242ac110003
212212
* @see https://www.htx.com/en-us/opend/newApiPages/?id=28c33c21-77ae-11ed-9966-0242ac110003
@@ -274,7 +274,7 @@ export default class htx extends htxRest {
274274

275275
/**
276276
* @method
277-
* @name huobi#watchOHLCV
277+
* @name htx#watchOHLCV
278278
* @description watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
279279
* @see https://www.htx.com/en-us/opend/newApiPages/?id=7ec53241-7773-11ed-9966-0242ac110003
280280
* @see https://www.htx.com/en-us/opend/newApiPages/?id=28c3346a-77ae-11ed-9966-0242ac110003
@@ -339,7 +339,7 @@ export default class htx extends htxRest {
339339

340340
/**
341341
* @method
342-
* @name huobi#watchOrderBook
342+
* @name htx#watchOrderBook
343343
* @see https://huobiapi.github.io/docs/dm/v1/en/#subscribe-market-depth-data
344344
* @see https://huobiapi.github.io/docs/coin_margined_swap/v1/en/#subscribe-incremental-market-depth-data
345345
* @see https://huobiapi.github.io/docs/usdt_swap/v1/en/#general-subscribe-incremental-market-depth-data
@@ -687,7 +687,7 @@ export default class htx extends htxRest {
687687

688688
/**
689689
* @method
690-
* @name huobi#watchMyTrades
690+
* @name htx#watchMyTrades
691691
* @description watches information on multiple trades made by the user
692692
* @see https://www.htx.com/en-us/opend/newApiPages/?id=7ec53dd5-7773-11ed-9966-0242ac110003
693693
* @param {string} symbol unified market symbol of the market trades were made in
@@ -786,7 +786,7 @@ export default class htx extends htxRest {
786786

787787
/**
788788
* @method
789-
* @name huobi#watchOrders
789+
* @name htx#watchOrders
790790
* @description watches information on multiple orders made by the user
791791
* @see https://www.htx.com/en-us/opend/newApiPages/?id=7ec53c8f-7773-11ed-9966-0242ac110003
792792
* @param {string} symbol unified market symbol of the market orders were made in
@@ -1240,7 +1240,7 @@ export default class htx extends htxRest {
12401240

12411241
/**
12421242
* @method
1243-
* @name huobi#watchPositions
1243+
* @name htx#watchPositions
12441244
* @see https://www.huobi.com/en-in/opend/newApiPages/?id=8cb7de1c-77b5-11ed-9966-0242ac110003
12451245
* @see https://www.huobi.com/en-in/opend/newApiPages/?id=8cb7df0f-77b5-11ed-9966-0242ac110003
12461246
* @see https://www.huobi.com/en-in/opend/newApiPages/?id=28c34a7d-77ae-11ed-9966-0242ac110003
@@ -1364,7 +1364,7 @@ export default class htx extends htxRest {
13641364

13651365
/**
13661366
* @method
1367-
* @name huobi#watchBalance
1367+
* @name htx#watchBalance
13681368
* @description watch balance and get the amount of funds available for trading or funds locked in orders
13691369
* @see https://www.htx.com/en-us/opend/newApiPages/?id=7ec52e28-7773-11ed-9966-0242ac110003
13701370
* @see https://www.htx.com/en-us/opend/newApiPages/?id=10000084-77b7-11ed-9966-0242ac110003

0 commit comments

Comments
 (0)