Skip to main content

LatestArgumentsRaw Interface

Arguments that are passed to the @fluidframework/presence#StateFactory.latest function to create a LatestRaw State object.

Input

This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.

Signature

export interface LatestArgumentsRaw<T extends object | null>

Type Parameters

ParameterConstraintDescription
Tobject | null

Properties

PropertyModifiersTypeDescription
localJsonSerializable<T>The initial value of the local state.
settingsoptionalBroadcastControlSettings | undefinedSee BroadcastControlSettings.

Property Details

local

The initial value of the local state.

Signature

local: JsonSerializable<T>;

Type: JsonSerializable<T>

Remarks

latest assumes ownership of the value and its references. Make a deep clone before passing, if needed.

settings

See BroadcastControlSettings.

Signature

settings?: BroadcastControlSettings | undefined;

Type: BroadcastControlSettings | undefined