Namespace default

Index

Type aliases

Variables

Functions

initModule

Type aliases

Bot

Bot: BotP

Broker

Broker: BrokerI

Configs

Configs: ConfigsI

LoginVerifier

LoginVerifier: LoginVerifierI

Receiver

Receiver<User, Auth>: ReceiverP<User, Auth>

Type parameters

User: null | MachinatUser
Auth

Server

Server<User, Auth>: ServerP<User, Auth>

Type parameters

User: null | MachinatUser
Auth

ServerId

ServerId: string

UpgradeVerifier

UpgradeVerifier: UpgradeVerifierI

WsServer

WsServer: WsServerI

Variables

Bot

Bot: ServiceProvider<WebSocketBot, [WebSocketServer<null | MachinatUser, unknown>, null | ModuleUtilities, null | WebSocketPlatformUtilities<MachinatUser, unknown>]> & typeof WebSocketBot = BotP

Broker

Broker: SingularServiceInterface<WebSocketClusterBroker> = BrokerI

Configs

Configs: SingularServiceInterface<WebSocketConfigs<MachinatUser, unknown>> = ConfigsI

LoginVerifier

LoginVerifier: SingularServiceInterface<AnyVerifyLoginFn> = LoginVerifierI

Receiver

Receiver: ServiceProvider<WebSocketReceiver<null | MachinatUser, unknown>, [WebSocketBot, WebSocketServer<null | MachinatUser, unknown>, ModuleUtilities, WebSocketPlatformUtilities<MachinatUser, unknown>]> & Function = ReceiverP

Server

Server: ServiceProvider<WebSocketServer<null | MachinatUser, unknown>, [null | string, WsServer, WebSocketClusterBroker, null | VerifyUpgradeFn, null | AnyVerifyLoginFn, BaseMarshaler, WebSocketConfigs<MachinatUser, unknown>]> & Function = ServerP

ServerId

ServerId: SingularServiceInterface<string> = ServerIdI

UpgradeVerifier

UpgradeVerifier: SingularServiceInterface<VerifyUpgradeFn> = UpgradeVerifierI

WsServer

WsServer: SingularServiceInterface<WsServer> = WsServerI

Functions

Const initModule

initModule<User, Auth>(configs?: WebSocketConfigs<User, Auth>): MachinatPlatform<WebSocketEventContext<User, Auth, EventValue<string, string, any>>, null, WebSocketJob, WebSocketDispatchFrame, WebSocketResult>

- Defined in packages/websocket/src/module.ts:88
Type parameters
- User: null | MachinatUser
- Auth
Parameters
- configs: WebSocketConfigs<User, Auth> = {}
Returns MachinatPlatform<WebSocketEventContext<User, Auth, EventValue<string, string, any>>, null, WebSocketJob, WebSocketDispatchFrame, WebSocketResult>

Generated using TypeDoc