Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GMap<T, S>

Type parameters

  • T

  • S: string | number | Record<string | number, unknown>

Hierarchy

  • Map<T, S>
    • GMap

Index

Constructors

Properties

Methods

Constructors

constructor

  • new GMap<T, S>(entries?: null | readonly readonly [T, S][]): GMap<T, S>
  • new GMap<T, S>(iterable: Iterable<readonly [T, S]>): GMap<T, S>

  • Type parameters

    • T

    • S: string | number | Record<string | number, unknown>

    Parameters

    • Optional entries: null | readonly readonly [T, S][]

    Returns GMap<T, S>

  • Type parameters

    • T

    • S: string | number | Record<string | number, unknown>

    Parameters

    • iterable: Iterable<readonly [T, S]>

    Returns GMap<T, S>

Properties

Readonly [Symbol.toStringTag]

[Symbol.toStringTag]: string

Readonly size

size: number

Static Readonly [Symbol.species]

[Symbol.species]: MapConstructor

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<[T, S]>

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[T, S]>

clear

  • clear(): void

  • Returns void

delete

  • delete(key: T): boolean

  • Parameters

    • key: T

    Returns boolean

entries

  • entries(): IterableIterator<[T, S]>

  • Returns an iterable of key, value pairs for every entry in the map.

    Returns IterableIterator<[T, S]>

forEach

  • forEach(callbackfn: (value: S, key: T, map: Map<T, S>) => void, thisArg?: any): void

  • Parameters

    • callbackfn: (value: S, key: T, map: Map<T, S>) => void
        • (value: S, key: T, map: Map<T, S>): void

        • Parameters

          • value: S
          • key: T
          • map: Map<T, S>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key: T, defaultValue?: S): undefined | S

getOrCreate

  • getOrCreate(key: T, defaultValue: S | (() => S)): undefined | S

has

  • has(key: T): boolean

  • Parameters

    • key: T

    Returns boolean

keys

  • keys(): IterableIterator<T>

  • Returns an iterable of keys in the map

    Returns IterableIterator<T>

set

  • set(key: T, value: S): GMap<T, S>

  • Parameters

    • key: T
    • value: S

    Returns GMap<T, S>

values

  • values(): IterableIterator<S>

  • Returns an iterable of values in the map

    Returns IterableIterator<S>

Generated using TypeDoc