class BiMapNonEmptyImpl<K,V>

undocumented

Extends: NonEmptyBase<E>

Type parameters

Name	Description
K	undocumented
V	undocumented

Properties

_NonEmptyType

undocumented

Definition

_NonEmptyType: BiMap.NonEmpty<K, V>;

Overrides

NonEmptyBase._NonEmptyType

context

undocumented

Definition

readonly context: BiMapContext<K, V>;

isEmpty

Returns false since the collection is known to be non-empty.

Definition

get isEmpty(): false;

Overrides

NonEmptyBase.isEmpty

keyValueMap

undocumented

Definition

readonly keyValueMap: RMap.NonEmpty<K, V>;

size

undocumented

Definition

get size(): number;

valueKeyMap

undocumented

Definition

readonly valueKeyMap: RMap.NonEmpty<V, K>;

Methods

[Symbol.iterator]

Returns a fast iterator over the elements of the collection.

Definition

[Symbol.iterator](): FastIterator<E>;

Overrides

NonEmptyBase.[Symbol.iterator]

addEntries

undocumented

Definition

addEntries(entries: StreamSource<readonly [K, V]>): BiMap.NonEmpty<K, V>;

Parameters

Name	Type	Description
entries	StreamSource<readonly [K, V]>

addEntry

undocumented

Definition

addEntry(entry: readonly [K, V]): BiMap.NonEmpty<K, V>;

Parameters

Name	Type	Description
entry	readonly [K, V]

asNormal

undocumented

Definition

asNormal(): this;

Overrides

NonEmptyBase.asNormal

assumeNonEmpty

Returns this, since the collection is already known to be non-empty.

Definition

assumeNonEmpty(): this;

Overrides

NonEmptyBase.assumeNonEmpty

copy

undocumented

Definition

copy(keyValueMap?: RMap.NonEmpty<K, V>, valueKeyMap?: RMap.NonEmpty<V, K>): BiMap.NonEmpty<K, V>;

Parameters

Name	Type	Description
keyValueMap	RMap.NonEmpty<K, V>
valueKeyMap	RMap.NonEmpty<V, K>

copyE

undocumented

Definition

copyE(keyValueMap?: RMap<K, V>, valueKeyMap?: RMap<V, K>): BiMap<K, V>;

Parameters

Name	Type	Description
keyValueMap	RMap<K, V>
valueKeyMap	RMap<V, K>

filter

undocumented

Definition

filter(pred: (entry: readonly [K, V], index: number, halt: () => void) => boolean, options?: {
    negate?: boolean;
  }): BiMap<K, V>;

Parameters

Name	Type	Description
pred	(entry: readonly [K, V], index: number, halt: () => void) => boolean
options	{     negate?: boolean;   }

forEach

undocumented

Definition

forEach(f: (entry: readonly [K, V], index: number, halt: () => void) => void, options?: {
    state?: TraverseState;
  }): void;

Parameters

Name	Type	Description
f	(entry: readonly [K, V], index: number, halt: () => void) => void
options	{     state?: TraverseState;   }

getKey

undocumented

Definition

getKey<UV, O>(value: RelatedTo<V, UV>, otherwise?: OptLazy<O>): K | O;

Type parameters

Name	Description
UV
O

Parameters

Name	Type	Description
value	RelatedTo<V, UV>
otherwise	OptLazy<O>

getValue

undocumented

Definition

getValue<UK, O>(key: RelatedTo<K, UK>, otherwise?: OptLazy<O>): V | O;

Type parameters

Name	Description
UK
O

Parameters

Name	Type	Description
key	RelatedTo<K, UK>
otherwise	OptLazy<O>

hasKey

undocumented

Definition

hasKey<UK>(key: RelatedTo<K, UK>): boolean;

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
key	RelatedTo<K, UK>

hasValue

undocumented

Definition

hasValue<UV>(value: RelatedTo<V, UV>): boolean;

Type parameters

Name	Description
UV

Parameters

Name	Type	Description
value	RelatedTo<V, UV>

nonEmpty

Returns true and instructs the compiler to treat the instance as non-empty.

Definition

nonEmpty(): this is this['_NonEmptyType'];

Overrides

NonEmptyBase.nonEmpty

removeKey

undocumented

Definition

removeKey<UK>(key: RelatedTo<K, UK>): BiMap<K, V>;

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
key	RelatedTo<K, UK>

removeKeyAndGet

undocumented

Definition

removeKeyAndGet<UK>(key: RelatedTo<K, UK>): [BiMap<K, V>, V] | undefined;

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
key	RelatedTo<K, UK>

removeKeys

undocumented

Definition

removeKeys<UK>(keys: Stream<RelatedTo<K, UK>>): BiMap<K, V>;

Type parameters

Name	Description
UK

Parameters

Name	Type	Description
keys	Stream<RelatedTo<K, UK>>

removeValue

undocumented

Definition

removeValue<UV>(value: RelatedTo<V, UV>): BiMap<K, V>;

Type parameters

Name	Description
UV

Parameters

Name	Type	Description
value	RelatedTo<V, UV>

removeValueAndGet

undocumented

Definition

removeValueAndGet<UV>(value: RelatedTo<V, UV>): [BiMap<K, V>, K] | undefined;

Type parameters

Name	Description
UV

Parameters

Name	Type	Description
value	RelatedTo<V, UV>

removeValues

undocumented

Definition

removeValues<UV>(values: Stream<RelatedTo<V, UV>>): BiMap<K, V>;

Type parameters

Name	Description
UV

Parameters

Name	Type	Description
values	Stream<RelatedTo<V, UV>>

set

undocumented

Definition

set(key: K, value: V): BiMap.NonEmpty<K, V>;

Parameters

Name	Type	Description
key	K
value	V

stream

undocumented

Definition

stream(): Stream.NonEmpty<readonly [K, V]>;

Overrides

NonEmptyBase.stream

streamKeys

undocumented

Definition

streamKeys(): Stream.NonEmpty<K>;

streamValues

undocumented

Definition

streamValues(): Stream.NonEmpty<V>;

toArray

undocumented

Definition

toArray(): ArrayNonEmpty<readonly [K, V]>;

toBuilder

undocumented

Definition

toBuilder(): BiMap.Builder<K, V>;

toJSON

undocumented

Definition

toJSON(): ToJSON<(readonly [K, V])[], this['context']['typeTag']>;

toString

undocumented

Definition

toString(): string;

updateKeyAtValue

undocumented

Definition

updateKeyAtValue(keyUpdate: Update<K>, value: V): BiMap.NonEmpty<K, V>;

Parameters

Name	Type	Description
keyUpdate	Update<K>
value	V

updateValueAtKey

undocumented

Definition

updateValueAtKey(key: K, valueUpdate: Update<V>): BiMap.NonEmpty<K, V>;

Parameters

Name	Type	Description
key	K
valueUpdate	Update<V>