Class ExtendedMap<K, V>

A Map with additional methods. Similar to that of discord.js's collection

Type Parameters

Hierarchy

Map<K, V>
- ExtendedMap

Index

Constructors

constructor

new ExtendedMap<K, V>(
entries?: null | readonly (readonly [K, V])[],
): ExtendedMap<K, V>
Type Parameters
- K
- V
Parameters
- Optionalentries: null | readonly (readonly [K, V])[]
Returns ExtendedMap<K, V>
Inherited from Map<K, V>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:50
new ExtendedMap<K, V>(
iterable?: null | Iterable<readonly [K, V], any, any>,
): ExtendedMap<K, V>
Type Parameters
- K
- V
Parameters
- Optionaliterable: null | Iterable<readonly [K, V], any, any>
Returns ExtendedMap<K, V>
Inherited from Map<K, V>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:49
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:50

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

constructor

constructor: ExtendedMapConstructor

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

`Static` `Readonly`[species]

"[species]": MapConstructor

Accessors

size

get size(): number
The number of elements in the map. Derived from Map#size.

Returns number
Inherited from Map.size
- Defined in src/utils/ExtendedMap.ts:29

Methods

[iterator]

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

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

at

at(index: number): undefined | V
Returns the element of the element at an index of the map. Similar to Array#at().
Parameters
- index: number
  The index of the element.
Returns undefined | V
The found element, or undefined if no element matches the index.
- Defined in src/utils/ExtendedMap.ts:131

clear

clear(): this
Removes all elements from the map. Derived from the Map#clear() method, however this is returned instead of void.

Returns this
The map.
Inherited from Map.clear
- Defined in src/utils/ExtendedMap.ts:38

clone

clone(): ExtendedMap<K, V>
Creates a shallow clone of the map.

Returns ExtendedMap<K, V>
The clone of the map.
- Defined in src/utils/ExtendedMap.ts:335

concat

concat(...maps: (Map<K, V> | [K, V])[]): ExtendedMap<K, V>
Merges the map with one or more other maps, or a key / value pair. Similar to Array#concat().
Parameters
- ...maps: (Map<K, V> | [K, V])[]
  The maps to merge.
Returns ExtendedMap<K, V>
The merged map.
- Defined in src/utils/ExtendedMap.ts:141

delete

delete(key: K): boolean
Removes a specified element from the map. Derived from the Map#delete() method.
Parameters
- key: K
  The key of the element to remove.
Returns boolean
If the element was removed, false if it does not exist.
Inherited from Map.delete
- Defined in src/utils/ExtendedMap.ts:49

entries

entries(): MapIterator<[K, V]>
Returns a new iterator object that contains key value pairs for each element in the map. Derived from the Map#entries() method.

Returns MapIterator<[K, V]>
The new iterator object.
Inherited from Map.entries
- Defined in src/utils/ExtendedMap.ts:58

every

every(
callbackfn: (value: V, key: K, map: this) => boolean,
thisArg?: any,
): boolean
Tests if all elements in the map satisfy a test specified in the callback. Similar to Array#every().
Parameters
- callbackfn: (value: V, key: K, map: this) => boolean
  A function to test every element of the map.
- OptionalthisArg: any
  A value to use as this when executing callbackfn.
Returns boolean
true if all elements pass the callback test, false otherwise.
- Defined in src/utils/ExtendedMap.ts:160

fill

fill(value: V): this
Sets every element of the map to the specified value. Similar to Array#fill().
Parameters
- value: V
  The value to set all elements of the map to.
Returns this
The map.
- Defined in src/utils/ExtendedMap.ts:174

filter

filter(
callbackfn: (value: V, key: K, map: this) => boolean,
thisArg?: any,
): ExtendedMap<K, V>
Creates a new map with all elements that pass a test specified in the callback. Similar to Array#filter().
Parameters
- callbackfn: (value: V, key: K, map: this) => boolean
  A function to test every element of the map.
- OptionalthisArg: any
  A value to use as this when executing callbackfn.
Returns ExtendedMap<K, V>
A map with elements that passed the provided test.
- Defined in src/utils/ExtendedMap.ts:186

find

