Class WishMap<K, V>

An extended Map with Array-like methods and event emission.

Type Parameters

K
The type of keys in the map
V
The type of values in the map

Hierarchy

Map<K, V>
- WishMap

Index

Constructors

constructor

new WishMap<K, V>(entries?: readonly (readonly [K, V])[] | null): WishMap<K, V>
Type Parameters
- K
  The type of keys in the map
- V
  The type of values in the map
Parameters
- Optionalentries: readonly (readonly [K, V])[] | null
Returns WishMap<K, V>
Inherited from Map<K, V>.constructor
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.collection.d.ts:50
new WishMap<K, V>(
iterable?: Iterable<readonly [K, V], any, any> | null,
): WishMap<K, V>
Type Parameters
- K
  The type of keys in the map
- V
  The type of values in the map
Parameters
- Optionaliterable: Iterable<readonly [K, V], any, any> | null
Returns WishMap<K, V>
Inherited from Map<K, V>.constructor
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.collection.d.ts:49
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.collection.d.ts:50

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`events

events: EventEmitter<WishMapEvents<K, V>> = ...

Event emitter for map mutations

includes

includes: (key: K) => boolean = ...

Alias for has(). Checks if a key exists in the map.

Type Declaration

- (key: K): boolean
- Parameters
  - key: K
  Returns boolean
  boolean indicating whether an element with the specified key exists or not.

off

off: <E extends string | symbol>(
    eventName: "delete" | "set" | (keyof EventEmitterEventMap) | E,
    listener: (
        ...args: E extends keyof WishMapEvents<K, V>
            ? WishMapEvents<K, V>[E<E>]
            : E extends keyof EventEmitterEventMap
                ? EventEmitterEventMap[E<E>]
                : any[],
    ) => void,
) => this = ...

Type Declaration

- <E extends string | symbol>(
      eventName: "delete" | "set" | (keyof EventEmitterEventMap) | E,
      listener: (
          ...args: E extends keyof WishMapEvents<K, V>
              ? WishMapEvents<K, V>[E<E>]
              : E extends keyof EventEmitterEventMap
                  ? EventEmitterEventMap[E<E>]
                  : any[],
      ) => void,
  ): this
- Alias for emitter.removeListener().
  Type Parameters
  - E extends string | symbol
  Parameters
  - eventName: "delete" | "set" | (keyof EventEmitterEventMap) | E
  - listener: (
        ...args: E extends keyof WishMapEvents<K, V>
            ? WishMapEvents<K, V>[E<E>]
            : E extends keyof EventEmitterEventMap
                ? EventEmitterEventMap[E<E>]
                : any[],
    ) => void
  Returns this
  Since
  v10.0.0

on

on: <E extends string | symbol>(
    eventName: "delete" | "set" | (keyof EventEmitterEventMap) | E,
    listener: (
        ...args: E extends keyof WishMapEvents<K, V>
            ? WishMapEvents<K, V>[E<E>]
            : E extends keyof EventEmitterEventMap
                ? EventEmitterEventMap[E<E>]
                : any[],
    ) => void,
) => this = ...

Type Declaration

- <E extends string | symbol>(
      eventName: "delete" | "set" | (keyof EventEmitterEventMap) | E,
      listener: (
          ...args: E extends keyof WishMapEvents<K, V>
              ? WishMapEvents<K, V>[E<E>]
              : E extends keyof EventEmitterEventMap
                  ? EventEmitterEventMap[E<E>]
                  : any[],
      ) => void,
  ): this
- Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
```
server.on('connection', (stream) => {
  console.log('someone connected!');
});
```
  Returns a reference to the EventEmitter, so that calls can be chained.
  
  By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.
```
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a
```
  Type Parameters
  - E extends string | symbol
  Parameters
  - eventName: "delete" | "set" | (keyof EventEmitterEventMap) | E
    The name of the event.
  - listener: (
        ...args: E extends keyof WishMapEvents<K, V>
            ? WishMapEvents<K, V>[E<E>]
            : E extends keyof EventEmitterEventMap
                ? EventEmitterEventMap[E<E>]
                : any[],
    ) => void
    The callback function
  Returns this
  Since
  v0.1.101

once

once: <E extends string | symbol>(
    eventName: "delete" | "set" | (keyof EventEmitterEventMap) | E,
    listener: (
        ...args: E extends keyof WishMapEvents<K, V>
            ? WishMapEvents<K, V>[E<E>]
            : E extends keyof EventEmitterEventMap
                ? EventEmitterEventMap[E<E>]
                : any[],
    ) => void,
) => this = ...

Type Declaration

- <E extends string | symbol>(
      eventName: "delete" | "set" | (keyof EventEmitterEventMap) | E,
      listener: (
          ...args: E extends keyof WishMapEvents<K, V>
              ? WishMapEvents<K, V>[E<E>]
              : E extends keyof EventEmitterEventMap
                  ? EventEmitterEventMap[E<E>]
                  : any[],
      ) => void,
  ): this
- Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.
```
server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});
```
  Returns a reference to the EventEmitter, so that calls can be chained.
  
  By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.
```
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a
```
  Type Parameters
  - E extends string | symbol
  Parameters
  - eventName: "delete" | "set" | (keyof EventEmitterEventMap) | E
    The name of the event.
  - listener: (
        ...args: E extends keyof WishMapEvents<K, V>
            ? WishMapEvents<K, V>[E<E>]
            : E extends keyof EventEmitterEventMap
                ? EventEmitterEventMap[E<E>]
                : any[],
    ) => void
    The callback function
  Returns this
  Since
  v0.3.0

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly`[species]

