SocketSessionData

@tsed/socketio

Usage

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

See /packages/third-parties/socketio/src/types/class/SocketSessionData.ts.

Overview

class SocketSessionData extends Map<string, unknown> {
    get size(): number;
    static get [Symbol.species](): MapConstructor;
    constructor(data: Record<string, unknown>);
    [Symbol.iterator](): IterableIterator<[string, unknown]>;
    clear(): void;
    delete(key: string): boolean;
    entries(): IterableIterator<[string, unknown]>;
    forEach(callbackfn: (value: unknown, key: string, map: Map<string, unknown>) => void, thisArg?: any): void;
    get(key: string): unknown | undefined;
    has(key: string): boolean;
    keys(): IterableIterator<string>;
    set(key: string, value: unknown): this;
    values(): IterableIterator<unknown>;
}

Description

Represents session data associated with a socket connection, providing a compatibility layer with Ts.ED v7 by wrapping a socket.data which is used to archive recoverability and resiliency to a Map instance.

This class implements the Map<string, unknown> interface and provides methods and properties to manage and manipulate session data.

get size

get size(): number;

static get [Symbol.species]

static get [Symbol.species](): MapConstructor;

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<[string, unknown]>;

clear

clear(): void;

delete

delete(key: string): boolean;

entries

entries(): IterableIterator<[string, unknown]>;

forEach

forEach(callbackfn: (value: unknown, key: string, map: Map<string, unknown>) => void, thisArg?: any): void;

get

get(key: string): unknown | undefined;

has

has(key: string): boolean;

keys

keys(): IterableIterator<string>;

set

set(key: string, value: unknown): this;

values

values(): IterableIterator<unknown>;