> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bijection.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Class: PreparedAnalysis<T>

> A retained sample analysis, advanced by the native series work owner.

[server](https://docs.bijection.com/api/modules/server).PreparedAnalysis

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

## Type parameters

| Name |
| :- |
| `T` |

## Properties

### id

• `Readonly` **id**: `string`

## Accessors

### handle

• `get` **handle**(): [`PreparedAnalysisHandle`](https://docs.bijection.com/api/modules/server#preparedanalysishandle)\<`T`>

A serializable reference, including this reader's required-read policy.

#### Returns

[`PreparedAnalysisHandle`](https://docs.bijection.com/api/modules/server#preparedanalysishandle)\<`T`>

## Methods

### require

▸ **require**(`requirements`): [`PreparedAnalysis`](https://docs.bijection.com/api/classes/server.PreparedAnalysis)\<`T`>

#### Parameters

| Name | Type |
| :- | :- |
| `requirements` | [`SeriesReadRequirements`](https://docs.bijection.com/api/modules/server#seriesreadrequirements) |

#### Returns

[`PreparedAnalysis`](https://docs.bijection.com/api/classes/server.PreparedAnalysis)\<`T`>

***

### read

▸ **read**(): `Promise`\<[`PreparedAnalysisRead`](https://docs.bijection.com/api/modules/server#preparedanalysisread)\<`T`> | `null`>

#### Returns

`Promise`\<[`PreparedAnalysisRead`](https://docs.bijection.com/api/modules/server#preparedanalysisread)\<`T`> | `null`>

***

### cancel

▸ **cancel**(): `Promise`\<`boolean`>

Cancel pending work in a mutation through its existing cleanup owner.

#### Returns

`Promise`\<`boolean`>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.