Class Lookup<TKey, TVal>

A collection where each key is unique but has a list of values

Type Parameters

TKey
TVal

Hierarchy (view full)

ReadonlyLookup<TKey, TVal>
- Lookup

Index

Constructors

Properties

Accessors

Methods

[iterator] add clear delete forEach get has set

Constructors

constructor

new Lookup<TKey, TVal>(): Lookup<TKey, TVal>
Type Parameters
- TKey
- TVal
Returns Lookup<TKey, TVal>
Inherited from ReadonlyLookup.constructor

Properties

`Protected`noKey

noKey: undefined | TVal[]

`Protected`values

values: Map<NonNullable<TKey>, TVal[]> = ...

Accessors

size

get size(): number
The number of keys in the lookup

Returns number
Inherited from ReadonlyLookup.size
- Defined in structures/lookup.ts:12

Methods

[iterator]

[iterator](): Generator<[key: LookupKey<TKey>, TVal[]], any, unknown>
Returns Generator<[key: LookupKey<TKey>, TVal[]], any, unknown>
Inherited from ReadonlyLookup.[iterator]
- Defined in structures/lookup.ts:36

add

add(key, value): this
Add a value to the lookup
Parameters
- key: TKey
- value: TVal
Returns this
- Defined in structures/lookup.ts:72

clear

clear(): void
Clear the collection

Returns void
- Defined in structures/lookup.ts:58

delete

delete(key): boolean
Delete all values from a key
Parameters
- key: TKey
Returns boolean
- Defined in structures/lookup.ts:64

forEach

forEach(callback): void
Iterate all keys and their values
Parameters
- callback: ((value: TVal[], key: LookupKey<TKey>) => void)
  - - (value, key): void
    - Parameters
      value: TVal[]
      key: LookupKey<TKey>
      Returns void
Returns void
Inherited from ReadonlyLookup.forEach
- Defined in structures/lookup.ts:30

get

get(key): undefined | TVal[]
Get the list of values from a key
Parameters
- key: TKey
Returns undefined | TVal[]
Inherited from ReadonlyLookup.get
- Defined in structures/lookup.ts:18

has

has(key): boolean
Check if a key exists in the lookup
Parameters
- key: NonNullable<TKey>
Returns boolean
Inherited from ReadonlyLookup.has
- Defined in structures/lookup.ts:24

set

set(key, value): this
Set the collection for a given key
Parameters
- key: TKey
- value: TVal[]
Returns this
- Defined in structures/lookup.ts:51