Skip to main content
Version: v1

IConsensusOrderedCollectionFactory Interface

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

Method Return Type Description
create(document, id) IConsensusOrderedCollection
load(document, id, services, attributes) Promise<IConsensusOrderedCollection>

Method Details

create

Signature

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

Parameters

Parameter Type Description
document IFluidDataStoreRuntime
id string

Returns

Return type: IConsensusOrderedCollection

load

Signature

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

Parameters

Parameter Type Description
document IFluidDataStoreRuntime
id string
services IChannelServices
attributes IChannelAttributes

Returns

Return type: Promise<IConsensusOrderedCollection>