@novice1/socket - v0.4.6
    Preparing search index...

    Interface Response<ListenEvents, EmitEvents, ServerSideEvents>

    Especially typed with parameters because of "BroadcastOperator"

    interface Response<
        ListenEvents extends EventsMap = DefaultEventsMap,
        EmitEvents extends EventsMap = ListenEvents,
        ServerSideEvents extends EventsMap = DefaultEventsMap,
    > {
        broadcast: BroadcastOperator<EmitEvents, any>;
        compressed: Response<ListenEvents, EmitEvents, ServerSideEvents>;
        emit: Response<ListenEvents, EmitEvents, ServerSideEvents>;
        except: <SocketData = any>(
            room: string | string[],
        ) => BroadcastOperator<EmitEvents, SocketData>;
        in: <SocketData = any>(
            room: string | string[],
        ) => BroadcastOperator<EmitEvents, SocketData>;
        notCompressed: Response<ListenEvents, EmitEvents, ServerSideEvents>;
        of: (
            name?:
                | string
                | RegExp
                | (
                    (
                        name: string,
                        query: { [key: string]: unknown },
                        next: (err: Error | null, success: boolean) => void,
                    ) => void
                ),
            fn?: (socket: Socket<ListenEvents, EmitEvents, ServerSideEvents>) => void,
        ) => Namespace<ListenEvents, EmitEvents, ServerSideEvents>;
        to: <SocketData = any>(
            room: string | string[],
        ) => BroadcastOperator<EmitEvents, SocketData>;
        volatile: Response<ListenEvents, EmitEvents, ServerSideEvents>;
        (
            eventName:
                | string
                | (
                    (
                        socket: Socket<ListenEvents, EmitEvents, ServerSideEvents>,
                        nsp: Namespace<ListenEvents, EmitEvents, ServerSideEvents>,
                        io: Server<ListenEvents, EmitEvents, ServerSideEvents>,
                    ) => void
                ),
            ...args: unknown[],
        ): void;
    }

    Type Parameters

    • ListenEvents extends EventsMap = DefaultEventsMap
    • EmitEvents extends EventsMap = ListenEvents
    • ServerSideEvents extends EventsMap = DefaultEventsMap
    Index

    Properties

    broadcast compressed emit except in notCompressed of to volatile

    Properties

    broadcast: BroadcastOperator<EmitEvents, any>
    compressed: Response<ListenEvents, EmitEvents, ServerSideEvents>
    emit: Response<ListenEvents, EmitEvents, ServerSideEvents>
    except: <SocketData = any>(
        room: string | string[],
    ) => BroadcastOperator<EmitEvents, SocketData>
    in: <SocketData = any>(
        room: string | string[],
    ) => BroadcastOperator<EmitEvents, SocketData>
    notCompressed: Response<ListenEvents, EmitEvents, ServerSideEvents>
    of: (
        name?:
            | string
            | RegExp
            | (
                (
                    name: string,
                    query: { [key: string]: unknown },
                    next: (err: Error | null, success: boolean) => void,
                ) => void
            ),
        fn?: (socket: Socket<ListenEvents, EmitEvents, ServerSideEvents>) => void,
    ) => Namespace<ListenEvents, EmitEvents, ServerSideEvents>
    to: <SocketData = any>(
        room: string | string[],
    ) => BroadcastOperator<EmitEvents, SocketData>
    volatile: Response<ListenEvents, EmitEvents, ServerSideEvents>

    Settings

    Member Visibility

    On This Page

    Properties