Class ClaimableBalanceManager

Hierarchy

BaseManager<typeof ClaimableBalance>
- ClaimableBalanceManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ClaimableBalanceManager(stellar: StellarClient, iterable?: (ClaimableBalanceRecord | ClaimableBalance)[]): ClaimableBalanceManager

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

Properties

Readonly cache

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

The cache of the manager.

Readonly client

client: Client

Protected Optional Readonly extras

extras: []

Protected Readonly hold

hold: typeof ClaimableBalance

Readonly stellar

stellar: StellarClient

Methods

add

add(data: ClaimableBalanceRecord, cache?: boolean): ClaimableBalance

Overrides BaseManager.add
- Defined in src/structures/managers/stellar/ClaimableBalanceManager.ts:22
Adds the claimable balance to the cache (or return the cached claimable balance, if cache is true).

Parameters
- data: ClaimableBalanceRecord
  
  The claimable balance to add.
- cache: boolean = true
  
  If the claimable balance should be cached (or cached claimable balance patched), true by default.
Returns ClaimableBalance

The resolved claimable balance.

fetch

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

Overrides BaseManager.fetch
- Defined in src/structures/managers/stellar/ClaimableBalanceManager.ts:50
Fetch the claimable balance by its id in the cache or from the Pi Network Stellar API.

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

The fetched claimable balance.

resolve

resolve(key: string): undefined | ClaimableBalance

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

The cached data or undefined if not found.

Generated using TypeDoc