LatestMapArguments Interface
Arguments that are passed to the StateFactory.latestMap 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 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>; } | 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?: {
[K in Keys]: JsonSerializable<T>;
};
Type: { [K in Keys]: JsonSerializable<T>; }
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