Class CaseInsensitiveMap<T, U>

A case-insensitive Map.

Keys that are strings are treated in a case-insensitive manner.

Type Parameters

Hierarchy

Map<T, U>
- CaseInsensitiveMap

Index

Constructors

constructor

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

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly`[species]

"[species]": MapConstructor

Methods

[iterator]

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

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

clear

clear(): void
Removes all elements from the Map.

Returns void
Inherited from Map.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:21

delete

delete(key: T): boolean
Parameters
- key: T
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Overrides Map.delete
- Defined in packages/misc-util/src/ecma/map/case-insensitive-map.ts:47

entries

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

Returns MapIterator<[T, U]>
Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:146

forEach

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

get

get(key: T): U | 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: T
Returns U | undefined
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Overrides Map.get
- Defined in packages/misc-util/src/ecma/map/case-insensitive-map.ts:22

getOrInsert

getOrInsert(key: T, defaultValue: U): U
Returns a specified element from the Map object. If no element is associated with the specified key, a new element with the value defaultValue will be inserted into the Map and returned.
Parameters
- key: T
- defaultValue: U
Returns U
The element associated with the specified key, which will be defaultValue if no element previously existed.
Inherited from Map.getOrInsert
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:25

getOrInsertComputed

getOrInsertComputed(key: T, callback: (key: T) => U): U
Returns a specified element from the Map object. If no element is associated with the specified key, the result of passing the specified key to the callback function will be inserted into the Map and returned.
Parameters
- key: T
- callback: (key: T) => U
Returns U
The element associated with the specific key, which will be the newly computed value if no element previously existed.
Inherited from Map.getOrInsertComputed
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:31

has

has(key: T): boolean
Parameters
- key: T
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Overrides Map.has
- Defined in packages/misc-util/src/ecma/map/case-insensitive-map.ts:35

keys

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

Returns MapIterator<T>
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:151

set

set(key: T, value: U): this
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: T
- value: U
Returns this
Overrides Map.set
- Defined in packages/misc-util/src/ecma/map/case-insensitive-map.ts:9

values

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

Returns MapIterator<U>
Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:156

`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 node_modules/typescript/lib/lib.es2024.collection.d.ts:23

Class CaseInsensitiveMap<T, U>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CaseInsensitiveMap<T, U>

Type Parameters

Parameters

Returns CaseInsensitiveMap<T, U>

Properties

Readonly[toStringTag]

Readonlysize

Returns

Static Readonly[species]

Methods

[iterator]

Returns MapIterator<[T, U]>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns MapIterator<[T, U]>

forEach

Parameters

Returns void

get

Parameters

Returns U | undefined

getOrInsert

Parameters

Returns U

getOrInsertComputed

Parameters

Returns U

has

Parameters

Returns boolean

keys

Returns MapIterator<T>

set

Parameters

Returns this

values

Returns MapIterator<U>

StaticgroupBy

Type Parameters

Parameters

Returns Map<K, T[]>

Settings

On This Page

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]

`Static`groupBy