> ## 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.

# Interface: CapturingResults

> Reference for the CapturingResults interface in bijection/results.

[results](https://docs.bijection.com/api/modules/results).CapturingResults

## Hierarchy

* [`Results`](https://docs.bijection.com/api/interfaces/server.Results)

  ↳ **`CapturingResults`**

## Methods

### inspect

▸ **inspect**(`result`, `claim?`): `Promise`\<[`ResultInspection`](https://docs.bijection.com/api/modules/server#resultinspection)>

#### Parameters

| Name | Type |
| :- | :- |
| `result` | [`ResultRef`](https://docs.bijection.com/api/modules/computations#resultref)\<`any`> |
| `claim?` | [`ResultHold`](https://docs.bijection.com/api/modules/server#resultclaim) |

#### Returns

`Promise`\<[`ResultInspection`](https://docs.bijection.com/api/modules/server#resultinspection)>

#### Inherited from

[Results](https://docs.bijection.com/api/interfaces/server.Results.md).[inspect](https://docs.bijection.com/api/interfaces/server.Results.md#inspect)

***

### require

▸ **require**\<`T`>(`result`, `requirements`, `claim?`): `Promise`\<[`RequiredResult`](https://docs.bijection.com/api/modules/computations#requiredresult)\<`T`>>

Check exact definition, source evidence and current access in this read's
transaction. Expiry also bounds query caching and mutation commit.

#### Type parameters

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

#### Parameters

| Name | Type |
| :- | :- |
| `result` | [`ResultRef`](https://docs.bijection.com/api/modules/computations#resultref)\<`T`> |
| `requirements` | [`ResultRequirements`](https://docs.bijection.com/api/modules/computations#resultrequirements) |
| `claim?` | [`ResultHold`](https://docs.bijection.com/api/modules/server#resultclaim) |

#### Returns

`Promise`\<[`RequiredResult`](https://docs.bijection.com/api/modules/computations#requiredresult)\<`T`>>

#### Inherited from

[Results](https://docs.bijection.com/api/interfaces/server.Results.md).[require](https://docs.bijection.com/api/interfaces/server.Results.md#require)

***

### read

▸ **read**\<`T`>(`result`, `claim?`): `Promise`\<`T`>

Read an inline artifact value. Resident domains keep their exact reference
and use explicit delivery preparation for an executor input.

#### Type parameters

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

#### Parameters

| Name | Type |
| :- | :- |
| `result` | [`ResultRef`](https://docs.bijection.com/api/modules/computations#resultref)\<`T`, `"artifact"`> |
| `claim?` | [`ResultHold`](https://docs.bijection.com/api/modules/server#resultclaim) |

#### Returns

`Promise`\<`T`>

#### Inherited from

[Results](https://docs.bijection.com/api/interfaces/server.Results.md).[read](https://docs.bijection.com/api/interfaces/server.Results.md#read)

***

### paginate

▸ **paginate**\<`Row`>(`result`, `request`, `claim?`): `Promise`\<[`ResultPage`](https://docs.bijection.com/api/modules/server#resultpage)\<`Row`>>

#### Type parameters

| Name |
| :- |
| `Row` |

#### Parameters

| Name | Type |
| :- | :- |
| `result` | [`ResultRef`](https://docs.bijection.com/api/modules/computations#resultref)\<`Row`, `"dataset"`> |
| `request` | [`PaginationOptions`](https://docs.bijection.com/api/interfaces/server.PaginationOptions) |
| `claim?` | [`ResultHold`](https://docs.bijection.com/api/modules/server#resultclaim) |

#### Returns

`Promise`\<[`ResultPage`](https://docs.bijection.com/api/modules/server#resultpage)\<`Row`>>

#### Inherited from

[Results](https://docs.bijection.com/api/interfaces/server.Results.md).[paginate](https://docs.bijection.com/api/interfaces/server.Results.md#paginate)

***

### lookupRow

▸ **lookupRow**\<`Row`, `Key`, `Fields`>(`result`, `lookup`, `claim?`): `Promise`\<`Omit`\<[`ResultRowLookupResult`](https://docs.bijection.com/api/modules/computations_adapters#resultrowlookupresult), `"value"`> & \{ `value`: `Pick`\<`Row`, `Fields`\[`number`]> | `null`  }>

Resolve one unique row with independent indexed-read and retained-value bounds.

#### Type parameters

| Name | Type |
| :- | :- |
| `Row` | extends `Record`\<`string`, `any`> |
| `Key` | extends readonly `string`\[] |
| `Fields` | extends readonly keyof `Row` & `string`\[] |

#### Parameters

| Name | Type |
| :- | :- |
| `result` | [`KeyedResultRef`](https://docs.bijection.com/api/modules/computations#keyedresultref)\<`Row`, `Key`> |
| `lookup` | [`KeyedResultRowLookup`](https://docs.bijection.com/api/modules/results#keyedresultrowlookup)\<`Row`, `Key`, `Fields`> |
| `claim?` | [`ResultHold`](https://docs.bijection.com/api/modules/server#resultclaim) |

#### Returns

`Promise`\<`Omit`\<[`ResultRowLookupResult`](https://docs.bijection.com/api/modules/computations_adapters#resultrowlookupresult), `"value"`> & \{ `value`: `Pick`\<`Row`, `Fields`\[`number`]> | `null`  }>

#### Inherited from

[Results](https://docs.bijection.com/api/interfaces/server.Results.md).[lookupRow](https://docs.bijection.com/api/interfaces/server.Results.md#lookuprow)

***

### check

▸ **check**(`claim`): `Promise`\<[`InputAssessment`](https://docs.bijection.com/api/modules/computations#inputassessment)>

#### Parameters

| Name | Type |
| :- | :- |
| `claim` | [`ResultHold`](https://docs.bijection.com/api/modules/server#resultclaim) |

#### Returns

`Promise`\<[`InputAssessment`](https://docs.bijection.com/api/modules/computations#inputassessment)>

#### Inherited from

[Results](https://docs.bijection.com/api/interfaces/server.Results.md).[check](https://docs.bijection.com/api/interfaces/server.Results.md#check)

***

### prepareDelivery

▸ **prepareDelivery**(`result`, `claim`): `Promise`\<[`ResolvedInput`](https://docs.bijection.com/api/modules/computations#resolvedinput)>

Prepare the exact retained input under the current invocation's admitted
recipient and disclosure policy. Always a mutation, including for owners
whose placement contains no credentials.

#### Parameters

| Name | Type |
| :- | :- |
| `result` | [`ResultRef`](https://docs.bijection.com/api/modules/computations#resultref)\<`any`> |
| `claim` | [`ResultHold`](https://docs.bijection.com/api/modules/server#resultclaim) |

#### Returns

`Promise`\<[`ResolvedInput`](https://docs.bijection.com/api/modules/computations#resolvedinput)>

#### Inherited from

[Results](https://docs.bijection.com/api/interfaces/server.Results.md).[prepareDelivery](https://docs.bijection.com/api/interfaces/server.Results.md#preparedelivery)

***

### handoff

▸ **handoff**(`previous`, `result`, `options`): `Promise`\<[`CustodyOutcome`](https://docs.bijection.com/api/modules/server#custodyoutcome)>

Acquire a successor before releasing its predecessor in this mutation.
Persist a pending preparation with the existing result still held.

#### Parameters

| Name | Type |
| :- | :- |
| `previous` | [`ResultHold`](https://docs.bijection.com/api/modules/server#resultclaim) |
| `result` | [`ResultRef`](https://docs.bijection.com/api/modules/computations#resultref)\<`any`> |
| `options` | [`ResultRetention`](https://docs.bijection.com/api/modules/results#resultretention) |

#### Returns

`Promise`\<[`CustodyOutcome`](https://docs.bijection.com/api/modules/server#custodyoutcome)>

#### Inherited from

[Results](https://docs.bijection.com/api/interfaces/server.Results.md).[handoff](https://docs.bijection.com/api/interfaces/server.Results.md#handoff)

***

### acquire

▸ **acquire**(`result`, `options`): `Promise`\<[`CustodyOutcome`](https://docs.bijection.com/api/modules/server#custodyoutcome)>

#### Parameters

| Name | Type |
| :- | :- |
| `result` | [`ResultRef`](https://docs.bijection.com/api/modules/computations#resultref)\<`any`> |
| `options` | [`ResultRetention`](https://docs.bijection.com/api/modules/results#resultretention) |

#### Returns

`Promise`\<[`CustodyOutcome`](https://docs.bijection.com/api/modules/server#custodyoutcome)>

#### Inherited from

[Results](https://docs.bijection.com/api/interfaces/server.Results.md).[acquire](https://docs.bijection.com/api/interfaces/server.Results.md#acquire)

***

### release

▸ **release**(`claim`): `Promise`\<`void`>

#### Parameters

| Name | Type |
| :- | :- |
| `claim` | [`ResultHold`](https://docs.bijection.com/api/modules/server#resultclaim) |

#### Returns

`Promise`\<`void`>

#### Inherited from

[Results](https://docs.bijection.com/api/interfaces/server.Results.md).[release](https://docs.bijection.com/api/interfaces/server.Results.md#release)

***

### abandon

▸ **abandon**(`preparation`): `Promise`\<`void`>

#### Parameters

| Name | Type |
| :- | :- |
| `preparation` | [`PreparationRef`](https://docs.bijection.com/api/modules/server#preparationref) |

#### Returns

`Promise`\<`void`>

#### Inherited from

[Results](https://docs.bijection.com/api/interfaces/server.Results.md).[abandon](https://docs.bijection.com/api/interfaces/server.Results.md#abandon)

***

### capture

▸ **capture**\<`Row`, `Scope`>(`definition`, `input`): `ReturnType`\<typeof [`captureDataset`](https://docs.bijection.com/api/modules/results#capturedataset)>

#### Type parameters

| Name | Type |
| :- | :- |
| `Row` | extends [`GenericValidator`](https://docs.bijection.com/api/modules/values#genericvalidator) |
| `Scope` | extends [`GenericValidator`](https://docs.bijection.com/api/modules/values#genericvalidator) |

#### Parameters

| Name | Type |
| :- | :- |
| `definition` | [`CapturedDataset`](https://docs.bijection.com/api/modules/results#captureddataset)\<`Row`, `Scope`> |
| `input` | `Parameters`\<typeof [`captureDataset`](https://docs.bijection.com/api/modules/results#capturedataset)>\[`2`] |

#### Returns

`ReturnType`\<typeof [`captureDataset`](https://docs.bijection.com/api/modules/results#capturedataset)>


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