Class UserHub

Hierarchy (View Summary)

TypedEventEmitter<UserHubEvents>
- UserHub

Index

Constructors

Methods

off on once removeAllListeners subscribe subscribeOrders subscribePositions subscribeTrades unsubscribe unsubscribeOrders unsubscribePositions unsubscribeTrades

Constructors

constructor

new UserHub(connectionManager: ConnectionManager): UserHub
Parameters
- connectionManager: ConnectionManager
Returns UserHub
Overrides TypedEventEmitter.constructor
- Defined in src/realtime/user/user-hub.ts:16

Methods

off

off<K extends keyof UserHubEvents>(
event: K,
callback: EventCallback<UserHubEvents[K]>,
): this
Type Parameters
- K extends keyof UserHubEvents
Parameters
- event: K
- callback: EventCallback<UserHubEvents[K]>
Returns this
Inherited from TypedEventEmitter.off
- Defined in src/utils/event-emitter.ts:16

on

on<K extends keyof UserHubEvents>(
event: K,
callback: EventCallback<UserHubEvents[K]>,
): this
Type Parameters
- K extends keyof UserHubEvents
Parameters
- event: K
- callback: EventCallback<UserHubEvents[K]>
Returns this
Inherited from TypedEventEmitter.on
- Defined in src/utils/event-emitter.ts:8

once

once<K extends keyof UserHubEvents>(
event: K,
callback: EventCallback<UserHubEvents[K]>,
): this
Type Parameters
- K extends keyof UserHubEvents
Parameters
- event: K
- callback: EventCallback<UserHubEvents[K]>
Returns this
Inherited from TypedEventEmitter.once
- Defined in src/utils/event-emitter.ts:21

removeAllListeners

removeAllListeners<K extends keyof UserHubEvents>(event?: K): this
Type Parameters
- K extends keyof UserHubEvents
Parameters
- Optionalevent: K
Returns this
Inherited from TypedEventEmitter.removeAllListeners
- Defined in src/utils/event-emitter.ts:50

subscribe(accountId: number): Promise<void>
Parameters
- accountId: number
Returns Promise<void>
- Defined in src/realtime/user/user-hub.ts:41

subscribeOrders

subscribeOrders(accountId: number): Promise<void>
Parameters
- accountId: number
Returns Promise<void>
- Defined in src/realtime/user/user-hub.ts:57

subscribePositions

subscribePositions(accountId: number): Promise<void>
Parameters
- accountId: number
Returns Promise<void>
- Defined in src/realtime/user/user-hub.ts:71

subscribeTrades

subscribeTrades(accountId: number): Promise<void>
Parameters
- accountId: number
Returns Promise<void>
- Defined in src/realtime/user/user-hub.ts:85

unsubscribe

unsubscribe(accountId: number): Promise<void>
Parameters
- accountId: number
Returns Promise<void>
- Defined in src/realtime/user/user-hub.ts:49

unsubscribeOrders

unsubscribeOrders(accountId: number): Promise<void>
Parameters
- accountId: number
Returns Promise<void>
- Defined in src/realtime/user/user-hub.ts:64

unsubscribePositions

unsubscribePositions(accountId: number): Promise<void>
Parameters
- accountId: number
Returns Promise<void>
- Defined in src/realtime/user/user-hub.ts:78

unsubscribeTrades

unsubscribeTrades(accountId: number): Promise<void>
Parameters
- accountId: number
Returns Promise<void>
- Defined in src/realtime/user/user-hub.ts:92