Class LedgerStream

Stream manager for Stellar ledgers.

Hierarchy

BaseStream
- LedgerStream

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LedgerStream(stellar: StellarClient): LedgerStream

Overrides BaseStream.constructor
- Defined in src/stellar/streams/LedgerStream.ts:12
Parameters
- stellar: StellarClient
Returns LedgerStream

Properties

Protected Optional _stop

_stop: () => void

Type declaration

- (): void
- Returns void

Readonly stellar

stellar: StellarClient

Methods

listen

listen(): void

Overrides BaseStream.listen
- Defined in src/stellar/streams/LedgerStream.ts:34
Listen for new Stellar ledgers.

Returns void

Protected onError

onError(error: MessageEvent<any>): void

Inherited from BaseStream.onError
- Defined in src/stellar/streams/BaseStream.ts:17
Emit Stellar errors.

Parameters
- error: MessageEvent<any>
  
  The Stellar error.
Returns void

Private onMessage

onMessage(ledger: LedgerRecord): Promise<void>

- Defined in src/stellar/streams/LedgerStream.ts:21
Handle new Stellar ledgers.

Parameters
- ledger: LedgerRecord
  
  The received Stellar ledger.
Returns Promise<void>

stop

stop(): void

Inherited from BaseStream.stop
- Defined in src/stellar/streams/BaseStream.ts:26
Stop the current stream if there is one.

Returns void

Generated using TypeDoc