LatestMapArguments Interface
Arguments that are passed to the StateFactory.latestMap function.
This API is provided as a beta preview and may change without notice.
To use, import via @fluidframework/presence/beta.
For more information about our API support guarantees, see here.
Signature
export interface LatestMapArguments<T, Keys extends string | number = string | number>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| T | |||
| Keys | string | number | string | number |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| local | Beta |
optional |
{ [K in Keys]: JsonSerializable<T> & JsonDeserialized<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.
This API is provided as a beta preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
local?: {
[K in Keys]: JsonSerializable<T> & JsonDeserialized<T>;
};
Type: { [K in Keys]: JsonSerializable<T> & JsonDeserialized<T>; }
settings
This API is provided as a beta preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
settings?: BroadcastControlSettings | undefined;
Type: BroadcastControlSettings | undefined