Skip to main content

package @rimbu/list/custom

The @rimbu/list/custom entry exposes the internal tree, block and builder implementations that power the List collection, together with the low‑level context used to configure block sizes and performance characteristics. It is intended for advanced scenarios where you need to build custom List‑like structures or tune internal behaviour; for everyday use prefer the main @rimbu/list API.

Interfaces

NameDescription
Block<T,TS,C>undocumented
BlockBuilder<T,C>undocumented
BuilderBase<T,C>undocumented
LeafBuilder<T>undocumented
ListCreatorsThe public creators for the List collection type.
This interface extends ListFactory with helpers to create and access List.Context instances.
ListFactoryA collection of factory functions to create immutable List instances for a given context.
See the List documentation and the List API documentation.
NonLeaf<T,C>undocumented
Tree<T,TS,TB,C>undocumented

Classes

NameDescription
CacheMapundocumented
Emptyundocumented
GenBuilderundocumented
LeafBlockundocumented
LeafBlockBuilderundocumented
LeafTreeundocumented
LeafTreeBuilderundocumented
ListContextundocumented
NonLeafBlockundocumented
NonLeafBlockBuilderundocumented
NonLeafTreeundocumented
NonLeafTreeBuilderundocumented
ReversedLeafBlockundocumented

Functions

createEmptyList

undocumented

Definition

export declare function createEmptyList(context: ListContext): List<any>;

Parameters

NameTypeDescription
contextListContext

createListContext

undocumented

Definition

export declare function createListContext(options?: {
  blockSizeBits?: number;
}): List.Context;

Parameters

NameTypeDescription
options{
  blockSizeBits?: number;
}