Class AssetManager

Hierarchy

BaseManager<typeof Asset>
- AssetManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AssetManager(stellar: StellarClient, iterable?: (AssetRecord | Asset)[]): AssetManager

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

Properties

Readonly cache

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

The cache of the manager.

Readonly client

client: Client

Protected Optional Readonly extras

extras: []

Protected Readonly hold

hold: typeof Asset

Readonly stellar

stellar: StellarClient

Methods

add

add(data: AssetRecord, cache?: boolean): Asset

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

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

The resolved asset.

fetch

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

Overrides BaseManager.fetch
- Defined in src/structures/managers/stellar/AssetManager.ts:48
Fetch the asset by its code in the cache or from the Pi Network Stellar API.

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

The fetched asset.

resolve

resolve(key: string): undefined | Asset

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

The cached data or undefined if not found.

Generated using TypeDoc