SocketProviderMetadata

@tsed/socketio

Usage

import { SocketProviderMetadata } from "@tsed/socketio";

See /packages/third-parties/socketio/src/class/SocketProviderMetadata.ts.

Overview

class SocketProviderMetadata {
    type: SocketProviderTypes;
    namespace: string | RegExp;
    error: boolean;
    injectNamespaces: SocketInjectableNsp[];
    useBefore: any[];
    useAfter: any[];
    handlers: Record<string, SocketHandlerMetadata>;
    constructor(options?: Partial<SocketProviderMetadata>);
    get useHandler(): SocketHandlerMetadata;
    get $onConnection(): SocketHandlerMetadata;
    get $onDisconnect(): SocketHandlerMetadata;
    get(key: string): SocketHandlerMetadata;
    set(key: string, metadata: SocketHandlerMetadata): void;
    getHandlers(): SocketHandlerMetadata[];
    createHook(hook: string, eventName: string): void;
}

type

type: SocketProviderTypes;

namespace

namespace: string | RegExp;

error

error: boolean;

injectNamespaces

injectNamespaces: SocketInjectableNsp[];

useBefore

useBefore: any[];

useAfter

useAfter: any[];

handlers

handlers: Record<string, SocketHandlerMetadata>;

get useHandler

get useHandler(): SocketHandlerMetadata;

get $onConnection

get $onConnection(): SocketHandlerMetadata;

get $onDisconnect

get $onDisconnect(): SocketHandlerMetadata;

get

get(key: string): SocketHandlerMetadata;

set

set(key: string, metadata: SocketHandlerMetadata): void;

getHandlers

getHandlers(): SocketHandlerMetadata[];

createHook

createHook(hook: string, eventName: string): void;