IProposal Interface
Packages > @fluidframework/protocol-definitions > IProposal
Proposal to set the given key/value pair.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/protocol-definitions/alpha
.
For more information about our API support guarantees, see here .
Signature
export interface IProposal
Remarks
Consensus on the proposal is achieved if the MSN is >= the sequence number at which the proposal is made and no client within the collaboration window rejects the proposal.
Properties
Property | Alerts | Type | Description |
---|---|---|---|
key | Alpha |
string | The key for the proposal. |
value | Alpha |
unknown | The value of the proposal. |
Property Details
key
The key for the proposal.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/protocol-definitions/alpha
.
For more information about our API support guarantees, see here .
Signature
key: string;
Type: string
value
The value of the proposal.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/protocol-definitions/alpha
.
For more information about our API support guarantees, see here .
Signature
value: unknown;
Type: unknown