Interface IVaultService

interface IVaultService {
    get status(): AsyncOp;
    get vaults(): TimedVault[];
    collect(vault: TimedVault): Promise<void>;
    getValue(vault: TimedVault): number;
    isFull(vault: TimedVault): boolean;
    refresh(): Promise<void>;
}

Index

Accessors

Methods

collect getValue isFull refresh

Accessors

status

get status(): AsyncOp
The current loading status of the vaults.

Returns AsyncOp
- Defined in src/core/vault/interfaces.ts:8

vaults

get vaults(): TimedVault[]
All loaded vaults.

Returns TimedVault[]
- Defined in src/core/vault/interfaces.ts:13

Methods

collect

collect(vault): Promise<void>
Collects the vault.
Parameters
- vault: TimedVault
  The vault to collect.
Returns Promise<void>
- Defined in src/core/vault/interfaces.ts:39

getValue

getValue(vault): number
Calculates the current value of the vault.
Parameters
- vault: TimedVault
  The vault to check.
Returns number
- Defined in src/core/vault/interfaces.ts:32

isFull

isFull(vault): boolean
True if and only if the vault is at capacity.
Parameters
- vault: TimedVault
  The vault to check.
Returns boolean
- Defined in src/core/vault/interfaces.ts:25

refresh

refresh(): Promise<void>
Refresh all vaults.

Returns Promise<void>
- Defined in src/core/vault/interfaces.ts:18