Skip to main content

Class: CoinrayCache

Defined in: coinray-cache.ts:24

Extends​

  • default

Constructors​

Constructor​

new CoinrayCache(token, config, refreshRate?, cachePrams?): CoinrayCache

Defined in: coinray-cache.ts:61

Parameters​

token​

string

config​

any

refreshRate?​

number = ...

cachePrams?​

CacheParams = undefined

Returns​

CoinrayCache

Overrides​

EventEmitter.constructor

Properties​

initialized​

initialized: boolean

Defined in: coinray-cache.ts:28

listeners​

listeners: object

Defined in: event-emitter.ts:2

Inherited from​

EventEmitter.listeners

refreshRate​

refreshRate: number

Defined in: coinray-cache.ts:29

Methods​

apiForSymbol()​

apiForSymbol(coinraySymbol): default

Defined in: coinray-cache.ts:647

Parameters​

coinraySymbol​

string

Returns​

default

authenticateDevice()​

authenticateDevice(credential, sessionKey): void

Defined in: coinray-cache.ts:90

Parameters​

credential​

string

sessionKey​

string

Returns​

void

destroy()​

destroy(): void

Defined in: coinray-cache.ts:165

Returns​

void

dispatchEvent()​

dispatchEvent(eventName, data?): void

Defined in: event-emitter.ts:35

Parameters​

eventName​

any

data?​

Returns​

void

Inherited from​

EventEmitter.dispatchEvent

ensureFresh()​

ensureFresh(symbolsOrCodes): Promise<void>

Defined in: coinray-cache.ts:242

Parameters​

symbolsOrCodes​

string | string[]

Returns​

Promise<void>

fetchCandles()​

fetchCandles(__namedParameters): Promise<Candle[]>

Defined in: coinray-cache.ts:521

Parameters​

__namedParameters​

CandlesParam

Returns​

Promise<Candle[]>

fetchFirstCandleTime()​

fetchFirstCandleTime(__namedParameters): Promise<Date>

Defined in: coinray-cache.ts:526

Parameters​

__namedParameters​

CandlesParam

Returns​

Promise<Date>

flushTickerSubscriptions()​

flushTickerSubscriptions(): Promise<void>

Defined in: coinray-cache.ts:557

Returns​

Promise<void>

getActiveExchanges()​

getActiveExchanges(): string[]

Defined in: coinray-cache.ts:253

Returns​

string[]

getExchange()​

getExchange(exchangeCode): Exchange

Defined in: coinray-cache.ts:454

Parameters​

exchangeCode​

any

Returns​

Exchange

getExchanges()​

getExchanges(): ExchangeMap

Defined in: coinray-cache.ts:447

Returns​

ExchangeMap

getMarket()​

getMarket(coinraySymbol): Market

Defined in: coinray-cache.ts:510

Parameters​

coinraySymbol​

string

Returns​

Market

getMarkets()​

getMarkets(codeOrSymbols): MarketMap

Defined in: coinray-cache.ts:493

Parameters​

codeOrSymbols​

string | string[]

Returns​

MarketMap

getProxyList()​

getProxyList(params?): Promise<any>

Defined in: coinray-cache.ts:443

Parameters​

params?​

Returns​

Promise<any>

getRootApi()​

getRootApi(): default

Defined in: coinray-cache.ts:86

Returns​

default

hasListeners()​

hasListeners(type): boolean

Defined in: event-emitter.ts:31

Parameters​

type​

any

Returns​

boolean

Inherited from​

EventEmitter.hasListeners

initialize()​

initialize(): Promise<void>

Defined in: coinray-cache.ts:77

Returns​

Promise<void>

off()​

off(type, callback): void

Defined in: event-emitter.ts:20

Parameters​

type​

any

callback​

any

Returns​

void

Inherited from​

EventEmitter.off

on()​

on(type, callback): any

Defined in: event-emitter.ts:12

Parameters​

type​

any

callback​

any

Returns​

any

Inherited from​

EventEmitter.on

onTokenExpired()​

onTokenExpired(callback): void

Defined in: coinray-cache.ts:112

Parameters​

callback​

() => Promise<string>

