RunTransactionParamsBeta Interface
The parameters for the RunTransaction API.
This API is provided as a beta preview and may change without notice.
To use, import via fluid-framework/beta.
For more information about our API support guarantees, see here.
Input
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 RunTransactionParamsBeta
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| label | Beta | optional, readonly | unknown | A label for this transaction that allows it to be correlated with later edits (e.g. for controlling undo/redo grouping). |
Property Details
label
A label for this transaction that allows it to be correlated with later edits (e.g. for controlling undo/redo grouping).
This API is provided as a beta preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly label?: unknown;
Type: unknown
Remarks
If this transaction is applied to a branch, the label will be available in the metadata of the `changed` event.
If there is a nested transaction, only the outermost transaction label will be used.