"[species]": MapConstructor

Accessors

length

get length(): number
Returns the number of entries (alias for size).

Returns number
- Defined in work/WishMap/WishMap/src/index.ts:452

Methods

[iterator]

"[iterator]"(): MapIterator<[K, V]>
Returns an iterable of entries in the map.

Returns MapIterator<[K, V]>
Inherited from Map.[iterator]
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

at

at(index: number): V | undefined
Returns the value at the given index. Supports negative indices.
Parameters
- index: number
  The index of the value to return
Returns V | undefined
- Defined in work/WishMap/WishMap/src/index.ts:43

clear

clear(): void
Returns void
Inherited from Map.clear
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.collection.d.ts:20

concat

concat(...maps: Map<K, V>[]): WishMap<K, V>
Merges this map with one or more other maps.
Parameters
- ...maps: Map<K, V>[]
  Maps to merge with this one
Returns WishMap<K, V>
A new WishMap containing all entries
- Defined in work/WishMap/WishMap/src/index.ts:54

copyWithin

copyWithin(target: number, start: number, end?: number): this
Copies a sequence of entries within the map.
Parameters
- target: number
  Index to copy entries to
- start: number
  Index to start copying from
- Optionalend: number
  Index to stop copying from (exclusive)
Returns this
- Defined in work/WishMap/WishMap/src/index.ts:72

delete

delete(key: K): boolean
Removes the specified element from the map.
Parameters
- key: K
Returns boolean
Fires
WishMap#delete
Overrides Map.delete
- Defined in work/WishMap/WishMap/src/index.ts:22

entries

entries(): MapIterator<[K, V]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[K, V]>
Inherited from Map.entries
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.iterable.d.ts:148

every

every(fn: (value: V, key: K) => boolean): boolean
Tests whether all entries pass the provided function.
Parameters
- fn: (value: V, key: K) => boolean
  Function to test each entry
Returns boolean
- Defined in work/WishMap/WishMap/src/index.ts:87

fill

fill(value: V, start?: number, end?: number): this
Fills entries with a value from start to end index.
Parameters
- value: V
  Value to fill with
- start: number = 0
  Start index (default: 0)
- end: number = ...
  End index (default: size)
Returns this
- Defined in work/WishMap/WishMap/src/index.ts:102

filter

filter(fn: (value: V, key: K) => boolean): WishMap<K, V>
Creates a new WishMap with entries that pass the provided function.
Parameters
- fn: (value: V, key: K) => boolean
  Function to test each entry
Returns WishMap<K, V>
- Defined in work/WishMap/WishMap/src/index.ts:116

find

find(fn: (value: V, key: K) => boolean): V | undefined
Returns the first value that passes the provided function.
Parameters
- fn: (value: V, key: K) => boolean
  Function to test each entry
Returns V | undefined
- Defined in work/WishMap/WishMap/src/index.ts:130

findIndex

findIndex(fn: (value: V, key: K) => boolean): number
Returns the index of the first entry that passes the provided function.
Parameters
- fn: (value: V, key: K) => boolean
  Function to test each entry
Returns number
Index of the first match, or -1 if not found
- Defined in work/WishMap/WishMap/src/index.ts:142

findLast

findLast(fn: (value: V, key: K) => boolean): V | undefined
Returns the last value that passes the provided function.
Parameters
- fn: (value: V, key: K) => boolean
  Function to test each entry
Returns V | undefined
- Defined in work/WishMap/WishMap/src/index.ts:157

findLastIndex

