Skip to main content

class ListContext

undocumented

Properties​

_empty​

undocumented

Definition​

readonly _empty: List<any>;

_types​

undocumented

Definition​

get _types(): List.Types;

blockSizeBits​

undocumented

Definition​

readonly blockSizeBits: number;

builder​

undocumented

Definition​

readonly builder: <T>() => GenBuilder<T>;

empty​

undocumented

Definition​

readonly empty: <T>() => List<T>;

flatten​

undocumented

Definition​

readonly flatten: (source: any) => any;

from​

undocumented

Definition​

readonly from: <T>(...sources: ArrayNonEmpty<StreamSource<T>>) => any;

fromString​

undocumented

Definition​

readonly fromString: (...sources: ArrayNonEmpty<string>) => any;

maxBlockSize​

undocumented

Definition​

readonly maxBlockSize: number;

minBlockSize​

undocumented

Definition​

readonly minBlockSize: number;

of​

undocumented

Definition​

readonly of: <T>(...values: ArrayNonEmpty<T>) => List.NonEmpty<T>;

reducer​

undocumented

Definition​

readonly reducer: <T>(source?: StreamSource<T>) => Reducer<T, List<T>>;

typeTag​

undocumented

Definition​

get typeTag(): 'List';

unzip​

undocumented

Definition​

readonly unzip: (source: any, options: {
    length: number;
  }) => any;

Methods​

createBuilder​

undocumented

Definition​

createBuilder<T>(source?: List<T>): GenBuilder<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
sourceList<T>

createCacheMap​

undocumented

Definition​

createCacheMap(): CacheMap;

isLeafBlock​

undocumented

Definition​

isLeafBlock<T>(obj: List<T> | Block<T>): obj is LeafBlock<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
objList<T> | Block<T>

isLeafBlockBuilder​

undocumented

Definition​

isLeafBlockBuilder<T>(obj: LeafBuilder<T>): obj is LeafBlockBuilder<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
objLeafBuilder<T>

isLeafTree​

undocumented

Definition​

isLeafTree<T>(obj: List<T>): obj is LeafTree<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
objList<T>

isLeafTreeBuilder​

undocumented

Definition​

isLeafTreeBuilder<T>(obj: LeafBuilder<T>): obj is LeafTreeBuilder<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
objLeafBuilder<T>

isNonLeafBlock​

undocumented

Definition​

isNonLeafBlock<T>(obj: List<T> | Block<T> | NonLeaf<T>): obj is NonLeafBlock<T, any>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
objList<T> | Block<T> | NonLeaf<T>

isNonLeafBlockBuilder​

undocumented

Definition​

isNonLeafBlockBuilder<T>(obj: NonLeafBuilder<T, any>): obj is NonLeafBlockBuilder<T, any>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
objNonLeafBuilder<T, any>

isNonLeafTree​

undocumented

Definition​

isNonLeafTree<T>(obj: NonLeaf<T>): obj is NonLeafTree<T, any>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
objNonLeaf<T>

isReversedLeafBlock​

undocumented

Definition​

isReversedLeafBlock<T>(obj: List<T> | Block<T>): obj is ReversedLeafBlock<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
objList<T> | Block<T>

leafBlock​

undocumented

Definition​

leafBlock<T>(children: readonly T[]): LeafBlock<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
childrenreadonly T[]

leafBlockBuilder​

undocumented

Definition​

leafBlockBuilder<T>(children: T[]): LeafBlockBuilder<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
childrenT[]

leafBlockBuilderSource​

undocumented

Definition​

leafBlockBuilderSource<T>(source: LeafBlock<T>): LeafBlockBuilder<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
sourceLeafBlock<T>

leafTree​

undocumented

Definition​

leafTree<T>(left: LeafBlock<T>, right: LeafBlock<T>, middle: NonLeaf<T, LeafBlock<T>> |null):LeafTree<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
leftLeafBlock<T>
rightLeafBlock<T>
middleNonLeaf<T, LeafBlock<T>> | null

leafTreeBuilder​

undocumented

Definition​

leafTreeBuilder<T>(left: LeafBlockBuilder<T>, right: LeafBlockBuilder<T>, middle?: NonLeafBuilder<T, LeafBlockBuilder<T>>, length?: number): LeafTreeBuilder<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
leftLeafBlockBuilder<T>
rightLeafBlockBuilder<T>
middleNonLeafBuilder<T, LeafBlockBuilder<T>>
lengthnumber

leafTreeBuilderSource​

undocumented

Definition​

leafTreeBuilderSource<T>(source: LeafTree<T>): LeafTreeBuilder<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
sourceLeafTree<T>

nonLeafBlock​

undocumented

Definition​

nonLeafBlock<T, C extends Block<T, C>>(length: number, children: readonly C[], level: number): NonLeafBlock<T, C>;

Type parameters​

NameConstraintsDescription
T
CBlock<T, C>

Parameters​

NameTypeDescription
lengthnumber
childrenreadonly C[]
levelnumber

nonLeafBlockBuilder​

undocumented

Definition​

nonLeafBlockBuilder<T, C extends BlockBuilder<T>>(level: number, children: C[], length: number): NonLeafBlockBuilder<T, C>;

Type parameters​

NameConstraintsDescription
T
CBlockBuilder<T>

Parameters​

NameTypeDescription
levelnumber
childrenC[]
lengthnumber

nonLeafBlockBuilderSource​

undocumented

Definition​

nonLeafBlockBuilderSource<T, C extends BlockBuilder<T>>(source: NonLeafBlock<T, any>): NonLeafBlockBuilder<T, C>;

Type parameters​

NameConstraintsDescription
T
CBlockBuilder<T>

Parameters​

NameTypeDescription
sourceNonLeafBlock<T, any>

nonLeafTree​

undocumented

Definition​

nonLeafTree<T, C extends Block<T, C>>(left: NonLeafBlock<T, C>, right: NonLeafBlock<T, C>, middle: NonLeaf<T, NonLeafBlock<T, C>> |null, level: number):NonLeafTree<T, C>;

Type parameters​

NameConstraintsDescription
T
CBlock<T, C>

Parameters​

NameTypeDescription
leftNonLeafBlock<T, C>
rightNonLeafBlock<T, C>
middleNonLeaf<T, NonLeafBlock<T, C>> | null
levelnumber

nonLeafTreeBuilder​

undocumented

Definition​

nonLeafTreeBuilder<T, C extends BlockBuilder<T>>(level: number, left: NonLeafBlockBuilder<T, C>, right: NonLeafBlockBuilder<T, C>, middle?: NonLeafBuilder<T, NonLeafBlockBuilder<T, C>>, length?: number): NonLeafTreeBuilder<T, C>;

Type parameters​

NameConstraintsDescription
T
CBlockBuilder<T>

Parameters​

NameTypeDescription
levelnumber
leftNonLeafBlockBuilder<T, C>
rightNonLeafBlockBuilder<T, C>
middleNonLeafBuilder<T, NonLeafBlockBuilder<T, C>>
lengthnumber

nonLeafTreeBuilderSource​

undocumented

Definition​

nonLeafTreeBuilderSource<T, C extends BlockBuilder<T>>(source: NonLeafTree<T, any>): NonLeafTreeBuilder<T, C>;

Type parameters​

NameConstraintsDescription
T
CBlockBuilder<T>

Parameters​

NameTypeDescription
sourceNonLeafTree<T, any>

reversedLeaf​

undocumented

Definition​

reversedLeaf<T>(children: readonly T[]): ReversedLeafBlock<T>;

Type parameters​

NameDescription
T

Parameters​

NameTypeDescription
childrenreadonly T[]