RunTransactionParamsAlpha Interface
The parameters for the RunTransaction API, extended with alpha-only constraint options.
To use, import via fluid-framework/alpha.
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 RunTransactionParamsAlpha extends RunTransactionParamsBeta
Extends: RunTransactionParamsBeta
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| postProcessor | Alpha | optional, readonly | TransactionPostProcessor | An optional post-processor applied to the change produced when this transaction is committed. |
| preconditions | Alpha | optional, readonly | readonly TransactionConstraintAlpha[] | An optional list of constraints that are checked just before the transaction begins. |
Property Details
postProcessor
An optional post-processor applied to the change produced when this transaction is committed.
For more information about our API support guarantees, see here.
Signature
readonly postProcessor?: TransactionPostProcessor;
Type: TransactionPostProcessor
Remarks
When omitted, the transaction's edits are squashed without any such processing.
Specific post-processors are applied according to their own rules for optimization and other post-processing tasks in a transaction stack. For example a "minimization" post-processor may be applied once for the outermost transaction in a stack as it will process all nested edits and there is no benefit from multiple applications.
Note: minimization is not yet implemented. Supplying a post-processor currently has no observable effect beyond reserving the behavior; a real post-processor will be provided in a future change.
preconditions
An optional list of constraints that are checked just before the transaction begins.
For more information about our API support guarantees, see here.
Signature
readonly preconditions?: readonly TransactionConstraintAlpha[];
Type: readonly TransactionConstraintAlpha[]
Remarks
If any of the constraints are not met when runTransaction is called, an error will be thrown. If any of the constraints are not met after the transaction has been ordered by the service, it will be rolled back on this client and ignored by all other clients.