Class WebSocketMap

constructor

• new WebSocketMap(mapConstructor?, iterable?): WebSocketMap

• Parameters

  • mapConstructor: (new () => Map<string, Set<WebSocket>>) = Map

    Will be used to instantiate the internal Map.

    • • new (): Map<string, Set<WebSocket>>

      • Returns Map<string, Set<WebSocket>>

  • Optional iterable: Iterable<readonly [string, WebSocket | ReadonlySet<WebSocket>]>

    Entries to add to the map.

  Returns WebSocketMap

Readonly [toStringTag]

size

• get size(): number

• Returns number

  the number of elements in the Map.

[iterator]

• [iterator](): IterableIterator<[string, WebSocket]>

• Iterates over all key/value bindings in this Map.

  Returns IterableIterator<[string, WebSocket]>

add

• add(key, value): WebSocketMap

• Adds the given key/value binding to the Map.

  Parameters

  • key: string

  • value: WebSocket | ReadonlySet<WebSocket>

  Returns WebSocketMap

asMap

• asMap(): ReadonlyMap<string, ReadonlySet<WebSocket>>

• Returns a Readonly Map representation of this Map.

  Returns ReadonlyMap<string, ReadonlySet<WebSocket>>

clear

• clear(): void

• Returns void

delete

• delete(key): boolean

• Parameters

  • key: string

  Returns boolean

  true if an element in the Map existed and has been removed, or false if the element does not exist.

deleteEntry

• deleteEntry(key, value): boolean

• Deletes the given key/value binding from the Map.

  Parameters

  • key: string

  • value: WebSocket

  Returns boolean

distinctKeys

• distinctKeys(): IterableIterator<string>

• Iterates over all distinct keys in this Map.

  Returns IterableIterator<string>

entries

• entries(): IterableIterator<[string, WebSocket]>

• Iterates over all key/value bindings in this Map.

  Returns IterableIterator<[string, WebSocket]>

entrySets

• entrySets(): IterableIterator<[string, ReadonlySet<WebSocket>]>

• Iterates over all distinct keys in this Map, together with a Set of their values.

  Returns IterableIterator<[string, ReadonlySet<WebSocket>]>

forEach

• forEach(callbackfn, thisArg?): void

• Loops over all key/value bindings.

  Parameters

  • callbackfn: ((value, key, map) => void)

    • • (value, key, map): void

      • Parameters

        • value: WebSocket

        • key: string

        • map: SetMultiMap<string, WebSocket>

        Returns void

  • Optional thisArg: unknown

  Returns void

get

• get(key): undefined | ReadonlySet<WebSocket>

• Returns all values stored for the given key. Returns undefined if there are no values for this key.

  Parameters

  • key: string

  Returns undefined | ReadonlySet<WebSocket>

has

• has(key): boolean

• Parameters

  • key: string

  Returns boolean

  boolean indicating whether an element with the specified key exists or not.

hasEntry

• hasEntry(key, value): boolean

• Returns true if this key/value binding exists in the Map.

  Parameters

  • key: string

  • value: WebSocket

  Returns boolean

keys

• keys(): IterableIterator<string>

• Returns an iterable of keys in the map

  Returns IterableIterator<string>

set

• set(key, value): WebSocketMap

• Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

  Parameters

  • key: string

  • value: WebSocket | ReadonlySet<WebSocket>

  Returns WebSocketMap

valueSets

• valueSets(): IterableIterator<ReadonlySet<WebSocket>>

• Iterates over all distinct keys and returns their Set of values.

  Returns IterableIterator<ReadonlySet<WebSocket>>

values

• values(): IterableIterator<WebSocket>

• Iterates over all values in this Map.

  Returns IterableIterator<WebSocket>