Class OfferManager

Hierarchy

BaseManager<typeof Offer>
- OfferManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OfferManager(stellar: StellarClient, iterable?: (OfferRecord | Offer)[]): OfferManager

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

Properties

Readonly cache

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

The cache of the manager.

Readonly client

client: Client

Protected Optional Readonly extras

extras: []

Protected Readonly hold

hold: typeof Offer

Readonly stellar

stellar: StellarClient

Methods

add

add(data: OfferRecord, cache?: boolean): Offer

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

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

The resolved offer.

fetch

fetch(id: string, cache?: boolean, checkCache?: boolean): Promise<Offer>

Overrides BaseManager.fetch
- Defined in src/structures/managers/stellar/OfferManager.ts:47
Fetch the offer by its id in the cache or from the Pi Network Stellar API.

Parameters
- id: string
  
  The offer id to fetch.
- Optional cache: boolean
  
  If the offer should be cached (or cached offer patched), true by default.
- checkCache: boolean = true
  
  If the offer should be fetched in the cache, true by default.
Returns Promise<Offer>

The fetched offer.

resolve

resolve(key: string): undefined | Offer

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

The cached data or undefined if not found.

Generated using TypeDoc