Class TradeManager

Hierarchy

BaseManager<typeof Trade>
- TradeManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TradeManager(stellar: StellarClient, iterable?: (TradeRecord | Trade)[]): TradeManager

Overrides BaseManager.constructor
- Defined in src/structures/managers/stellar/TradeManager.ts:8
Parameters
- stellar: StellarClient
- Optional iterable: (TradeRecord | Trade)[]
Returns TradeManager

Properties

Readonly cache

cache: Map<string, Trade> = ...

The cache of the manager.

Readonly client

client: Client

Protected Optional Readonly extras

extras: []

Protected Readonly hold

hold: typeof Trade

Readonly stellar

stellar: StellarClient

Methods

add

add(data: TradeRecord, cache?: boolean): Trade

Overrides BaseManager.add
- Defined in src/structures/managers/stellar/TradeManager.ts:19
Adds the trade to the cache (or return the cached trade, if cache is true).

Parameters
- data: TradeRecord
  
  The trade to add.
- cache: boolean = true
  
  If the trade should be cached (or cached trade patched), true by default.
Returns Trade

The resolved trade.

Optional fetch

fetch(key: string, cache?: boolean, checkCache?: boolean): Promise<undefined | Trade>

Inherited from BaseManager.fetch
- Defined in src/structures/managers/BaseManager.ts:19
Fetches the data from Pi Network APIs (or return the cached element, if cache is true).

Parameters
- key: string
  
  The data's key (id, etc.).
- Optional cache: boolean
  
  If the data should be cached (or cached data patched), true by default.
- Optional checkCache: boolean
  
  If the cached data should be returned (if it exists) rather than fetching the data, true by default.
Returns Promise<undefined | Trade>

The the fetched (or cached) data, or undefined if not found.

resolve

resolve(key: string): undefined | Trade

Inherited from BaseManager.resolve
- Defined in src/structures/managers/BaseManager.ts:63
Resolves the data by its key from the cache.

Parameters
- key: string
  
  The data's key (id, etc.).
Returns undefined | Trade

The cached data or undefined if not found.

Generated using TypeDoc