Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StellarClient

Hierarchy

  • EventEmitter
    • StellarClient

Index

Constructors

constructor

Properties

Optional account

account: Keypair

The application keypair if provided in the options.

accounts

accounts: AccountManager

A manager for the Stellar accounts.

assets

assets: AssetManager

A manager for the Stellar assets.

claimableBalances

claimableBalances: ClaimableBalanceManager

A manager for the Stellar claimable balances.

Readonly client

client: Client

effects

effects: EffectManager<Effect<EffectTypeNames, EffectType>>

A manager for the Stellar effects.

ledgers

ledgers: LedgerManager

A manager for the Stellar ledgers.

offers

offers: OfferManager

A manager for the Stellar offers.

operations

operations: OperationManager<Operation<OperationResponseType, OperationResponseTypeI>>

A manager for the Stellar operations.

server

server: Server

The Stellar server.

streams

streams: StreamManager

A manager for the stream events.

trades

trades: TradeManager

A manager for the Stellar trades.

transactions

transactions: TransactionManager

A manager for the Stellar transactions.

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener<K>(eventName: K, listener: (...args: ClientEvents[K]) => void): StellarClient
  • addListener(eventName: string | symbol, listener: (...args: unknown[]) => void): StellarClient
  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • eventName: K
    • listener: (...args: ClientEvents[K]) => void
        • (...args: ClientEvents[K]): void
        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns StellarClient

  • Parameters

    • eventName: string | symbol
    • listener: (...args: unknown[]) => void
        • (...args: unknown[]): void
        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns StellarClient

Private configure

emit

  • emit<K>(eventName: K, ...args: ClientEvents[K]): boolean
  • emit(eventName: string | symbol, ...args: unknown[]): boolean
  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • eventName: K
    • Rest ...args: ClientEvents[K]

    Returns boolean

  • Parameters

    • eventName: string | symbol
    • Rest ...args: unknown[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});
    
    const sym = Symbol('symbol');
    myEE.on(sym, () => {});
    
    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
    
    since

    v6.0.0

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    since

    v1.0.0

    Returns number

listenerCount

  • listenerCount<K>(eventName: K): number
  • listenerCount(eventName: string | symbol): number

listeners

  • listeners<K>(eventName: K): ((...args: ClientEvents[K]) => void)[]
  • listeners(eventName: string | symbol): ((...args: unknown[]) => void)[]
  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • eventName: K

    Returns ((...args: ClientEvents[K]) => void)[]

  • Parameters

    • eventName: string | symbol

    Returns ((...args: unknown[]) => void)[]

off

  • off<K>(eventName: K, listener: (...args: ClientEvents[K]) => void): StellarClient
  • off(eventName: string | symbol, listener: (...args: unknown[]) => void): StellarClient
  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • eventName: K
    • listener: (...args: ClientEvents[K]) => void
        • (...args: ClientEvents[K]): void
        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns StellarClient

  • Parameters

    • eventName: string | symbol
    • listener: (...args: unknown[]) => void
        • (...args: unknown[]): void
        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns StellarClient

on

  • on<K>(eventName: K, listener: (...args: ClientEvents[K]) => void): StellarClient
  • on(eventName: string | symbol, listener: (...args: unknown[]) => void): StellarClient
  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • eventName: K
    • listener: (...args: ClientEvents[K]) => void
        • (...args: ClientEvents[K]): void
        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns StellarClient

  • Parameters

    • eventName: string | symbol
    • listener: (...args: unknown[]) => void
        • (...args: unknown[]): void
        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns StellarClient

once

  • once<K>(eventName: K, listener: (...args: ClientEvents[K]) => void): StellarClient
  • once(eventName: string | symbol, listener: (...args: unknown[]) => void): StellarClient
  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • eventName: K
    • listener: (...args: ClientEvents[K]) => void
        • (...args: ClientEvents[K]): void
        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns StellarClient

  • Parameters

    • eventName: string | symbol
    • listener: (...args: unknown[]) => void
        • (...args: unknown[]): void
        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns StellarClient

prependListener

  • prependListener<K>(eventName: K, listener: (...args: ClientEvents[K]) => void): StellarClient
  • prependListener(eventName: string | symbol, listener: (...args: unknown[]) => void): StellarClient
  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • eventName: K
    • listener: (...args: ClientEvents[K]) => void
        • (...args: ClientEvents[K]): void
        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns StellarClient

  • Parameters

    • eventName: string | symbol
    • listener: (...args: unknown[]) => void
        • (...args: unknown[]): void
        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns StellarClient

prependOnceListener

  • prependOnceListener<K>(eventName: K, listener: (...args: ClientEvents[K]) => void): StellarClient
  • prependOnceListener(eventName: string | symbol, listener: (...args: unknown[]) => void): StellarClient
  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • eventName: K
    • listener: (...args: ClientEvents[K]) => void
        • (...args: ClientEvents[K]): void
        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns StellarClient

  • Parameters

    • eventName: string | symbol
    • listener: (...args: unknown[]) => void
        • (...args: unknown[]): void
        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns StellarClient

rawListeners

  • rawListeners(eventName: string | symbol): Function[]
  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));
    
    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];
    
    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();
    
    // Logs "log once" to the console and removes the listener
    logFnWrapper();
    
    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');
    
    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
    
    since

    v9.4.0

    Parameters

    • eventName: string | symbol

    Returns Function[]

Private registerWithMnemonic

  • registerWithMnemonic(mnemonic: string): Promise<void>

removeAllListeners

removeListener

  • removeListener<K>(eventName: K, listener: (...args: ClientEvents[K]) => void): StellarClient
  • removeListener(eventName: string | symbol, listener: (...args: unknown[]) => void): StellarClient
  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • eventName: K
    • listener: (...args: ClientEvents[K]) => void
        • (...args: ClientEvents[K]): void
        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns StellarClient

  • Parameters

    • eventName: string | symbol
    • listener: (...args: unknown[]) => void
        • (...args: unknown[]): void
        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns StellarClient

setMaxListeners

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    since

    v0.3.5

    Parameters

    • n: number

    Returns StellarClient

Static getEventListener

  • getEventListener(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]
  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: EventEmitter | DOMEventTarget
    • name: string | symbol

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, eventName: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • eventName: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • Parameters

    • emitter: EventEmitter
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • Parameters

    • emitter: NodeEventTarget
    • eventName: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc