Changeset e29cc2e for trip-planner-front/node_modules/socket.io/dist/socket.d.ts

Timestamp:

11/25/21 22:08:24 (3 years ago)

Author:

Ema <ema_spirova@…>

Branches:

master

Children:

8d391a1

Parents:

59329aa

Message:

primeNG components

File:

• trip-planner-front/node_modules/socket.io/dist/socket.d.ts (modified) (15 diffs)

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

@@ -1 +1 @@
 /// <reference types="node" />
-import { EventEmitter } from "events";
 import { Packet } from "socket.io-parser";
+import { EventParams, EventNames, EventsMap, StrictEventEmitter, DefaultEventsMap } from "./typed-events";
 import type { Client } from "./client";
 import type { Namespace } from "./namespace";
@@ -7 +7 @@
 import type { Room, SocketId } from "socket.io-adapter";
 import type { ParsedUrlQuery } from "querystring";
+import { BroadcastOperator } from "./broadcast-operator";
+export interface SocketReservedEventsMap {
+    disconnect: (reason: string) => void;
+    disconnecting: (reason: string) => void;
+    error: (err: Error) => void;
+}
+export interface EventEmitterReservedEventsMap {
+    newListener: (eventName: string | Symbol, listener: (...args: any[]) => void) => void;
+    removeListener: (eventName: string | Symbol, listener: (...args: any[]) => void) => void;
+}
 export declare const RESERVED_EVENTS: ReadonlySet<string | Symbol>;
 /**
@@ -51 +61 @@
     };
 }
-export declare class Socket extends EventEmitter {
-    readonly nsp: Namespace;
-    readonly client: Client;
+declare type Event = [eventName: string, ...args: any[]];
+export declare class Socket<ListenEvents extends EventsMap = DefaultEventsMap, EmitEvents extends EventsMap = ListenEvents, ServerSideEvents extends EventsMap = DefaultEventsMap, SocketData = any> extends StrictEventEmitter<ListenEvents, EmitEvents, SocketReservedEventsMap> {
+    readonly nsp: Namespace<ListenEvents, EmitEvents, ServerSideEvents>;
+    readonly client: Client<ListenEvents, EmitEvents, ServerSideEvents>;
     readonly id: SocketId;
     readonly handshake: Handshake;
+    /**
+     * Additional information that can be attached to the Socket instance and which will be used in the fetchSockets method
+     */
+    data: Partial<SocketData>;
     connected: boolean;
-    disconnected: boolean;
     private readonly server;
     private readonly adapter;
@@ -63 +77 @@
     private fns;
     private flags;
-    private _rooms;
     private _anyListeners?;
     /**
@@ -73 +86 @@
      * @package
      */
-    constructor(nsp: Namespace, client: Client, auth: object);
+    constructor(nsp: Namespace<ListenEvents, EmitEvents, ServerSideEvents>, client: Client<ListenEvents, EmitEvents, ServerSideEvents>, auth: object);
     /**
      * Builds the `handshake` BC object
@@ -86 +99 @@
      * @public
      */
-    emit(ev: string, ...args: any[]): boolean;
+    emit<Ev extends EventNames<EmitEvents>>(ev: Ev, ...args: EventParams<EmitEvents, Ev>): boolean;
+    /**
+     * @private
+     */
+    private registerAckCallback;
     /**
      * Targets a room when broadcasting.
      *
-     * @param name
-     * @return self
-     * @public
-     */
-    to(name: Room): this;
+     * @param room
+     * @return self
+     * @public
+     */
+    to(room: Room | Room[]): BroadcastOperator<EmitEvents>;
     /**
      * Targets a room when broadcasting.
      *
-     * @param name
-     * @return self
-     * @public
-     */
-    in(name: Room): this;
+     * @param room
+     * @return self
+     * @public
+     */
+    in(room: Room | Room[]): BroadcastOperator<EmitEvents>;
+    /**
+     * Excludes a room when broadcasting.
+     *
+     * @param room
+     * @return self
+     * @public
+     */
+    except(room: Room | Room[]): BroadcastOperator<EmitEvents>;
     /**
      * Sends a `message` event.
@@ -109 +134 @@
      * @public
      */
-    send(...args: readonly any[]): this;
+    send(...args: EventParams<EmitEvents, "message">): this;
     /**
      * Sends a `message` event.
@@ -116 +141 @@
      * @public
      */
-    write(...args: readonly any[]): this;
+    write(...args: EventParams<EmitEvents, "message">): this;
     /**
      * Writes a packet.
@@ -194 +219 @@
      * @private
      */
-    _onerror(err: any): void;
+    _onerror(err: Error): void;
     /**
      * Called upon closing. Called by `Client`.
@@ -245 +270 @@
      * @public
      */
-    get broadcast(): this;
+    get broadcast(): BroadcastOperator<EmitEvents>;
     /**
      * Sets a modifier for a subsequent event emission that the event data will only be broadcast to the current node.
@@ -252 +277 @@
      * @public
      */
-    get local(): this;
+    get local(): BroadcastOperator<EmitEvents>;
+    /**
+     * Sets a modifier for a subsequent event emission that the callback will be called with an error when the
+     * given number of milliseconds have elapsed without an acknowledgement from the client:
+     *
+     * ```
+     * socket.timeout(5000).emit("my-event", (err) => {
+     *   if (err) {
+     *     // the client did not acknowledge the event in the given delay
+     *   }
+     * });
+     * ```
+     *
+     * @returns self
+     * @public
+     */
+    timeout(timeout: number): this;
     /**
      * Dispatch incoming event to socket listeners.
@@ -267 +308 @@
      * @public
      */
-    use(fn: (event: Array<any>, next: (err: Error) => void) => void): this;
+    use(fn: (event: Event, next: (err?: Error) => void) => void): this;
     /**
      * Executes the middleware for an incoming event.
@@ -277 +318 @@
     private run;
     /**
+     * Whether the socket is currently disconnected
+     */
+    get disconnected(): boolean;
+    /**
      * A reference to the request that originated the underlying Engine.IO Socket.
      *
@@ -287 +332 @@
      * @public
      */
-    get conn(): any;
+    get conn(): import("engine.io").Socket;
     /**
      * @public
@@ -322 +367 @@
      */
     listenersAny(): ((...args: any[]) => void)[];
+    private newBroadcastOperator;
 }
+export {};