Interface Fraci<B, X>

Fractional indexing utility that provides methods for generating ordered keys.

See

fraci - The unified factory function for creating fractional indexing utilities
fraciBinary - The factory function for creating binary-based fractional indexing utilities
fraciString - The factory function for creating string-based fractional indexing utilities

interface Fraci<B extends FractionalIndexBase, X> {
    base: B;
    brand?: X;
    generateKeyBetween(
        a: null | FractionalIndex<B, X>,
        b: null | FractionalIndex<B, X>,
        skip?: number,
    ): Generator<FractionalIndex<B, X>, never, unknown>;
    generateNKeysBetween(
        a: null | FractionalIndex<B, X>,
        b: null | FractionalIndex<B, X>,
        n: number,
        skip?: number,
    ): Generator<FractionalIndex<B, X>[], never, unknown>;
}

Type Parameters

B extends FractionalIndexBase
The base configuration defining the encoding strategy
X
The brand type for the fractional index

Index

Properties

Methods

generateKeyBetween generateNKeysBetween

Properties

`Readonly`base

base: B

The character sets used for representing digits in the fractional index.

`Optional` `Readonly` `Internal`brand

brand?: X

The brand type for the fractional index. Does not exist at runtime.

Methods

generateKeyBetween

generateKeyBetween(
    a: null | FractionalIndex<B, X>,
    b: null | FractionalIndex<B, X>,
    skip?: number,
): Generator<FractionalIndex<B, X>, never, unknown>
Generates a key between two existing keys. Returns a generator that yields new unique keys between the provided bounds.
Parameters
- a: null | FractionalIndex<B, X>
  The lower bound key, or null if there is no lower bound
- b: null | FractionalIndex<B, X>
  The upper bound key, or null if there is no upper bound
- Optionalskip: number
  Number of conflict avoidance iterations to skip (default: 0)
Returns Generator<FractionalIndex<B, X>, never, unknown>
A generator yielding fractional index keys

Throws
Throws a FraciError when invalid input is provided

Throws
Throws a FraciError when the generated key exceeds the maximum length

See
FraciError - The custom error class for the Fraci library
- Defined in src/factory.ts:105

generateNKeysBetween

generateNKeysBetween(
    a: null | FractionalIndex<B, X>,
    b: null | FractionalIndex<B, X>,
    n: number,
    skip?: number,
): Generator<FractionalIndex<B, X>[], never, unknown>
Generates multiple keys evenly distributed between two existing keys. Returns a generator that yields arrays of new unique keys.
Parameters
- a: null | FractionalIndex<B, X>
  The lower bound key, or null if there is no lower bound
- b: null | FractionalIndex<B, X>
  The upper bound key, or null if there is no upper bound
- n: number
  Number of keys to generate
- Optionalskip: number
  Number of conflict avoidance iterations to skip (default: 0)
Returns Generator<FractionalIndex<B, X>[], never, unknown>
A generator yielding arrays of fractional index keys

Throws
Throws a FraciError when invalid input is provided

Throws
Throws a FraciError when the generated keys would exceed the maximum length

See
FraciError - The custom error class for the Fraci library
- Defined in src/factory.ts:148