Interface GenIndex<T, I, G>

Generational index factory.

interface GenIndex<T, I, G> {
    MAX_GENERATION: G;
    create(index?, generation?): T;
    generationOf(id): G;
    indexOf(id): I;
    next(id): T;
    nextGeneration(generation): G;
}

Type Parameters

T = number
I = number
G = number

Index

Properties

Methods

create generationOf indexOf next nextGeneration

Properties

`Readonly` MAX_GENERATION

MAX_GENERATION: G

The maximum generation value.

Methods

create

create(index?, generation?): T
Creates a generational index ID from index and generation parts.
Parameters
- Optional index: I
- Optional generation: G
Returns T
- Defined in genindex.ts:7

generationOf

generationOf(id): G
Returns the generation part of a generational index ID.
Parameters
- id: T
Returns G
- Defined in genindex.ts:16

indexOf

indexOf(id): I
Returns the index part of a generational index ID.
Parameters
- id: T
Returns I
- Defined in genindex.ts:13

next

next(id): T
Returns the same index ID at next generation.
Parameters
- id: T
Returns T
- Defined in genindex.ts:10

nextGeneration

nextGeneration(generation): G
Returns the next value for the given generation.
Parameters
- generation: G
Returns G
- Defined in genindex.ts:19

Generated using TypeDoc