TransactionLabels TypeAlias

A set of transaction labels with an optional structural tree.

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

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 type TransactionLabels = Set<unknown> & {
    tree?: LabelTree;
};

Remarks

The set contains all label values from the transactions that produced the change. Use standard Set methods to check for specific labels.

The optional tree property provides the structural nesting of the transactions as a LabelTree.