SharedNumberSequence Class

Packages > fluid-framework > SharedNumberSequence

Deprecated

SharedNumberSequence is not recommended for use and will be removed in an upcoming release. For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)

The SharedNumberSequence holds a sequence of numbers. Each number will be stored at a position within the sequence. See the sequence documentation for details on working with sequences.

Signature:

export declare class SharedNumberSequence extends SharedSequence<number> 

Extends: SharedSequence

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(document, id, attributes) Constructs a new instance of the SharedNumberSequence class

Properties

List of properties for this class
Property Modifiers Type Description
id

Methods

List of methods on this class
Method Modifiers Description
create(runtime, id) static Create a new shared number sequence
getFactory() static Get a factory for SharedNumberSequence to register with the data store.
getRange(start, end)

Constructors

SharedNumberSequence.(constructor)

Deprecated

SharedNumberSequence is not recommended for use and will be removed in an upcoming release. For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)

Constructs a new instance of the SharedNumberSequence class

Signature:

constructor(document: IFluidDataStoreRuntime, id: string, attributes: IChannelAttributes);

Parameters

List of parameters
Parameter Type Description
document
id
attributes

Properties

id

Signature:

id: string;

Methods

create

Deprecated

SharedNumberSequence is not recommended for use and will be removed in an upcoming release. For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)

Create a new shared number sequence

Signature:

static create(runtime: IFluidDataStoreRuntime, id?: string): SharedNumberSequence;

Parameters

List of parameters
Parameter Type Description
runtime data store runtime the new shared number sequence belongs to
id optional name of the shared number sequence

Returns:

SharedNumberSequence

newly create shared number sequence (but not attached yet)

getFactory

Deprecated

SharedNumberSequence is not recommended for use and will be removed in an upcoming release. For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)

Get a factory for SharedNumberSequence to register with the data store.

Signature:

static getFactory(): SharedNumberSequenceFactory;

Returns:

SharedNumberSequenceFactory

a factory that creates and load SharedNumberSequence

getRange

Deprecated

SharedNumberSequence is not recommended for use and will be removed in an upcoming release. For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)

Signature:

getRange(start: number, end?: number): number[];

Parameters

List of parameters
Parameter Type Description
start
end

Returns: