@fluidframework/ordered-collection Package
Interfaces
| Interface | Alerts | Description |
|---|---|---|
| IConsensusOrderedCollection | Legacy, Alpha |
Consensus Ordered Collection interface An consensus ordered collection is a distributed data structure, which holds a collection of JSON-able or handles, and has a deterministic add/remove order. |
| IConsensusOrderedCollectionEvents | Legacy, Alpha |
Events notifying about addition, acquisition, release and completion of items |
| IOrderedCollection | Legacy, Alpha |
Ordered Collection interface Collection of objects that has deterministic add and remove ordering. Object implementing this interface can be used as the data backing for the ConsensusOrderedCollection |
| ISnapshotable | Legacy, Alpha |
Interface for object that can be snapshoted TODO: move this to be use in other place TODO: currently input and output is not symmetrical, can they become symmetrical? |
Classes
| Class | Alerts | Description |
|---|---|---|
| ConsensusOrderedCollection | Legacy, Alpha |
Implementation of a consensus collection shared object Implements the shared object's communication, and the semantics around the release/complete mechanism following acquire. Generally not used directly. A derived type will pass in a backing data type IOrderedCollection that will define the deterministic add/acquire order and snapshot ability. |
| ConsensusQueueClass | Legacy, Alpha |
Implementation of a consensus stack An derived type of ConsensusOrderedCollection with a queue as the backing data and order. |
Enumerations
| Enum | Alerts | Description |
|---|---|---|
| ConsensusResult | Legacy, Alpha |
Types
| TypeAlias | Alerts | Description |
|---|---|---|
| ConsensusCallback | Legacy, Alpha |
Callback provided to acquire() and waitAndAcquire() methods. |
| ConsensusQueue | Legacy, Alpha |
Implementation of a consensus stack An derived type of ConsensusOrderedCollection with a queue as the backing data and order. |
Variables
| Variable | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| ConsensusQueue | Legacy, Alpha |
readonly |
import("@fluidframework/shared-object-base/internal").ISharedObjectKind<IConsensusOrderedCollection<any>> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<IConsensusOrderedCollection<any>> |
Implementation of a consensus stack An derived type of ConsensusOrderedCollection with a queue as the backing data and order. |
Variable Details
ConsensusQueue
Implementation of a consensus stack
An derived type of ConsensusOrderedCollection with a queue as the backing data and order.
To use, import via @fluidframework/ordered-collection/legacy.
For more information about our API support guarantees, see here.
Signature
ConsensusQueue: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<IConsensusOrderedCollection<any>> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<IConsensusOrderedCollection<any>>
Type: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<IConsensusOrderedCollection<any>> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<IConsensusOrderedCollection<any>>