Skip to main content
Version: v2

IProposal Interface

Proposal to set the given key/value pair.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/driver-definitions/legacy.

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​

PropertyAlertsTypeDescription
keyBetastringThe key for the proposal.
valueBetaunknownThe value of the proposal.

Property Details​

key​

The key for the proposal.

This API is provided for existing users, but is not recommended for new users.

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 for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

value: unknown;

Type: unknown