ZumoKit | ZumoKit - v4.8.12

ZumoKit instance. Refer to documentation for usage details.

Hierarchy

ZumoKit

Index

Properties

Methods

Properties

currentUser

currentUser: User | null = null

Currently signed-in user or null.

exchangeRates

exchangeRates: ExchangeRates

Mapping between currency pairs and available exchange rates.

transactionFeeRates

transactionFeeRates: TransactionFeeRates

Mapping between cryptocurrencies and available transaction fee rates.

utils

utils: Utils

Crypto utilities.

version

version: string

ZumoKit SDK semantic version tag if exists, commit hash otherwise.

Methods

addChangeListener

addChangeListener(listener: () => void): void

- Defined in src/ZumoKit.ts:331
Listen to changes in current user’s sign in state, exchange rates, exchange settings or transaction fee rates.

Parameters
- listener: () => void
  
  interface to listen to changes
  - - (): void
    - Returns void
Returns void

disconnect

disconnect(): void

- Defined in src/ZumoKit.ts:363
Stops WebSocket connection to Zumo Enterprise services.

Returns void

fetchHistoricalExchangeRates

fetchHistoricalExchangeRates(): Promise<Partial<Record<TimeInterval, Partial<Record<CurrencyCode, Partial<Record<CurrencyCode, ExchangeRate[]>>>>>>>

- Defined in src/ZumoKit.ts:305
Fetch historical exchange rates for supported time intervals.

Returns Promise<Partial<Record<TimeInterval, Partial<Record<CurrencyCode, Partial<Record<CurrencyCode, ExchangeRate[]>>>>>>>

historical exchange rates

getExchangeRate

getExchangeRate(fromCurrency: CurrencyCode, toCurrency: CurrencyCode): null | ExchangeRate

- Defined in src/ZumoKit.ts:276
Get exchange rate for selected currency pair.

Parameters
- fromCurrency: CurrencyCode
  
  currency code
- toCurrency: CurrencyCode
  
  currency code
Returns null | ExchangeRate

exchange rate or null

getTransactionFeeRate

getTransactionFeeRate(currency: CurrencyCode): null | TransactionFeeRate

- Defined in src/ZumoKit.ts:293
Get transaction fee rate for selected crypto currency.

Parameters
- currency: CurrencyCode
  
  currency code
Returns null | TransactionFeeRate

transaction fee rate or null

onLog

onLog(listener: (message: string) => void, logLevel: LogLevel): void

- Defined in src/ZumoKit.ts:225
Sets log handler for all ZumoKit related logs.

Parameters
- listener: (message: string) => void
  
  interface to listen to changes
  - - (message: string): void
    - Parameters
      - message: string
      Returns void
- logLevel: LogLevel
  
  log level, e.g. 'debug' or 'info'
Returns void

removeChangeListener

removeChangeListener(listener: () => void): void

- Defined in src/ZumoKit.ts:349
Remove change listener.

Parameters
- listener: () => void
  
  interface to listen to changes
  - - (): void
    - Returns void
Returns void

send

send(message: string): void

- Defined in src/ZumoKit.ts:130
Parameters
- message: string
Returns void

setLogLevel

setLogLevel(logLevel: LogLevel): void

- Defined in src/ZumoKit.ts:215
Sets log level for current logger.

Parameters
- logLevel: LogLevel
  
  log level, e.g. 'debug' or 'info'
Returns void

signIn

signIn(userTokenSet: TokenSet): Promise<User>

- Defined in src/ZumoKit.ts:242
Signs in user corresponding to user token set. Sets current user to the newly signed in user. Refer to Server guide for details on how to get user token set.

Parameters
- userTokenSet: TokenSet
Returns Promise<User>

signOut

signOut(): void

- Defined in src/ZumoKit.ts:263
Signs out current user.

Returns void

Generated using TypeDoc