findLastIndex(fn: (value: V, key: K) => boolean): number
Returns the index of the last entry that passes the provided function.
Parameters
- fn: (value: V, key: K) => boolean
  Function to test each entry
Returns number
Index of the last match, or -1 if not found
- Defined in work/WishMap/WishMap/src/index.ts:171

flat

flat<D extends number = 1>(depth?: D): unknown[]
Flattens nested arrays in values to a specified depth.
Type Parameters
- D extends number = 1
Parameters
- Optionaldepth: D
  Depth level to flatten (default: 1)
Returns unknown[]
- Defined in work/WishMap/WishMap/src/index.ts:187

flatMap

flatMap<T>(fn: (value: V, key: K) => T | T[]): T[]
Maps each entry then flattens the result.
Type Parameters
- T
Parameters
- fn: (value: V, key: K) => T | T[]
  Function that returns a value or array of values
Returns T[]
- Defined in work/WishMap/WishMap/src/index.ts:196

forEach

forEach(
callbackfn: (value: V, key: K, map: Map<K, V>) => void,
thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: V, key: K, map: Map<K, V>) => void
- OptionalthisArg: any
Returns void
Inherited from Map.forEach
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get(key: K): V | undefined
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: K
Returns V | undefined
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Inherited from Map.get
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.collection.d.ts:33

has

has(key: K): boolean
Parameters
- key: K
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Map.has
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.collection.d.ts:37

indexOf

indexOf(value: V, fromIndex?: number): number
Returns the first index of a value.
Parameters
- value: V
  Value to search for
- fromIndex: number = 0
  Index to start searching from (default: 0)
Returns number
- Defined in work/WishMap/WishMap/src/index.ts:209

join

join(separator?: string): string
Joins all values into a string.
Parameters
- separator: string = ','
  Separator between values (default: ',')
Returns string
- Defined in work/WishMap/WishMap/src/index.ts:219

keys

keys(): MapIterator<K>
Returns an iterable of keys in the map

Returns MapIterator<K>
Inherited from Map.keys
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.iterable.d.ts:153

lastIndexOf

lastIndexOf(value: V, fromIndex?: number): number
Returns the last index of a value.
Parameters
- value: V
  Value to search for
- fromIndex: number = ...
  Index to start searching backwards from
Returns number
- Defined in work/WishMap/WishMap/src/index.ts:229

map

map<T>(fn: (value: V, key: K) => T): T[]
Creates an array by applying a function to each entry.
Type Parameters
- T
Parameters
- fn: (value: V, key: K) => T
  Function to apply to each entry
Returns T[]
- Defined in work/WishMap/WishMap/src/index.ts:239

pop

pop(): V | undefined
Removes and returns the last value.

Returns V | undefined
The removed value, or undefined if empty
- Defined in work/WishMap/WishMap/src/index.ts:248

push

push(...items: [K, V][]): number
Adds entries to the end of the map.
Parameters
- ...items: [K, V][]
  Entries as [key, value] tuples
Returns number
The new size of the map
- Defined in work/WishMap/WishMap/src/index.ts:264

reduce

reduce<T>(fn: (acc: T, value: V, key: K) => T, initial: T): T
Reduces entries to a single value, from left to right.
Type Parameters
- T
Parameters
- fn: (acc: T, value: V, key: K) => T
  Reducer function
- initial: T
  Initial accumulator value
Returns T
- Defined in work/WishMap/WishMap/src/index.ts:275

reduceRight

reduceRight<T>(fn: (acc: T, value: V, key: K) => T, initial: T): T
Reduces entries to a single value, from right to left.
Type Parameters
- T
Parameters
- fn: (acc: T, value: V, key: K) => T
  Reducer function
- initial: T
  Initial accumulator value
Returns T
- Defined in work/WishMap/WishMap/src/index.ts:290

reverse

reverse(): this
Reverses the order of entries in place.

Returns this
- Defined in work/WishMap/WishMap/src/index.ts:303

set

set(key: K, value: V): this
Adds or updates an element with a specified key and value.
Parameters
- key: K
- value: V
Returns this
Fires
WishMap#set
Overrides Map.set
- Defined in work/WishMap/WishMap/src/index.ts:33

shift

shift(): V | undefined
Removes and returns the first value.

Returns V | undefined
The removed value, or undefined if empty
- Defined in work/WishMap/WishMap/src/index.ts:317

slice

slice(start?: number, end?: number): WishMap<K, V>
Returns a new WishMap with a portion of entries.
Parameters
- start: number = 0
  Start index (default: 0)
- end: number = ...
  End index (default: size)
Returns WishMap<K, V>
- Defined in work/WishMap/WishMap/src/index.ts:333

