Skip to main content

Class: CoinrayCache

Defined in: coinray-cache.ts:12

Extends​

  • default

Constructors​

Constructor​

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

Defined in: coinray-cache.ts:26

Parameters​

token​

string

config​

any

refreshRate?​

number = ...

cachePrams?​

CacheParams = undefined

Returns​

CoinrayCache

Overrides​

EventEmitter.constructor

Properties​

initialized​

initialized: boolean

Defined in: coinray-cache.ts:16

listeners​

listeners: object

Defined in: event-emitter.ts:2

Inherited from​

EventEmitter.listeners

refreshRate​

refreshRate: number

Defined in: coinray-cache.ts:17

Methods​

apiForSymbol()​

apiForSymbol(coinraySymbol): default

Defined in: coinray-cache.ts:344

Parameters​

coinraySymbol​

string

Returns​

default

authenticateDevice()​

authenticateDevice(credential, sessionKey): void

Defined in: coinray-cache.ts:55

Parameters​

credential​

string

sessionKey​

string

Returns​

void

destroy()​

destroy(): void

Defined in: coinray-cache.ts:109

Returns​

void

dispatchEvent()​

dispatchEvent(eventName, data?): void

Defined in: event-emitter.ts:35

Parameters​

eventName​

any

data?​

Returns​

void

Inherited from​

EventEmitter.dispatchEvent

fetchCandles()​

fetchCandles(__namedParameters): Promise<Candle[]>

Defined in: coinray-cache.ts:220

Parameters​

__namedParameters​

CandlesParam

Returns​

Promise<Candle[]>

fetchFirstCandleTime()​

fetchFirstCandleTime(__namedParameters): Promise<Date>

Defined in: coinray-cache.ts:225

Parameters​

__namedParameters​

CandlesParam

Returns​

Promise<Date>

flushTickerSubscriptions()​

flushTickerSubscriptions(): Promise<void>

Defined in: coinray-cache.ts:255

Returns​

Promise<void>

getExchange()​

getExchange(exchangeCode): Exchange

Defined in: coinray-cache.ts:162

Parameters​

exchangeCode​

any

Returns​

Exchange

getExchanges()​

getExchanges(): ExchangeMap

Defined in: coinray-cache.ts:155

Returns​

ExchangeMap

getMarket()​

getMarket(coinraySymbol): Market

Defined in: coinray-cache.ts:209

Parameters​

coinraySymbol​

string

Returns​

Market

getMarkets()​

getMarkets(codeOrSymbols): MarketMap

Defined in: coinray-cache.ts:192

Parameters​

codeOrSymbols​

string | string[]

Returns​

MarketMap

getProxyList()​

getProxyList(params?): Promise<any>

Defined in: coinray-cache.ts:151

Parameters​

params?​

Returns​

Promise<any>

getRootApi()​

getRootApi(): default

Defined in: coinray-cache.ts:51

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:42

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:77

Parameters​

callback​

() => Promise<string>

Returns​

void

refreshExchangeInterval()​

refreshExchangeInterval(): Promise<void>

Defined in: coinray-cache.ts:100

Returns​

Promise<void>

refreshExchanges()​

refreshExchanges(apiCache?): Promise<void>

Defined in: coinray-cache.ts:124

Parameters​

apiCache?​

any = undefined

Returns​

Promise<void>

refreshMarkets()​

refreshMarkets(exchangeCode): Promise<void>

Defined in: coinray-cache.ts:181

Parameters​

exchangeCode​

any

Returns​

Promise<void>

refreshMarketsFromTickers()​

refreshMarketsFromTickers(payload): Promise<void>

Defined in: coinray-cache.ts:290

Parameters​

payload​

any

Returns​

Promise<void>

refreshToken()​

refreshToken(): Promise<any>

Defined in: coinray-cache.ts:59

Returns​

Promise<any>

removeAllListeners()​

removeAllListeners(): void

Defined in: event-emitter.ts:8

Returns​

void

Inherited from​

EventEmitter.removeAllListeners

scheduleTickerRefresh()​

scheduleTickerRefresh(): void

Defined in: coinray-cache.ts:235

Returns​

void

searchMarkets()​

searchMarkets(marketQuery): MarketMap

Defined in: coinray-cache.ts:185

Parameters​

marketQuery​

string | MarketQuery | MarketQuery[]

Returns​

MarketMap

start()​

start(): Promise<void>

Defined in: coinray-cache.ts:81

Returns​

Promise<void>

subscribeCandles()​

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

Defined in: coinray-cache.ts:310

Parameters​

__namedParameters​

CandleParam

callback​

(payload) => void

Returns​

Promise<(payload) => void>

subscribeOrderBook()​

subscribeOrderBook(__namedParameters, callback): Promise<void>

Defined in: coinray-cache.ts:324

Parameters​

__namedParameters​

MarketParam

callback​

(payload) => void

Returns​

Promise<void>

subscribeTickers()​

subscribeTickers(listenerId, coinraySymbols, resetExisting?): void

Defined in: coinray-cache.ts:230

Parameters​

listenerId​

string

coinraySymbols​

string[]

resetExisting?​

boolean = false

Returns​

void

subscribeTrades()​

subscribeTrades(__namedParameters, callback): Promise<void>

Defined in: coinray-cache.ts:334

Parameters​

__namedParameters​

MarketParam

callback​

(payload) => void

Returns​

Promise<void>

unsubscribeAllTickers()​

unsubscribeAllTickers(listenerId): void

Defined in: coinray-cache.ts:245

Parameters​

listenerId​

string

Returns​

void

unsubscribeCandles()​

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

Defined in: coinray-cache.ts:319

Parameters​

__namedParameters​

CandleParam

callback?​

(payload) => void

Returns​

Promise<void>

unsubscribeOrderBook()​

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

Defined in: coinray-cache.ts:329

Parameters​

__namedParameters​

MarketParam

callback?​

(payload) => void

Returns​

Promise<void>

unsubscribeTickers()​

unsubscribeTickers(listenerId, coinraySymbols): void

Defined in: coinray-cache.ts:250

Parameters​

listenerId​

string

coinraySymbols​

string[]

Returns​

void

unsubscribeTrades()​

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

Defined in: coinray-cache.ts:339

Parameters​

__namedParameters​

MarketParam

callback?​

(payload) => void

Returns​

Promise<void>