Class PaymentManager

Hierarchy

BaseManager<typeof Payment>
- PaymentManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PaymentManager(client: Client): PaymentManager

Overrides BaseManager.constructor
- Defined in src/structures/managers/platform/PaymentManager.ts:8
Parameters
- client: Client
Returns PaymentManager

Properties

Readonly cache

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

The cache of the manager.

Readonly client

client: Client

Protected Optional Readonly extras

extras: []

Protected Readonly hold

hold: typeof Payment

Methods

add

add(data: APIPayment, cache?: boolean): Payment

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

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

The resolved payment.

fetch

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

Overrides BaseManager.fetch
- Defined in src/structures/managers/platform/PaymentManager.ts:47
Fetch the payment by its id in the cache or from the Pi Network Platform API.

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

resolve

resolve(key: string): undefined | Payment

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

The cached data or undefined if not found.

Generated using TypeDoc