some

some(fn: (value: V, key: K) => boolean): boolean
Tests whether any entry passes the provided function.
Parameters
- fn: (value: V, key: K) => boolean
  Function to test each entry
Returns boolean
- Defined in work/WishMap/WishMap/src/index.ts:343

sort

sort(fn?: (a: [K, V], b: [K, V]) => number): this
Sorts entries in place.
Parameters
- Optionalfn: (a: [K, V], b: [K, V]) => number
  Compare function for [key, value] tuples
Returns this
- Defined in work/WishMap/WishMap/src/index.ts:356

splice

splice(start: number, deleteCount?: number, ...items: [K, V][]): WishMap<K, V>
Removes and/or adds entries at a given index.
Parameters
- start: number
  Index to start changes
- OptionaldeleteCount: number
  Number of entries to remove
- ...items: [K, V][]
  Entries to add as [key, value] tuples
Returns WishMap<K, V>
A WishMap containing the removed entries
- Defined in work/WishMap/WishMap/src/index.ts:373

toLocaleString

toLocaleString(): string
Returns a locale-specific string representation of values.

Returns string
- Defined in work/WishMap/WishMap/src/index.ts:384

toReversed

toReversed(): WishMap<K, V>
Returns a new WishMap with entries in reverse order.

Returns WishMap<K, V>
- Defined in work/WishMap/WishMap/src/index.ts:389

toSorted

toSorted(fn?: (a: [K, V], b: [K, V]) => number): WishMap<K, V>
Returns a new sorted WishMap.
Parameters
- Optionalfn: (a: [K, V], b: [K, V]) => number
  Compare function for [key, value] tuples
Returns WishMap<K, V>
- Defined in work/WishMap/WishMap/src/index.ts:398

toSpliced

toSpliced(
    start: number,
    deleteCount?: number,
    ...items: [K, V][],
): WishMap<K, V>
Returns a new WishMap with entries removed and/or added.
Parameters
- start: number
  Index to start changes
- OptionaldeleteCount: number
  Number of entries to remove
- ...items: [K, V][]
  Entries to add as [key, value] tuples
Returns WishMap<K, V>
- Defined in work/WishMap/WishMap/src/index.ts:410

toString

toString(): string
Returns a string representation of values.

Returns string
- Defined in work/WishMap/WishMap/src/index.ts:417

unshift

unshift(...items: [K, V][]): number
Adds entries to the beginning of the map.
Parameters
- ...items: [K, V][]
  Entries as [key, value] tuples
Returns number
The new size of the map
- Defined in work/WishMap/WishMap/src/index.ts:427

values

values(): MapIterator<V>
Returns an iterable of values in the map

Returns MapIterator<V>
Inherited from Map.values
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.iterable.d.ts:158

with

with(index: number, value: V): WishMap<K, V>
Returns a new WishMap with the value at the given index replaced.
Parameters
- index: number
  Index of the entry to replace
- value: V
  New value
Returns WishMap<K, V>
- Defined in work/WishMap/WishMap/src/index.ts:443

`Static`groupBy

groupBy<K, T>(
items: Iterable<T>,
keySelector: (item: T, index: number) => K,
): Map<K, T[]>
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
- K
- T
Parameters
- items: Iterable<T>
  An iterable.
- keySelector: (item: T, index: number) => K
  A callback which will be invoked for each item in items.
Returns Map<K, T[]>
Inherited from Map.groupBy
- Defined in .npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2024.collection.d.ts:25

Class WishMap<K, V>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WishMap<K, V>

Type Parameters

Parameters

Returns WishMap<K, V>

Properties

Readonly[toStringTag]

Readonlyevents

includes

Type Declaration

Parameters

Returns boolean

off

Type Declaration

Type Parameters

Parameters

Returns this

Since

on

Type Declaration

Type Parameters

Parameters

Returns this

Since

once

Type Declaration

Type Parameters

Parameters

Returns this

Since

Readonlysize

Returns

Static Readonly[species]

Accessors

length

Returns number

Methods

[iterator]

Returns MapIterator<[K, V]>

at

Parameters

Returns V | undefined

clear

Returns void

concat

Parameters

Returns WishMap<K, V>

copyWithin

Parameters

Returns this

delete

Parameters

Returns boolean

Fires

entries

Returns MapIterator<[K, V]>

every

Parameters

Returns boolean

fill

Parameters

Returns this

filter

Parameters

Returns WishMap<K, V>

find

Parameters

Returns V | undefined

findIndex

`Readonly`[toStringTag]

`Readonly`events

`Readonly`size

`Static` `Readonly`[species]