Options
All
  • Public
  • Public/Protected
  • All
Menu

ZumoKit instance. Refer to documentation for usage details.

Hierarchy

  • ZumoKit

Index

Properties

currentUser

currentUser: User | null = null

Currently signed-in user or null.

exchangeRates

exchangeRates: ExchangeRates

Mapping between currency pairs and available exchange rates.

exchangeSettings

exchangeSettings: ExchangeSettings

Mapping between currency pairs and available exchange settings.

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
  • 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

fetchHistoricalExchangeRates

getExchangeRate

getExchangeSetting

getTransactionFeeRate

onLog

  • onLog(listener: (message: string) => void, logLevel: LogLevel): void
  • 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
  • Remove change listener.

    Parameters

    • listener: () => void

      interface to listen to changes

        • (): void
        • Returns void

    Returns void

setLogLevel

  • Sets log level for current logger.

    Parameters

    • logLevel: LogLevel

      log level, e.g. 'debug' or 'info'

    Returns void

signIn

  • 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

    Returns Promise<User>

signOut

  • signOut(): void

Legend

  • Property
  • Method
  • Property
  • Inherited property
  • Static property

Generated using TypeDoc