Skip to content

Function: isMap()

isMap(val): val is Map<unknown, unknown>

Type guard to check if a value is a Map instance.

Parameters

val

unknown

The value to check

Returns

val is Map<unknown, unknown>

True if the value is a Map

Example

typescript
const value: unknown = new Map([['key', 'value']])

if (isMap(value)) {
  // TypeScript knows value is a Map
  console.log(value.size) // 1
}

Released under the MIT License.