Class: PreparedAnalysis<T>

server.PreparedAnalysis A retained sample analysis, advanced by the native series work owner. Polling never captures a newer population.

​

Type parameters

​

Properties

​

id

• Readonly id: string

​

Accessors

​

handle

• get handle(): PreparedAnalysisHandle<T> A serializable reference, including this reader’s required-read policy.

​

Returns

PreparedAnalysisHandle<T>

​

Methods

​

require

▸ require(requirements): PreparedAnalysis<T>

​

Parameters

​

Returns

PreparedAnalysis<T>

---

​

read

▸ read(): Promise<PreparedAnalysisRead<T> | null>

​

Returns

Promise<PreparedAnalysisRead<T> | null>

---

​

cancel

▸ cancel(): Promise<boolean> Cancel pending work in a mutation through its existing cleanup owner.

​

Returns

Promise<boolean>