Skip to main content

@fluidframework/counter Package

This library contains the SharedCounter distributed data structure. A SharedCounter is a shared object which holds a whole number that can be incremented or decremented.

Interfaces​

InterfaceAlertsDescription
ISharedCounterLegacyA shared object that holds a number that can be incremented or decremented.
ISharedCounterEventsLegacyEvents sent by ISharedCounter.

Types​

TypeAliasAlertsDescription
SharedCounterLegacyAlias for ISharedCounter for compatibility.

Variables​

VariableAlertsModifiersTypeDescription
SharedCounterLegacyreadonlyimport("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedCounter> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedCounter>Entrypoint for ISharedCounter creation.

Variable Details​

SharedCounter​

Entrypoint for ISharedCounter creation.

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

To use, import via @fluidframework/counter/legacy.

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

Signature​

SharedCounter: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedCounter> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedCounter>

Type: import("@fluidframework/shared-object-base/internal").ISharedObjectKind<ISharedCounter> & import("@fluidframework/shared-object-base/internal").SharedObjectKind<ISharedCounter>