IdCreationRange Interface

Data describing a range of session-local IDs (from a remote or local session).

A range is composed of local IDs that were generated.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/id-compressor/legacy.

For more information about our API support guarantees, see here.

Signature

export interface IdCreationRange

Properties

Property	Alerts	Modifiers	Type	Description
ids	Beta	optional, readonly	{ readonly firstGenCount: number; readonly count: number; readonly requestedClusterSize: number; readonly localIdRanges: [genCount: number, count: number][]; }
sessionId	Beta	readonly	SessionId

Property Details

ids

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly ids?: {
        readonly firstGenCount: number;
        readonly count: number;
        readonly requestedClusterSize: number;
        readonly localIdRanges: [genCount: number, count: number][];
    };

Type: { readonly firstGenCount: number; readonly count: number; readonly requestedClusterSize: number; readonly localIdRanges: [genCount: number, count: number][]; }

sessionId

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly sessionId: SessionId;

Type: SessionId