Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BiMap<TKey, TValue>

Type parameters

  • TKey

  • TValue

Hierarchy

  • Map<TKey, TValue>
    • BiMap

Index

Constructors

Properties

Methods

Constructors

constructor

  • new BiMap(map: Map<TKey, TValue>): BiMap

Properties

Readonly [Symbol.toStringTag]

[Symbol.toStringTag]: string

Private Readonly __secondary

__secondary: Map<TValue, TKey> = new Map<TValue, TKey>()

Readonly size

size: number

Static Map

Map: MapConstructor

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<[TKey, TValue]>

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[TKey, TValue]>

clear

  • clear(): this

delete

  • delete(key: TKey): boolean

entries

  • entries(): IterableIterator<[TKey, TValue]>

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

    Returns IterableIterator<[TKey, TValue]>

forEach

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

  • Parameters

    • callbackfn: (value: TValue, key: TKey, map: Map<TKey, TValue>) => void
        • (value: TValue, key: TKey, map: Map<TKey, TValue>): void

        • Parameters

          • value: TValue
          • key: TKey
          • map: Map<TKey, TValue>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key: TKey): TValue | undefined

  • Parameters

    • key: TKey

    Returns TValue | undefined

getFromValue

  • getFromValue(value: TValue): TKey | undefined

has

  • has(key: TKey): boolean

  • Parameters

    • key: TKey

    Returns boolean

keys

  • keys(): IterableIterator<TKey>

  • Returns an iterable of keys in the map

    Returns IterableIterator<TKey>

set

  • set(key: TKey, value: TValue): this

values

  • values(): IterableIterator<TValue>

  • Returns an iterable of values in the map

    Returns IterableIterator<TValue>

Generated using TypeDoc