Skip to main content

abstract class SortedMapNode<K,V>

undocumented

Extended by: SortedMapInner<K,V>, SortedMapLeaf<K,V>

Type parameters

NameDescription
Kundocumented
Vundocumented

Properties

_NonEmptyType

undocumented

Definition

_NonEmptyType: SortedMap.NonEmpty<K, V>;

context

undocumented

Definition

abstract get context(): SortedMapContext<K>;

size

undocumented

Definition

abstract get size(): number;

Methods

addEntries

undocumented

Definition

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

Parameters

NameTypeDescription
entriesStreamSource<readonly [K, V]>

addEntry

undocumented

Definition

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

Parameters

NameTypeDescription
entryreadonly [K, V]

addInternal

undocumented

Definition

abstract addInternal(entry: readonly [K, V], hash?: number): SortedMapNode<K, V>;

Parameters

NameTypeDescription
entryreadonly [K, V]
hashnumber

asNormal

undocumented

Definition

asNormal(): this;

drop

undocumented

Definition

drop(amount: number): SortedMap<K, V>;

Parameters

NameTypeDescription
amountnumber

filter

undocumented

Definition

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

Parameters

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

findIndex

undocumented

Definition

abstract findIndex(key: K): number;

Parameters

NameTypeDescription
keyK

forEach

undocumented

Definition

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

Parameters

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

get

undocumented

Definition

abstract get<U, O>(key: RelatedTo<K, U>, otherwise?: OptLazy<O>): V | O;

Type parameters

NameDescription
U
O

Parameters

NameTypeDescription
keyRelatedTo<K, U>
otherwiseOptLazy<O>

getInsertIndexOf

undocumented

Definition

abstract getInsertIndexOf(key: K): number;

Parameters

NameTypeDescription
keyK

getKeyAtIndex

undocumented

Definition

getKeyAtIndex<O>(index: number, otherwise?: OptLazy<O>): K | O;

Type parameters

NameDescription
O

Parameters

NameTypeDescription
indexnumber
otherwiseOptLazy<O>

getSliceRange

undocumented

Definition

getSliceRange(range: Range<K>): {
    startIndex: number;
    endIndex: number;
  };

Parameters

NameTypeDescription
rangeRange<K>

getValueAtIndex

undocumented

Definition

getValueAtIndex<O>(index: number, otherwise?: OptLazy<O>): V | O;

Type parameters

NameDescription
O

Parameters

NameTypeDescription
indexnumber
otherwiseOptLazy<O>

hasKey

undocumented

Definition

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

Type parameters

NameDescription
UK

Parameters

NameTypeDescription
keyRelatedTo<K, UK>

mapValues

undocumented

Definition

abstract mapValues<V2>(mapFun: (value: V, key: K) => V2): SortedMapNode<K, V2>;

Type parameters

NameDescription
V2

Parameters

NameTypeDescription
mapFun(value: V, key: K) => V2

max

undocumented

Definition

abstract max(): readonly [K, V];

maxKey

undocumented

Definition

maxKey(): K;

maxValue

undocumented

Definition

maxValue(): V;

min

undocumented

Definition

abstract min(): readonly [K, V];

minKey

undocumented

Definition

minKey(): K;

minValue

undocumented

Definition

minValue(): V;

modifyAt

undocumented

Definition

modifyAt(atKey: K, options: {
    ifNew?: OptLazyOr<V, Token>;
    ifExists?: ((currentEntry: V, remove: Token) => V |Token)| V;
  }): SortedMap<K, V>;

Parameters

NameTypeDescription
atKeyK
options{
    ifNew?: OptLazyOr<V, Token>;
    ifExists?: ((currentEntry: V, remove: Token) => V |Token)| V;
  }

modifyAtInternal

undocumented

Definition

abstract modifyAtInternal(atKey: K, options: {
    ifNew?: OptLazyOr<V, Token>;
    ifExists?: ((currentEntry: V, remove: Token) => V |Token)| V;
  }): SortedMapNode<K, V>;

Parameters

NameTypeDescription
atKeyK
options{
    ifNew?: OptLazyOr<V, Token>;
    ifExists?: ((currentEntry: V, remove: Token) => V |Token)| V;
  }

normalize

undocumented

Definition

abstract normalize(): SortedMap<K, V>;

removeKey

undocumented

Definition

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

Type parameters

NameDescription
UK

Parameters

NameTypeDescription
keyRelatedTo<K, UK>

removeKeyAndGet

undocumented

Definition

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

Type parameters

NameDescription
UK

Parameters

NameTypeDescription
keyRelatedTo<K, UK>

removeKeys

undocumented

Definition

removeKeys<UK>(keys: StreamSource<RelatedTo<K, UK>>): SortedMap<K, V>;

Type parameters

NameDescription
UK

Parameters

NameTypeDescription
keysStreamSource<RelatedTo<K, UK>>

set

undocumented

Definition

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

Parameters

NameTypeDescription
keyK
valueV

slice

undocumented

Definition

slice(range: Range<K>): SortedMap<K, V>;

Parameters

NameTypeDescription
rangeRange<K>

sliceIndex

undocumented

Definition

sliceIndex(range: IndexRange): SortedMap<K, V>;

Parameters

NameTypeDescription
rangeIndexRange

stream

undocumented

Definition

abstract stream(options?: {
    reversed?: boolean;
  }): Stream.NonEmpty<readonly [K, V]>;

Parameters

NameTypeDescription
options{
    reversed?: boolean;
  }

streamKeys

undocumented

Definition

streamKeys(options?: {
    reversed?: boolean;
  }): Stream.NonEmpty<K>;

Parameters

NameTypeDescription
options{
    reversed?: boolean;
  }

streamRange

undocumented

Definition

streamRange(keyRange: Range<K>, options?: {
    reversed?: boolean;
  }): Stream<readonly [K, V]>;

Parameters

NameTypeDescription
keyRangeRange<K>
options{
    reversed?: boolean;
  }

streamSliceIndex

undocumented

Definition

abstract streamSliceIndex(range: IndexRange, options?: {
    reversed?: boolean;
  }): Stream<readonly [K, V]>;

Parameters

NameTypeDescription
rangeIndexRange
options{
    reversed?: boolean;
  }

streamValues

undocumented

Definition

streamValues(options?: {
    reversed?: boolean;
  }): Stream.NonEmpty<V>;

Parameters

NameTypeDescription
options{
    reversed?: boolean;
  }

take

undocumented

Definition

take(amount: number): SortedMap<K, V> | any;

Parameters

NameTypeDescription
amountnumber

toArray

undocumented

Definition

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

toBuilder

undocumented

Definition

toBuilder(): SortedMapBuilder<K, V>;

toJSON

undocumented

Definition

toJSON(): ToJSON<(readonly [K, V])[]>;

toString

undocumented

Definition

toString(): string;

updateAt

undocumented

Definition

updateAt<U>(key: RelatedTo<K, U>, update: Update<V>): SortedMap.NonEmpty<K, V>;

Type parameters

NameDescription
U

Parameters

NameTypeDescription
keyRelatedTo<K, U>
updateUpdate<V>