MultiMap Class

Package: @esfx/collections-multimap

Declaration

export declare class MultiMap<K, V> implements KeyedMultiCollection<K, V> 

Constructors

constructor(options)

Constructs a new instance of the MultiMap class

Declaration

constructor(options?: MultiMapOptions<K, V>);

Parameters

options

MultiMapOptions<K, V>

constructor(iterable, options)

Constructs a new instance of the MultiMap class

Declaration

constructor(iterable?: Iterable<[K, V]>, options?: MultiMapOptions<K, V>);

Parameters

iterable

Iterable<[K, V]>

options

MultiMapOptions<K, V>

constructor(capacity, options)

Constructs a new instance of the MultiMap class

Declaration

constructor(capacity: number, options?: MultiMapOptions<K, V>);

Parameters

capacity

number

options

MultiMapOptions<K, V>

Properties

[ReadonlyKeyedMultiCollection.size]

Declaration

get [ReadonlyKeyedMultiCollection.size](): number;

Property Value

number

[Symbol.toStringTag]

Declaration

[Symbol.toStringTag]: string;

Property Value

string

keyEqualer

Declaration

get keyEqualer(): Equaler<K>;

Property Value

Equaler<K>

size

Declaration

get size(): number;

Property Value

number

valueEqualer

Declaration

get valueEqualer(): Equaler<V>;

Property Value

Equaler<V>

Methods

[KeyedMultiCollection.add](key, value)

Declaration

[KeyedMultiCollection.add](key: K, value: V): void;

Parameters

key

K

value

V

Returns

void

[KeyedMultiCollection.clear]()

Declaration

[KeyedMultiCollection.clear](): void;

Returns

void

[KeyedMultiCollection.delete](key)

Declaration

[KeyedMultiCollection.delete](key: K): number;

Parameters

key

K

Returns

number

[KeyedMultiCollection.deleteValue](key, value)

Declaration

[KeyedMultiCollection.deleteValue](key: K, value: V): boolean;

Parameters

key

K

value

V

Returns

boolean

[ReadonlyKeyedMultiCollection.get](key)

Declaration

[ReadonlyKeyedMultiCollection.get](key: K): ReadonlyHashSet<V> | undefined;

Parameters

key

K

Returns

ReadonlyHashSet<V> | undefined

[ReadonlyKeyedMultiCollection.has](key)

Declaration

[ReadonlyKeyedMultiCollection.has](key: K): boolean;

Parameters

key

K

Returns

boolean

[ReadonlyKeyedMultiCollection.hasValue](key, value)

Declaration

[ReadonlyKeyedMultiCollection.hasValue](key: K, value: V): boolean;

Parameters

key

K

value

V

Returns

boolean

[ReadonlyKeyedMultiCollection.keys]()

Declaration

[ReadonlyKeyedMultiCollection.keys](): Generator<K, void, unknown>;

Returns

Generator<K, void, unknown>

[ReadonlyKeyedMultiCollection.values]()

Declaration

[ReadonlyKeyedMultiCollection.values](): Generator<V, void, unknown>;

Returns

Generator<V, void, unknown>

[Symbol.iterator]()

Declaration

[Symbol.iterator](): Generator<[K, V], void, unknown>;

Returns

Generator<[K, V], void, unknown>

add(key, value)

Declaration

add(key: K, value: V): this;

Parameters

key

K

value

V

Returns

this

clear()

Declaration

clear(): void;

Returns

void

delete(key)

Declaration

delete(key: K): number;

Parameters

key

K

Returns

number

deleteValue(key, value)

Declaration

deleteValue(key: K, value: V): boolean;

Parameters

key

K

value

V

Returns

boolean

ensureCapacity(capacity)

Declaration

ensureCapacity(capacity: number): number;

Parameters

capacity

number

Returns

number

entries()

Declaration

entries(): Generator<[K, V], void, unknown>;

Returns

Generator<[K, V], void, unknown>

forEach(callback, thisArg)

Declaration

forEach(callback: (value: V, key: K, map: this) => void, thisArg?: any): void;

Parameters

callback

(value: V, key: K, map: this) => void

thisArg

any

Returns

void

get(key)

Declaration

get(key: K): ReadonlyHashSet<V> | undefined;

Parameters

key

K

Returns

ReadonlyHashSet<V> | undefined

has(key)

Declaration

has(key: K): boolean;

Parameters

key

K

Returns

boolean

hasValue(key, value)

Declaration

hasValue(key: K, value: V): boolean;

Parameters

key

K

value

V

Returns

boolean

keys()

Declaration

keys(): Generator<K, void, unknown>;

Returns

Generator<K, void, unknown>

trimExcess(capacity)

Declaration

trimExcess(capacity?: number): void;

Parameters

capacity

number

Returns

void

values()

Declaration

values(): Generator<V, void, unknown>;

Returns

Generator<V, void, unknown>