Returns​

void

refreshExchanges()​

refreshExchanges(apiCache?): Promise<void>

Defined in: coinray-cache.ts:183

Parameters​

apiCache?​

any = undefined

Returns​

Promise<void>

refreshMarkets()​

refreshMarkets(exchangeCode): Promise<void>

Defined in: coinray-cache.ts:474

Parameters​

exchangeCode​

string

Returns​

Promise<void>

refreshMarketsFromTickers()​

refreshMarketsFromTickers(payload): Promise<void>

Defined in: coinray-cache.ts:593

Parameters​

payload​

any

Returns​

Promise<void>

refreshToken()​

refreshToken(): Promise<any>

Defined in: coinray-cache.ts:94

Returns​

Promise<any>

removeAllListeners()​

removeAllListeners(): void

Defined in: event-emitter.ts:8

Returns​

void

Inherited from​

EventEmitter.removeAllListeners

retainLiveMarket()​

retainLiveMarket(coinraySymbol): () => void

Defined in: coinray-cache.ts:258

Parameters​

coinraySymbol​

string

Returns​

() => void

scheduleTickerRefresh()​

scheduleTickerRefresh(): void

Defined in: coinray-cache.ts:536

Returns​

void

searchMarkets()​

searchMarkets(marketQuery): MarketMap

Defined in: coinray-cache.ts:486

Parameters​

marketQuery​

string | MarketQuery | MarketQuery[]

Returns​

MarketMap

setActiveExchanges()​

setActiveExchanges(exchangeCodes): void

Defined in: coinray-cache.ts:217

Parameters​

exchangeCodes​

string[]

Returns​

void

start()​

start(): Promise<void>

Defined in: coinray-cache.ts:116

Returns​

Promise<void>

subscribeCandles()​

subscribeCandles(__namedParameters, callback): Promise<(payload) => void>

Defined in: coinray-cache.ts:613

Parameters​

__namedParameters​

CandleParam

callback​

(payload) => void

Returns​

Promise<(payload) => void>

subscribeOrderBook()​

subscribeOrderBook(__namedParameters, callback): Promise<void>

Defined in: coinray-cache.ts:627

Parameters​

__namedParameters​

MarketParam

callback​

(payload) => void

Returns​

Promise<void>

subscribeTickers()​

subscribeTickers(listenerId, coinraySymbols, resetExisting?): void

Defined in: coinray-cache.ts:531

Parameters​

listenerId​

string

coinraySymbols​

string[]

resetExisting?​

boolean = false

Returns​

void

subscribeTrades()​

subscribeTrades(__namedParameters, callback): Promise<void>

Defined in: coinray-cache.ts:637

Parameters​

__namedParameters​

MarketParam

callback​

(payload) => void

Returns​

Promise<void>

touchExchange()​

touchExchange(exchangeCodes): () => void

Defined in: coinray-cache.ts:223

Parameters​

exchangeCodes​

string | string[]

Returns​

() => void

unsubscribeAllTickers()​

unsubscribeAllTickers(listenerId): void

Defined in: coinray-cache.ts:547

Parameters​

listenerId​

string

Returns​

void

unsubscribeCandles()​

unsubscribeCandles(__namedParameters, callback?): Promise<void>

Defined in: coinray-cache.ts:622

Parameters​

__namedParameters​

CandleParam

callback?​

(payload) => void

Returns​

Promise<void>

unsubscribeOrderBook()​

unsubscribeOrderBook(__namedParameters, callback?): Promise<void>

Defined in: coinray-cache.ts:632

Parameters​

__namedParameters​

MarketParam

callback?​

(payload) => void

Returns​

Promise<void>

unsubscribeTickers()​

unsubscribeTickers(listenerId, coinraySymbols): void

Defined in: coinray-cache.ts:552

Parameters​

listenerId​

string

coinraySymbols​

string[]

Returns​

void

unsubscribeTrades()​

unsubscribeTrades(__namedParameters, callback?): Promise<void>

Defined in: coinray-cache.ts:642

Parameters​

__namedParameters​

MarketParam

callback?​

(payload) => void

Returns​

Promise<void>