Interface CustomIndex<A, T, I>`Internal`

interface CustomIndex<A extends object, T, I extends CustomIndexablesOf<A, T>> {
    index: I;
    keyType: A[I];
    makeIndex: () => BTree<A[I], A[]>;
    record: { [K in string]: CustomIndex<A, T, I> };
    get name(): I;
    extractKey(value: A): A[I];
    extractKeys(value: A): A[I][];
}

Type Parameters

A extends object
T
I extends CustomIndexablesOf<A, T>

Implements

Index<A>
UnitIndex<A>

Properties

`Readonly`index

index: I

`Readonly`keyType

keyType: A[I]

`Readonly`makeIndex

makeIndex: () => BTree<A[I], A[]>

`Readonly`record

record: { [K in string]: CustomIndex<A, T, I> }

Accessors

name

get name(): I
Returns I
Implementation of Index.name
- Defined in src/indices.ts:30

Methods

extractKey

extractKey(value: A): A[I]
Parameters
- value: A
Returns A[I]
Implementation of UnitIndex.extractKey
- Defined in src/indices.ts:34

extractKeys

extractKeys(value: A): A[I][]
Parameters
- value: A
Returns A[I][]
Implementation of Index.extractKeys
- Defined in src/indices.ts:38