Class AccountManager

What a host control needs to show and switch accounts. AccountManager implements it.

Implements

AccountStateSource

Index

Constructors

Accessors

Methods

destroy disconnected executions getState orderHistory positions reconnect refresh select selectedAccount subscribe

Constructors

constructor

new AccountManager(options: AccountManagerOptions): AccountManager
Parameters
- options: AccountManagerOptions
Returns AccountManager
- Defined in src/trade/account.ts:212

Accessors

mode

get mode(): TradeMode
Returns TradeMode
- Defined in src/trade/account.ts:225

Methods

destroy

destroy(): void
Abort everything, drop the stream and the listeners. Later calls refuse.

Returns void
- Defined in src/trade/account.ts:460

disconnected

disconnected(reason?: string): void
The provider or the host lost the connection. The last figures stay on screen marked stale; anything still in flight is abandoned, because it was asked for over the connection that just failed.
Parameters
- reason: string = DISCONNECTED
Returns void
- Defined in src/trade/account.ts:389

executions

executions(
query?: Omit<AccountHistoryQuery, "accountId">,
): Promise<AccountReadResult<Execution>>
Parameters
- query: Omit<AccountHistoryQuery, "accountId"> = {}
Returns Promise<AccountReadResult<Execution>>
- Defined in src/trade/account.ts:414

getState

getState(): AccountState
Returns AccountState
Implementation of AccountStateSource.getState
- Defined in src/trade/account.ts:226

orderHistory

orderHistory(
query?: Omit<AccountHistoryQuery, "accountId">,
): Promise<AccountReadResult<OrderHistoryEntry>>
Parameters
- query: Omit<AccountHistoryQuery, "accountId"> = {}
Returns Promise<AccountReadResult<OrderHistoryEntry>>
- Defined in src/trade/account.ts:418

positions

positions(): Promise<AccountReadResult<Position>>
A position row carries its account only when the provider stamps one. A row naming another account is dropped and counted; one naming none is the selected account's, because that is the account the provider was asked for.

Returns Promise<AccountReadResult<Position>>
- Defined in src/trade/account.ts:406

reconnect

reconnect(): Promise<AccountSelectResult>
Re-list and reload after a disconnect. The same as refresh, named for the call site.

Returns Promise<AccountSelectResult>
- Defined in src/trade/account.ts:399

refresh

refresh(): Promise<AccountSelectResult>
List accounts, keep or choose a selection, and load its snapshot.

Returns Promise<AccountSelectResult>
- Defined in src/trade/account.ts:277

select

select(accountId: string): Promise<AccountSelectResult>
Select an account and load its snapshot. A later selection cancels this one.
Parameters
- accountId: string
Returns Promise<AccountSelectResult>
Implementation of AccountStateSource.select
- Defined in src/trade/account.ts:317

selectedAccount

selectedAccount(): null | string
Returns null | string
- Defined in src/trade/account.ts:227

subscribe

subscribe(listener: (state: AccountState) => void): () => void
Parameters
- listener: (state: AccountState) => void
Returns () => void
Implementation of AccountStateSource.subscribe
- Defined in src/trade/account.ts:229