/var/www/qr4y.com/server/delivery/node_modules/socket.io/dist
Edit: /var/www/qr4y.com/server/delivery/node_modules/socket.io/dist/namespace.d.ts (6968B)
import { Socket } from "./socket";
import type { Server } from "./index";
import { EventParams, EventNames, EventsMap, StrictEventEmitter, DefaultEventsMap } from "./typed-events";
import type { Client } from "./client";
import type { Adapter, Room, SocketId } from "socket.io-adapter";
import { BroadcastOperator, RemoteSocket } from "./broadcast-operator";
export interface ExtendedError extends Error {
data?: any;
}
export interface NamespaceReservedEventsMap
{
connect: (socket: Socket) => void;
connection: (socket: Socket) => void;
}
export interface ServerReservedEventsMap extends NamespaceReservedEventsMap {
new_namespace: (namespace: Namespace) => void;
}
export declare const RESERVED_EVENTS: ReadonlySet;
export declare class Namespace extends StrictEventEmitter> {
readonly name: string;
readonly sockets: Map>;
adapter: Adapter;
/** @private */
readonly server: Server;
/** @private */
_fns: Array<(socket: Socket, next: (err?: ExtendedError) => void) => void>;
/** @private */
_ids: number;
/**
* Namespace constructor.
*
* @param server instance
* @param name
*/
constructor(server: Server, name: string);
/**
* Initializes the `Adapter` for this nsp.
* Run upon changing adapter by `Server#adapter`
* in addition to the constructor.
*
* @private
*/
_initAdapter(): void;
/**
* Sets up namespace middleware.
*
* @return self
* @public
*/
use(fn: (socket: Socket, next: (err?: ExtendedError) => void) => void): this;
/**
* Executes the middleware for an incoming client.
*
* @param socket - the socket that will get added
* @param fn - last fn call in the middleware
* @private
*/
private run;
/**
* Targets a room when emitting.
*
* @param room
* @return self
* @public
*/
to(room: Room | Room[]): BroadcastOperator;
/**
* Targets a room when emitting.
*
* @param room
* @return self
* @public
*/
in(room: Room | Room[]): BroadcastOperator;
/**
* Excludes a room when emitting.
*
* @param room
* @return self
* @public
*/
except(room: Room | Room[]): BroadcastOperator;
/**
* Adds a new client.
*
* @return {Socket}
* @private
*/
_add(client: Client, query: any, fn?: () => void): Socket;
/**
* Removes a client. Called by each `Socket`.
*
* @private
*/
_remove(socket: Socket): void;
/**
* Emits to all clients.
*
* @return Always true
* @public
*/
emit>(ev: Ev, ...args: EventParams): boolean;
/**
* Sends a `message` event to all clients.
*
* @return self
* @public
*/
send(...args: EventParams): this;
/**
* Sends a `message` event to all clients.
*
* @return self
* @public
*/
write(...args: EventParams): this;
/**
* Emit a packet to other Socket.IO servers
*
* @param ev - the event name
* @param args - an array of arguments, which may include an acknowledgement callback at the end
* @public
*/
serverSideEmit>(ev: Ev, ...args: EventParams): boolean;
/**
* Called when a packet is received from another Socket.IO server
*
* @param args - an array of arguments, which may include an acknowledgement callback at the end
*
* @private
*/
_onServerSideEmit(args: [string, ...any[]]): void;
/**
* Gets a list of clients.
*
* @return self
* @public
*/
allSockets(): Promise>;
/**
* Sets the compress flag.
*
* @param compress - if `true`, compresses the sending data
* @return self
* @public
*/
compress(compress: boolean): BroadcastOperator;
/**
* Sets a modifier for a subsequent event emission that the event data may be lost if the client is not ready to
* receive messages (because of network slowness or other issues, or because they’re connected through long polling
* and is in the middle of a request-response cycle).
*
* @return self
* @public
*/
get volatile(): BroadcastOperator;
/**
* Sets a modifier for a subsequent event emission that the event data will only be broadcast to the current node.
*
* @return self
* @public
*/
get local(): BroadcastOperator;
/**
* Adds a timeout in milliseconds for the next operation
*
*
*
* io.timeout(1000).emit("some-event", (err, responses) => {
* // ...
* });
*
*
*
* @param timeout
*/
timeout(timeout: number): BroadcastOperator;
/**
* Returns the matching socket instances
*
* @public
*/
fetchSockets(): Promise[]>;
/**
* Makes the matching socket instances join the specified rooms
*
* @param room
* @public
*/
socketsJoin(room: Room | Room[]): void;
/**
* Makes the matching socket instances leave the specified rooms
*
* @param room
* @public
*/
socketsLeave(room: Room | Room[]): void;
/**
* Makes the matching socket instances disconnect
*
* @param close - whether to close the underlying connection
* @public
*/
disconnectSockets(close?: boolean): void;
}