socketio-class-controllers
Version:
Use class-based controllers to handle websocket events
42 lines (41 loc) • 1.43 kB
TypeScript
import { ClassTransformOptions } from "class-transformer";
/**
* Registers controllers and actions in the given server framework.
*/
export declare class SocketControllerExecutor {
private io;
/**
* Indicates if class-transformer package should be used to perform message body serialization / deserialization.
* By default its enabled.
*/
useClassTransformer: boolean;
/**
* Global class transformer options passed to class-transformer during classToPlain operation.
* This operation is being executed when server returns response to user.
*/
classToPlainTransformOptions: ClassTransformOptions;
/**
* Global class transformer options passed to class-transformer during plainToClass operation.
* This operation is being executed when parsing user parameters.
*/
plainToClassTransformOptions: ClassTransformOptions;
private metadataBuilder;
constructor(io: any);
execute(controllerClasses?: Function[], middlewareClasses?: Function[]): void;
/**
* Registers middlewares.
*/
private registerMiddlewares;
/**
* Registers controllers.
*/
private registerControllers;
private handleConnection;
private handleAction;
private handleParam;
private handleParamFormat;
private parseParamValue;
private handleSuccessResult;
private handleFailResult;
private handleNamespaceParams;
}