Class SocketMixin<API, Loc>

Mixin for shared socket functionality between the server and client.

Type parameters

API: SocketInterface
Loc: SocketLocation

Hierarchy

SocketMixin
- SocketClient
- SocketServerManager

Index

Properties

Methods

Properties

Protected Abstract socketHandlers

socketHandlers: any

Expected by the mixin.

Private waiters

waiters: object

internal

Type declaration

[event: string]: object
- [startTime: number]: object
  - reject: Function
  - resolve: Function
  - timeoutId: any

Methods

blockEvent

blockEvent<Event>(event: Event, timeout?: number): Promise<any>

- Defined in lib/socket-mixin.ts:54
Gives the ability to block and wait for an event. Usage: await this.blockEvent('some-event');

Type parameters
- Event: string
Parameters
- event: Event
- Default value timeout: number = 5000
Returns Promise<any>

Protected handleEvent

handleEvent(ctx: unknown, event: string, ...args: any[]): void

- Defined in lib/socket-mixin.ts:34
Processes an incoming event with the appropriate socketHandler. If the handler returns an EventResponse, the proper event will automatically be emitted.

Parameters
- ctx: unknown
- event: string
- Rest ...args: any[]
Returns void

Protected Abstract reply

reply(ctx: any, response: Response<string, API[Loc], Loc>): any

- Defined in lib/socket-mixin.ts:28
Handles a Response that requires a reply.

Parameters
- ctx: any
- response: Response<string, API[Loc], Loc>
Returns any

Generated using TypeDoc