Skip to main content

class SortedMapLeaf<K,V>

undocumented

Extends: SortedMapNode<K,V>

Type parameters​

NameDescription
Kundocumented
Vundocumented

Properties​

_NonEmptyType​

undocumented

Definition​

_NonEmptyType: SortedMap.NonEmpty<K, V>;

Overrides​

SortedMapNode._NonEmptyType

context​

undocumented

Definition​

readonly context: SortedMapContext<K>;

Overrides​

SortedMapNode.context

entries​

undocumented

Definition​

entries: readonly (readonly [K, V])[];

size​

undocumented

Definition​

get size(): number;

Overrides​

SortedMapNode.size

Methods​

addEntries​

undocumented

Definition​

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

Parameters​

NameTypeDescription
entriesStreamSource<readonly [K, V]>

Overrides​

SortedMapNode.addEntries

addEntry​

undocumented

Definition​

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

Parameters​

NameTypeDescription
entryreadonly [K, V]

Overrides​

SortedMapNode.addEntry

addInternal​

undocumented

Definition​

addInternal(entry: readonly [K, V]): SortedMapNode<K, V>;

Parameters​

NameTypeDescription
entryreadonly [K, V]

Overrides​

SortedMapNode.addInternal

asNormal​

undocumented

Definition​

asNormal(): this;

Overrides​

SortedMapNode.asNormal

copy​

undocumented

Definition​

copy(entries: readonly (readonly [K, V])[]): SortedMapLeaf<K, V>;

Parameters​

NameTypeDescription
entriesreadonly (readonly [K, V])[]

deleteMax​

undocumented

Definition​

deleteMax(): [readonly [K, V], SortedMapLeaf<K, V>];

deleteMin​

undocumented

Definition​

deleteMin(): [readonly [K, V], SortedMapLeaf<K, V>];

drop​

undocumented

Definition​

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

Parameters​

NameTypeDescription
amountnumber

Overrides​

SortedMapNode.drop

dropInternal​

undocumented

Definition​

dropInternal(amount: number): SortedMapLeaf<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;
  }

Overrides​

SortedMapNode.filter

findIndex​

undocumented

Definition​

findIndex(key: K): number;

Parameters​

NameTypeDescription
keyK

Overrides​

SortedMapNode.findIndex

forEach​

undocumented

Definition​

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;
  }

Overrides​

SortedMapNode.forEach

get​

undocumented

Definition​

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

Type parameters​

NameDescription
UK
O

Parameters​

NameTypeDescription
keyRelatedTo<K, UK>
otherwiseOptLazy<O>

Overrides​

SortedMapNode.get

getAtIndex​

undocumented

Definition​

getAtIndex<O>(index: number, otherwise?: OptLazy<O>): readonly [K, V] | O;

Type parameters​

NameDescription
O

Parameters​

NameTypeDescription
indexnumber
otherwiseOptLazy<O>

getInsertIndexOf​

undocumented

Definition​

getInsertIndexOf(key: K): number;

Parameters​

NameTypeDescription
keyK

Overrides​

SortedMapNode.getInsertIndexOf

getKeyAtIndex​

undocumented

Definition​

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

Type parameters​

NameDescription
O

Parameters​

NameTypeDescription
indexnumber
otherwiseOptLazy<O>

Overrides​

SortedMapNode.getKeyAtIndex

getSliceRange​

undocumented

Definition​

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

Parameters​

NameTypeDescription
rangeRange<K>

Overrides​

SortedMapNode.getSliceRange

getValueAtIndex​

undocumented

Definition​

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

Type parameters​

NameDescription
O

Parameters​

NameTypeDescription
indexnumber
otherwiseOptLazy<O>

Overrides​

SortedMapNode.getValueAtIndex

hasKey​

undocumented

Definition​

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

Type parameters​

NameDescription
UK

Parameters​

NameTypeDescription
keyRelatedTo<K, UK>

Overrides​

SortedMapNode.hasKey

mapValues​

undocumented

Definition​

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

Type parameters​

NameDescription
V2

Parameters​

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

Overrides​

SortedMapNode.mapValues

max​

undocumented

Definition​

max(): readonly [K, V];

Overrides​

SortedMapNode.max

maxKey​

undocumented

Definition​

maxKey(): K;

Overrides​

SortedMapNode.maxKey

maxValue​

undocumented

Definition​

maxValue(): V;

Overrides​

SortedMapNode.maxValue

min​

undocumented

Definition​

min(): readonly [K, V];

Overrides​

SortedMapNode.min

minKey​

undocumented

Definition​

minKey(): K;

Overrides​

SortedMapNode.minKey

minValue​

undocumented

Definition​

minValue(): V;

Overrides​

SortedMapNode.minValue

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;
  }

Overrides​

SortedMapNode.modifyAt

modifyAtInternal​

undocumented

Definition​

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

Parameters​

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

Overrides​

SortedMapNode.modifyAtInternal

