Class OfferStream

Stream manager for Stellar offers.

Hierarchy

BaseStream
- OfferStream

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OfferStream(stellar: StellarClient): OfferStream

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

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/OfferStream.ts:29
Listen for new Stellar offers.

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(offer: OfferRecord): void

- Defined in src/stellar/streams/OfferStream.ts:20
Handle new Stellar offers.

Parameters
- offer: OfferRecord
  
  The received Stellar offer.
Returns 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