Skip to main content

ObservationOptions Interface

Options for useTreeObservations(trackDuring, options).

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

To use, import via @fluidframework/react/alpha.

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 ObservationOptions

Properties​

PropertyAlertsModifiersTypeDescription
onInvalidationAlphaoptional() => voidCalled when the tracked observations are invalidated.

Property Details​

onInvalidation​

Called when the tracked observations are invalidated.

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

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

Signature​

onInvalidation?: () => void;

Type: () => void

Remarks​

This is not expected to have production use cases, but is useful for testing and debugging.