Skip to main content

ObservationResults Interface

Results from an operation with tracked observations.

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 interface ObservationResults<TResult>

Type Parameters

Parameter Description
TResult

Remarks

Results from trackObservations(onInvalidation, trackDuring) or trackObservationsOnce(onInvalidation, trackDuring). \

Properties

Property Alerts Modifiers Type Description
result Alpha readonly TResult The result of the operation which had its observations tracked.
unsubscribe Alpha readonly () => void Call to unsubscribe from further invalidations.

Property Details

result

The result of the operation which had its observations tracked.

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

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

Signature
readonly result: TResult;

Type: TResult

unsubscribe

Call to unsubscribe from further invalidations.

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

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

Signature
readonly unsubscribe: () => void;

Type: () => void