Ignore:
Timestamp:
11/25/21 22:08:24 (3 years ago)
Author:
Ema <ema_spirova@…>
Branches:
master
Children:
8d391a1
Parents:
59329aa
Message:

primeNG components

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trip-planner-front/node_modules/socket.io/dist/namespace.d.ts

    r59329aa re29cc2e  
    1 /// <reference types="node" />
    21import { Socket } from "./socket";
    32import type { Server } from "./index";
     3import { EventParams, EventNames, EventsMap, StrictEventEmitter, DefaultEventsMap } from "./typed-events";
    44import type { Client } from "./client";
    5 import { EventEmitter } from "events";
    65import type { Adapter, Room, SocketId } from "socket.io-adapter";
     6import { BroadcastOperator, RemoteSocket } from "./broadcast-operator";
    77export interface ExtendedError extends Error {
    88    data?: any;
    99}
    10 export declare class Namespace extends EventEmitter {
     10export interface NamespaceReservedEventsMap<ListenEvents extends EventsMap, EmitEvents extends EventsMap, ServerSideEvents extends EventsMap, SocketData> {
     11    connect: (socket: Socket<ListenEvents, EmitEvents, ServerSideEvents, SocketData>) => void;
     12    connection: (socket: Socket<ListenEvents, EmitEvents, ServerSideEvents, SocketData>) => void;
     13}
     14export interface ServerReservedEventsMap<ListenEvents, EmitEvents, ServerSideEvents, SocketData> extends NamespaceReservedEventsMap<ListenEvents, EmitEvents, ServerSideEvents, SocketData> {
     15    new_namespace: (namespace: Namespace<ListenEvents, EmitEvents, ServerSideEvents, SocketData>) => void;
     16}
     17export declare const RESERVED_EVENTS: ReadonlySet<string | Symbol>;
     18export declare class Namespace<ListenEvents extends EventsMap = DefaultEventsMap, EmitEvents extends EventsMap = ListenEvents, ServerSideEvents extends EventsMap = DefaultEventsMap, SocketData = any> extends StrictEventEmitter<ServerSideEvents, EmitEvents, NamespaceReservedEventsMap<ListenEvents, EmitEvents, ServerSideEvents, SocketData>> {
    1119    readonly name: string;
    12     readonly sockets: Map<SocketId, Socket>;
     20    readonly sockets: Map<SocketId, Socket<ListenEvents, EmitEvents, ServerSideEvents, SocketData>>;
    1321    adapter: Adapter;
    1422    /** @private */
    15     readonly server: Server;
     23    readonly server: Server<ListenEvents, EmitEvents, ServerSideEvents, SocketData>;
    1624    /** @private */
    17     _fns: Array<(socket: Socket, next: (err?: ExtendedError) => void) => void>;
    18     /** @private */
    19     _rooms: Set<Room>;
    20     /** @private */
    21     _flags: any;
     25    _fns: Array<(socket: Socket<ListenEvents, EmitEvents, ServerSideEvents, SocketData>, next: (err?: ExtendedError) => void) => void>;
    2226    /** @private */
    2327    _ids: number;
    … …  
    2832     * @param name
    2933     */
    30     constructor(server: Server, name: string);
     34    constructor(server: Server<ListenEvents, EmitEvents, ServerSideEvents, SocketData>, name: string);
    3135    /**
    3236     * Initializes the `Adapter` for this nsp.
    … …  
    4347     * @public
    4448     */
    45     use(fn: (socket: Socket, next: (err?: ExtendedError) => void) => void): this;
     49    use(fn: (socket: Socket<ListenEvents, EmitEvents, ServerSideEvents, SocketData>, next: (err?: ExtendedError) => void) => void): this;
    4650    /**
    4751     * Executes the middleware for an incoming client.
    … …  
    5559     * Targets a room when emitting.
    5660     *
    57      * @param name
     61     * @param room
    5862     * @return self
    5963     * @public
    6064     */
    61     to(name: Room): this;
     65    to(room: Room | Room[]): BroadcastOperator<EmitEvents>;
    6266    /**
    6367     * Targets a room when emitting.
    6468     *
    65      * @param name
     69     * @param room
    6670     * @return self
    6771     * @public
    6872     */
    69     in(name: Room): this;
     73    in(room: Room | Room[]): BroadcastOperator<EmitEvents>;
     74    /**
     75     * Excludes a room when emitting.
     76     *
     77     * @param room
     78     * @return self
     79     * @public
     80     */
     81    except(room: Room | Room[]): BroadcastOperator<EmitEvents>;
    7082    /**
    7183     * Adds a new client.
    … …  
    7486     * @private
    7587     */
    76     _add(client: Client, query: any, fn?: () => void): Socket;
     88    _add(client: Client<ListenEvents, EmitEvents, ServerSideEvents>, query: any, fn?: () => void): Socket<ListenEvents, EmitEvents, ServerSideEvents, SocketData>;
    7789    /**
    7890     * Removes a client. Called by each `Socket`.
    … …  
    8092     * @private
    8193     */
    82     _remove(socket: Socket): void;
     94    _remove(socket: Socket<ListenEvents, EmitEvents, ServerSideEvents, SocketData>): void;
    8395    /**
    8496     * Emits to all clients.
    … …  
    8799     * @public
    88100     */
    89     emit(ev: string | Symbol, ...args: any[]): true;
     101    emit<Ev extends EventNames<EmitEvents>>(ev: Ev, ...args: EventParams<EmitEvents, Ev>): boolean;
    90102    /**
    91103     * Sends a `message` event to all clients.
    … …  
    94106     * @public
    95107     */
    96     send(...args: readonly any[]): this;
     108    send(...args: EventParams<EmitEvents, "message">): this;
    97109    /**
    98110     * Sends a `message` event to all clients.
    … …  
    101113     * @public
    102114     */
    103     write(...args: readonly any[]): this;
     115    write(...args: EventParams<EmitEvents, "message">): this;
     116    /**
     117     * Emit a packet to other Socket.IO servers
     118     *
     119     * @param ev - the event name
     120     * @param args - an array of arguments, which may include an acknowledgement callback at the end
     121     * @public
     122     */
     123    serverSideEmit<Ev extends EventNames<ServerSideEvents>>(ev: Ev, ...args: EventParams<ServerSideEvents, Ev>): boolean;
     124    /**
     125     * Called when a packet is received from another Socket.IO server
     126     *
     127     * @param args - an array of arguments, which may include an acknowledgement callback at the end
     128     *
     129     * @private
     130     */
     131    _onServerSideEmit(args: [string, ...any[]]): void;
    104132    /**
    105133     * Gets a list of clients.
    … …  
    116144     * @public
    117145     */
    118     compress(compress: boolean): this;
     146    compress(compress: boolean): BroadcastOperator<EmitEvents>;
    119147    /**
    120148     * Sets a modifier for a subsequent event emission that the event data may be lost if the client is not ready to
    … …  
    125153     * @public
    126154     */
    127     get volatile(): this;
     155    get volatile(): BroadcastOperator<EmitEvents>;
    128156    /**
    129157     * Sets a modifier for a subsequent event emission that the event data will only be broadcast to the current node.
    … …  
    132160     * @public
    133161     */
    134     get local(): this;
     162    get local(): BroadcastOperator<EmitEvents>;
     163    /**
     164     * Returns the matching socket instances
     165     *
     166     * @public
     167     */
     168    fetchSockets(): Promise<RemoteSocket<EmitEvents>[]>;
     169    /**
     170     * Makes the matching socket instances join the specified rooms
     171     *
     172     * @param room
     173     * @public
     174     */
     175    socketsJoin(room: Room | Room[]): void;
     176    /**
     177     * Makes the matching socket instances leave the specified rooms
     178     *
     179     * @param room
     180     * @public
     181     */
     182    socketsLeave(room: Room | Room[]): void;
     183    /**
     184     * Makes the matching socket instances disconnect
     185     *
     186     * @param close - whether to close the underlying connection
     187     * @public
     188     */
     189    disconnectSockets(close?: boolean): void;
    135190}
Note: See TracChangeset for help on using the changeset viewer.