Packages > @fluidframework/counter > ISharedCounter

ISharedCounter Interface

SharedCounter interface.

Signature

export interface ISharedCounter extends ISharedObject<ISharedCounterEvents>

Extends: ISharedObject <ISharedCounterEvents

Properties

Property Type Description
value number The counter value.

Methods

Method Return Type Description
increment(incrementAmount) void Increments or decrements the value. Must only increment or decrement by a whole number value.

Property Details

value

The counter value.

Signature

value: number;

Method Details

increment

Increments or decrements the value. Must only increment or decrement by a whole number value.

Signature

increment(incrementAmount: number): void;

Parameters

Parameter Type Description
incrementAmount number a whole number to increment or decrement by.