IConsensusOrderedCollectionFactory Interface

Packages > @fluidframework/ordered-collection > IConsensusOrderedCollectionFactory

Consensus Ordered Collection channel factory interface

Extends the base IChannelFactory to return a more definite type of IConsensusOrderedCollection Use for the runtime to create and load distributed data structure by type name of each channel

Signature:

export interface IConsensusOrderedCollectionFactory extends IChannelFactory 

Extends: IChannelFactory

Methods

List of methods of this class
Method Description
create(document, id)
load(document, id, services, attributes)

Methods

create

Signature:

create(document: IFluidDataStoreRuntime, id: string): IConsensusOrderedCollection;

Parameters

List of parameters
Parameter Type Description
document IFluidDataStoreRuntime
id string

Returns:

IConsensusOrderedCollection

load

Signature:

load(document: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IConsensusOrderedCollection>;

Parameters

List of parameters
Parameter Type Description
document IFluidDataStoreRuntime
id string
services IChannelServices
attributes IChannelAttributes

Returns:

Promise<IConsensusOrderedCollection>