LatestArguments Interface
Arguments that are passed to the StateFactory.latest function.
To use, import via @fluidframework/presence/beta.
For more information about our API support guarantees, see here.
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 LatestArguments<T extends object | null>
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| T | object | null |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| local | Beta |
JsonSerializable<T> | The initial value of the local state. | |
| settings | Beta |
optional |
BroadcastControlSettings | undefined | See BroadcastControlSettings. |
Property Details
local
The initial value of the local state.
For more information about our API support guarantees, see here.
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
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
For more information about our API support guarantees, see here.
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
settings?: BroadcastControlSettings | undefined;
Type: BroadcastControlSettings | undefined