find(
callbackfn: (value: V, key: K, map: this) => boolean,
thisArg?: any,
): undefined | V
Returns the first element in the map that satisfies the provided test. Similar to Array#find().
Parameters
- callbackfn: (value: V, key: K, map: this) => boolean
  A function to test every element of the map.
- OptionalthisArg: any
  A value to use as this when executing callbackfn.
Returns undefined | V
The first element that satisfies the test. If no element is found, undefined is returned.
- Defined in src/utils/ExtendedMap.ts:202

findKey

findKey(
callbackfn: (value: V, key: K, map: this) => boolean,
thisArg?: any,
): undefined | K
Returns the first key in the map that satisfies the provided test. Similar to Array#findIndex().
Parameters
- callbackfn: (value: V, key: K, map: this) => boolean
  A function to test every element of the map.
- OptionalthisArg: any
  A value to use as this when executing callbackfn.
Returns undefined | K
The first key that satisfies the test. If no element is found, undefined is returned.
- Defined in src/utils/ExtendedMap.ts:217

first

first(): undefined | V
Returns the first value(s) of the map.

Returns undefined | V
The first value if no amount is specified, else an array of the first values.
- Defined in src/utils/ExtendedMap.ts:322
first(amount: number): V[]
Returns the first value(s) of the map.
Parameters
- amount: number
  The number of items to retrieve from the start of the map.
Returns V[]
The first value if no amount is specified, else an array of the first values.
- Defined in src/utils/ExtendedMap.ts:323

flatMap

flatMap<T>(
callbackfn: (value: V, key: K, map: this) => ExtendedMap<K, T>,
thisArg?: any,
): ExtendedMap<K, T>
Returns a new map created by applying a specified callback function to each element of the map, then flattening the result by 1 level. Identical to ExtendedMap#map() followed by flattening by a depth of 1. Similar to Array#flatMap().
Type Parameters
- T
Parameters
- callbackfn: (value: V, key: K, map: this) => ExtendedMap<K, T>
  A function to apply to every element of the map.
- OptionalthisArg: any
  A value to use as this when executing callbackfn.
Returns ExtendedMap<K, T>
The new map.
- Defined in src/utils/ExtendedMap.ts:233

forEach

forEach(
callbackfn: (value: V, key: K, map: Map<K, V>) => void,
thisArg?: any,
): this
Executes the provided function once for each element in the map. Derived from the Map#forEach() method, however this is returned instead of void.
Parameters
- callbackfn: (value: V, key: K, map: Map<K, V>) => void
  The function to execute for each element in the map.
- OptionalthisArg: any
  A value to use as this when executing callbackfn.
Returns this
The map.
Inherited from Map.forEach
- Defined in src/utils/ExtendedMap.ts:69

get

get(key: K): undefined | V
Returns a specified element from the map. Derived from the Map#get() method.
Parameters
- key: K
  The key of the element.
Returns undefined | V
The element with the specified key, or undefined if no element matches the key.
Inherited from Map.get
- Defined in src/utils/ExtendedMap.ts:80

has

has(key: K): boolean
Checks if the map has an element with the specified key. Derived from the Map#has() method.
Parameters
- key: K
  The key to test.
Returns boolean
true if an element is found, false otherwise.
Inherited from Map.has
- Defined in src/utils/ExtendedMap.ts:90

join

join(separator?: string): string
Creates a string by concatenating the values of all elements of the map.
Parameters
- separator: string = ...
  A string to separate values by. Defaults to ,.
Returns string
The created strings.
- Defined in src/utils/ExtendedMap.ts:246

joinKeys

joinKeys(separator?: string): string
Creates a string by concatenating the keys of all elements of the map.
Parameters
- separator: string = ...
  A string to separate keys by. Defaults to ,.
Returns string
The created strings.
- Defined in src/utils/ExtendedMap.ts:255

keys

keys(): MapIterator<K>
Returns a new iterator object that contains keys for each element in the map. Derived from the Map#keys() method.

Returns MapIterator<K>
The new iterator object.
Inherited from Map.keys
- Defined in src/utils/ExtendedMap.ts:99

map

map<T>(callbackfn: (value: V, key: K, map: this) => T, thisArg?: any): T[]
Creates an array filled with the results from calling a specified callback function on each element of the map. Similar to Array#map().
Type Parameters
- T
Parameters
- callbackfn: (value: V, key: K, map: this) => T
  A function to apply to every element of the map.
