Class default

A collection of utility functions to help make life easier when developing strategies

Hierarchy

default

Constructors

constructor

new default(): default
Constructor. Takes no arguments.

Returns default
- Defined in resources/Utilities.ts:48

Methods

calculateGain

calculateGain(trade, priceField?): number
Calculates the gain for a given trade
Parameters
- trade: {}
  
  trade to calculate gain for
- priceField: string = "exitPrice"
  
  field to use for price, default is exitPrice
Returns number
- Defined in resources/Utilities.ts:318

calculateStoplossPercent

calculateStoplossPercent(stoplossPrice, currentPrice): number
Calculates the stoploss percent for a given stoploss price and current price
Parameters
- stoplossPrice: number
  
  stoploss price
- currentPrice: number
  
  current price
Returns number
- Defined in resources/Utilities.ts:307

calculateTargetPercent

calculateTargetPercent(targetPrice, currentPrice): number
Calculates the target percent for a given target price and current price
Parameters
- targetPrice: number
  
  target price
- currentPrice: number
  
  current price
Returns number
- Defined in resources/Utilities.ts:296

capitalize

capitalize(string): string
Capitalize a string - first letter uppercase, rest lowercase
Parameters
- string: string
  
  string to capitalize
Returns string
- Defined in resources/Utilities.ts:68

chunkizeArray

chunkizeArray(array, chunkSize): []
Splits up an array into chunks of a given size
Parameters
- array: []
  
  array to chunkize
- chunkSize: number
  
  size of chunks
Returns []
- Defined in resources/Utilities.ts:79

cleanBoolean

cleanBoolean(value): boolean
Converts common representations of true/false to boolean
Parameters
- value: any
  
  value to check
Returns boolean
- Defined in resources/Utilities.ts:136

countDecimals

countDecimals(number): number
Counts the number of decimals for a given number
Parameters
- number: any
  
  number to count decimals for
Returns number
- Defined in resources/Utilities.ts:284

decodeTradeSignature

decodeTradeSignature(signature): {
    exchangeId: string;
    interval: string;
    symbol: string;
}
Parameters
- signature: string
Returns {
    exchangeId: string;
    interval: string;
    symbol: string;
}
- exchangeId: string
- interval: string
- symbol: string
- Defined in resources/Utilities.ts:473

ensureAllCandles

ensureAllCandles(candles, interval, latestCandleTimestamp?): any
Ensure no gaps (aka missing candles). This method assumes candles supplied in ascending order with UNIX based second timestamps.
Parameters
- candles: any
  
  candles array to ensure no gaps for
- interval: string
  
  interval to ensure no gaps for
- latestCandleTimestamp: number = ...
  
  latest candle timestamp, default is now
Returns any
- Defined in resources/Utilities.ts:362

getCandlesCountSince

getCandlesCountSince(timestamp, interval): number
Gets the number of candles since a given timestamp
Parameters
- timestamp: number
  
  Unix timestamp (in seconds)
- interval: string
  
  interval to use
Returns number
- Defined in resources/Utilities.ts:211

getCreatedAtTimestampFromMongoId

getCreatedAtTimestampFromMongoId(_id): number
The creation timestamp is embedded in the mongoId
Parameters
- _id: ObjectId
  
  mongoId
Returns number
- Unix timestamp (in seconds)
- Defined in resources/Utilities.ts:97

getDirection

getDirection(trade): string
Gets the direction for a given trade, returns either "long" or "short"
Parameters
- trade: any
  
  trade to get direction for
Returns string
- Defined in resources/Utilities.ts:338

getIntervalStartTimestamp

getIntervalStartTimestamp(timestamp, timeframe): number
Gets the interval start timestamp for a given timestamp and timeframe, and returns it as a UNIX timestamp
Parameters
- timestamp: number
  
  timestamp to get interval start for
- timeframe: string
  
  timeframe to get interval start for
Returns number
- Defined in resources/Utilities.ts:446

getSince

getSince(interval, candlesCount): number
Parameters
- interval: string
- candlesCount: number
Returns number
- Defined in resources/Utilities.ts:174

getSymbolParts

getSymbolParts(symbol): {
baseAsset: string;
quoteAsset: string;
}
Split up the symbol into base and quote asset
Parameters
- symbol: string
  
  symbol to split up, e.g. BTC/USDT
Returns {
baseAsset: string;
quoteAsset: string;
}
- baseAsset: string
- quoteAsset: string
- Defined in resources/Utilities.ts:111

getTradeSignature

getTradeSignature(exchangeId, symbol, interval): string
Creates a trade signature from an exchange id, symbol and interval Format: exchangeId_symbol_interval. Use decodeTradeSignature() to decode
Parameters
- exchangeId: string
  
  exchange id
- symbol: string
  
  symbol
- interval: string
  
  interval
Returns string
- Defined in resources/Utilities.ts:464

intervalToSeconds

intervalToSeconds(interval): number
Converts an interval to seconds
Parameters
- interval: string
  
  interval to convert
Returns number
- Defined in resources/Utilities.ts:232

isNumeric

isNumeric(n): boolean
Parameters
- n: any
  
  number to check
Returns boolean
- Defined in resources/Utilities.ts:126

roundDecimalValue

roundDecimalValue(value, precision?): number
Rounds a decimal value to a given precision
Parameters
- value: number
  
  value to round
- precision: number = 0
  
  precision to use, default is 0, e.g. 2 decimal places
Returns number
- Defined in resources/Utilities.ts:271

sleep

sleep(waitingTime): Promise<void>
Sleep for a given amount of time
Parameters
- waitingTime: number
  
  in milliseconds
Returns Promise<void>
- Defined in resources/Utilities.ts:58

timestampToHuman

timestampToHuman(timestamp, format?): string
Converts a unix timestamp to a human readable format
Parameters
- timestamp: number
  
  Unix timestamp (in seconds)
- format: any = "YYYY-MM-DD HH:mm:ss (dddd) UTC"
  
  format to use for the output, defaults to "YYYY-MM-DD HH:mm:ss (dddd) UTC"
Returns string
- Defined in resources/Utilities.ts:161