TransactionPostProcessor Interface

A type-erased function that post-processes the change produced when a transaction is committed.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface TransactionPostProcessor extends ErasedType<"@fluidframework/tree.TransactionPostProcessor">

Extends: ErasedType<"@fluidframework/tree.TransactionPostProcessor">

Remarks

Supply one via postProcessor to process/alter the change that a transaction produces. For example a post-processor could remove extraneous information, so that the resulting squashed change contains no extraneous information.

This type intentionally hides its internal representation: its concrete shape is an implementation detail of @fluidframework/tree. Obtain a value of this type from a @fluidframework/tree helper or constant rather than constructing one directly.