- OptionalthisArg: any
  A value to use as this when executing callbackfn.
Returns T[]
The array.
- Defined in src/utils/ExtendedMap.ts:266

reduce

reduce<T>(
    callbackfn: (
        previousValue: T,
        currentValue: V,
        currentIndex: K,
        map: this,
    ) => T,
    initialValue?: T,
): T
Executes a specified reducer callback function on each element of the map to produce a single value. Similar to Array#reduce().
Type Parameters
- T
Parameters
- callbackfn: (previousValue: T, currentValue: V, currentIndex: K, map: this) => T
  A reducer function to apply to every element of the map.
- OptionalinitialValue: T
  A value to initialize previousValue in the callback function with.
Returns T
The result of the reducer.
- Defined in src/utils/ExtendedMap.ts:282

set

set(key: K, value: V): this
Adds or modifies an element with the specified key. Derived from the Map#set() method.
Parameters
- key: K
  The key of the element to add / modify.
- value: V
  The new value of the specified element.
Returns this
The map.
Inherited from Map.set
- Defined in src/utils/ExtendedMap.ts:110

some

some(
callbackfn: (value: V, key: K, map: this) => boolean,
thisArg?: any,
): boolean
Tests if any element in the map satisfies a test specified in the callback. Similar to Array#some().
Parameters
- callbackfn: (value: V, key: K, map: this) => boolean
  A function to test every element of the map.
- OptionalthisArg: any
  A value to use as this when executing callbackfn.
Returns boolean
true if a single element passes the callback test, false otherwise.
- Defined in src/utils/ExtendedMap.ts:307

sweep

sweep(
callbackfn: (value: V, key: K, map: this) => boolean,
thisArg?: any,
): ExtendedMap<K, V>
Removes all elements in the map that satisfy a specified test.
Parameters
- callbackfn: (value: V, key: K, map: this) => boolean
  A function to test every element of the map.
- OptionalthisArg: any
  A value to use as this when executing callbackfn.
Returns ExtendedMap<K, V>
A map containing the removed elements.
- Defined in src/utils/ExtendedMap.ts:345

values

values(): MapIterator<V>
Returns a new iterator object that contains values for each element in the map. Derived from the Map#values() method.

Returns MapIterator<V>
The new iterator object.
Inherited from Map.values
- Defined in src/utils/ExtendedMap.ts:119

`Static`isExtendedMap

isExtendedMap(value: any): value is ExtendedMap<any, any>
Determines if a value is an extended map.
Parameters
- value: any
  The value to test.
Returns value is ExtendedMap<any, any>
- Defined in src/utils/ExtendedMap.ts:369

`Static`isMap

isMap(value: any): value is Map<any, any>
Determines if a value is a map.
Parameters
- value: any
  The value to test.
Returns value is Map<any, any>
- Defined in src/utils/ExtendedMap.ts:361

Class ExtendedMap<K, V>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ExtendedMap<K, V>

Type Parameters

Parameters

Returns ExtendedMap<K, V>

Properties

Readonly[toStringTag]

constructor

Static Readonly[species]

Accessors

size

Returns number

Methods

[iterator]

Returns MapIterator<[K, V]>

at

Parameters

Returns undefined | V

clear

Returns this

clone

Returns ExtendedMap<K, V>

concat

Parameters

Returns ExtendedMap<K, V>

delete

Parameters

Returns boolean

entries

Returns MapIterator<[K, V]>

every

Parameters

Returns boolean

fill

Parameters

Returns this

filter

Parameters

Returns ExtendedMap<K, V>

find

Parameters

Returns undefined | V

findKey

Parameters

Returns undefined | K

first

Returns undefined | V

Parameters

Returns V[]

flatMap

Type Parameters

Parameters

Returns ExtendedMap<K, T>

forEach

Parameters

Returns this

get

Parameters

Returns undefined | V

has

Parameters

Returns boolean

join

Parameters

Returns string

joinKeys

Parameters

Returns string

keys

`Readonly`[toStringTag]

`Static` `Readonly`[species]

`Static`isExtendedMap

`Static`isMap