mutateGetFromLeft​

undocumented

Definition​

mutateGetFromLeft(left: SortedMapLeaf<K, V>, toMe: readonly [K, V]): [readonly [K, V], SortedMapLeaf<K, V>];

Parameters​

NameTypeDescription
leftSortedMapLeaf<K, V>
toMereadonly [K, V]

mutateGetFromRight​

undocumented

Definition​

mutateGetFromRight(right: SortedMapLeaf<K, V>, toMe: readonly [K, V]): [readonly [K, V], SortedMapLeaf<K, V>];

Parameters​

NameTypeDescription
rightSortedMapLeaf<K, V>
toMereadonly [K, V]

mutateGiveToLeft​

undocumented

Definition​

mutateGiveToLeft(left: SortedMapLeaf<K, V>, toLeft: readonly [K, V]): [readonly [K, V], SortedMapLeaf<K, V>];

Parameters​

NameTypeDescription
leftSortedMapLeaf<K, V>
toLeftreadonly [K, V]

mutateGiveToRight​

undocumented

Definition​

mutateGiveToRight(right: SortedMapLeaf<K, V>, toRight: readonly [K, V]): [readonly [K, V], SortedMapLeaf<K, V>];

Parameters​

NameTypeDescription
rightSortedMapLeaf<K, V>
toRightreadonly [K, V]

mutateJoinLeft​

undocumented

Definition​

mutateJoinLeft(left: SortedMapLeaf<K, V>, entry: readonly [K, V]): void;

Parameters​

NameTypeDescription
leftSortedMapLeaf<K, V>
entryreadonly [K, V]

mutateJoinRight​

undocumented

Definition​

mutateJoinRight(right: SortedMapLeaf<K, V>, entry: readonly [K, V]): void;

Parameters​

NameTypeDescription
rightSortedMapLeaf<K, V>
entryreadonly [K, V]

mutateSplitRight​

undocumented

Definition​

mutateSplitRight(index?: number): [readonly [K, V], SortedMapLeaf<K, V>];

Parameters​

NameTypeDescription
indexnumber

normalize​

undocumented

Definition​

normalize(): SortedMap<K, V>;

Overrides​

SortedMapNode.normalize

removeKey​

undocumented

Definition​

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

Type parameters​

NameDescription
UK

Parameters​

NameTypeDescription
keyRelatedTo<K, UK>

Overrides​

SortedMapNode.removeKey

removeKeyAndGet​

undocumented

Definition​

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

Type parameters​

NameDescription
UK

Parameters​

NameTypeDescription
keyRelatedTo<K, UK>

Overrides​

SortedMapNode.removeKeyAndGet

removeKeys​

undocumented

Definition​

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

Type parameters​

NameDescription
UK

Parameters​

NameTypeDescription
keysStreamSource<RelatedTo<K, UK>>

Overrides​

SortedMapNode.removeKeys

set​

undocumented

Definition​

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

Parameters​

NameTypeDescription
keyK
valueV

Overrides​

SortedMapNode.set

slice​

undocumented

Definition​

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

Parameters​

NameTypeDescription
rangeRange<K>

Overrides​

SortedMapNode.slice

sliceIndex​

undocumented

Definition​

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

Parameters​

NameTypeDescription
rangeIndexRange

Overrides​

SortedMapNode.sliceIndex

stream​

undocumented

Definition​

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

Parameters​

NameTypeDescription
options{
    reversed?: boolean;
  }

Overrides​

SortedMapNode.stream

streamKeys​

undocumented

Definition​

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

Parameters​

NameTypeDescription
options{
    reversed?: boolean;
  }

Overrides​

SortedMapNode.streamKeys

streamRange​

undocumented

Definition​

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

Parameters​

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

Overrides​

SortedMapNode.streamRange

streamSliceIndex​

undocumented

Definition​

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

Parameters​

NameTypeDescription
rangeIndexRange
options{
    reversed?: boolean;
  }

Overrides​

SortedMapNode.streamSliceIndex

streamValues​

undocumented

Definition​

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

Parameters​

NameTypeDescription
options{
    reversed?: boolean;
  }

Overrides​

SortedMapNode.streamValues

take​

undocumented

Definition​

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

Parameters​

NameTypeDescription
amountnumber

Overrides​

SortedMapNode.take

takeInternal​

undocumented

Definition​

takeInternal(amount: number): SortedMapLeaf<K, V>;

Parameters​

NameTypeDescription
amountnumber

toArray​

undocumented

Definition​

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

Overrides​

SortedMapNode.toArray

toBuilder​

undocumented

Definition​

toBuilder(): SortedMapBuilder<K, V>;

Overrides​

SortedMapNode.toBuilder

toJSON​

undocumented

Definition​

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

Overrides​

SortedMapNode.toJSON

toString​

undocumented

Definition​

toString(): string;

Overrides​

SortedMapNode.toString

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>

Overrides​

SortedMapNode.updateAt