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

`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:143

clear

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

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:148

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:28

get

get(key: T): undefined | U
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 undefined | U
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

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:153

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:158

`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:25

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 undefined | 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