@venizia/ignis/socket-io
Generated from the built declarations by
vulcan x atlas api gen- do not edit.
2 exports, 2 with TSDoc.
SocketIOBindingKeys
class
Container keys of the Socket.IO component: the server instance, its options, the Redis connection and the handlers an application binds.
ts
export declare class SocketIOBindingKeys {
static readonly SOCKET_IO_INSTANCE: import("@venizia/ignis-inversion").TBindingKey<SocketIOServerHelper>;
static readonly SERVER_OPTIONS: import("@venizia/ignis-inversion").TBindingKey<Partial<ServerOptions>>;
static readonly REDIS_CONNECTION: import("@venizia/ignis-inversion").TBindingKey<IRedisHelper | null>;
static readonly AUTHENTICATE_HANDLER: import("@venizia/ignis-inversion").TBindingKey<TSocketIOAuthenticateFn | null>;
static readonly VALIDATE_ROOM_HANDLER: import("@venizia/ignis-inversion").TBindingKey<TSocketIOValidateRoomFn | null>;
static readonly CLIENT_CONNECTED_HANDLER: import("@venizia/ignis-inversion").TBindingKey<TSocketIOClientConnectedFn | null>;
}Source: packages/core-server/src/components/socket-io/common/keys.ts
SocketIOComponent
class
Starts a Socket.IO server on Bun after the application starts. Requires a Redis helper at SocketIOBindingKeys.REDIS_CONNECTION and an authenticate handler at AUTHENTICATE_HANDLER; binding throws without them.
ts
export declare class SocketIOComponent extends BaseComponent {
private application;
protected serverOptions: Partial<IServerOptions>;
constructor(application: BaseApplication);
private resolveBindings;
private registerBunHook;
binding(): ValueOrPromise<void>;
}Source: packages/core-server/src/components/socket-io/component.ts