Type Alias FractionalIndex<B, X>

FractionalIndex: (
    B extends AnyBinaryFractionalIndexBase
        ? Uint8Array<ArrayBuffer>
        : string
) & { __fraci__: { base: B; brand: X } }

A branded type representing a fractional index with encoding strategy based on the base configuration.

WARNING: DO NOT cast untrusted values to FractionalIndex as this may cause runtime exceptions.

Type Parameters

B extends FractionalIndexBase
The base configuration defining the encoding strategy
X
The brand type for type safety and identification

Type Declaration

Readonly Internal__fraci__: { base: B; brand: X }

Branding information for the fractional index. Does not exist at runtime.

See

FractionalIndex - The main type for fractional indices
AnyBinaryFractionalIndex - A type representing any binary fractional index
AnyStringFractionalIndex - A type representing any string fractional index