> ## 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: RetainedResultReader

> Kept result custody inside a transaction.

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

Kept result custody inside a transaction.

## Methods

### inspect

▸ **inspect**(`result`): `Promise`\<[`KeptResult`](https://docs.bijection.com/api/interfaces/server.KeptResult)>

A kept result (`queryArtifacts.create`) this component holds or kept, named
by its id or by the request key this holder keeps it under, read under
its file's current source authority: current source permissions and
erasure are read dependencies. No URL, secret or lease. Refused alike
for an unknown result, another component's and one whose sources the
caller may not read.

#### Parameters

| Name | Type |
| :- | :- |
| `result` | [`KeptResultRef`](https://docs.bijection.com/api/modules/server#keptresultref) \| \{ `request_id`: `string`  } |

#### Returns

`Promise`\<[`KeptResult`](https://docs.bijection.com/api/interfaces/server.KeptResult)>

***

### deliver

▸ **deliver**(`id`, `options?`): `Promise`\<[`WorkloadDelivery`](https://docs.bijection.com/api/interfaces/server.WorkloadDelivery) & \{ `file`: `string`  }>

This holder's delivery of its kept result to its worker, as
`ctx.files.redeemWorkloadGrant` returns one, under a workload grant of
the result's request key: the keep issued it, and once it has expired
this reissues it under the file's current source authority. `expires_at`
bounds this delivery in epoch milliseconds. Mutations only.

#### Parameters

| Name | Type |
| :- | :- |
| `id` | [`KeptResultRef`](https://docs.bijection.com/api/modules/server#keptresultref) |
| `options?` | `Object` |
| `options.expires_at?` | `number` |

#### Returns

`Promise`\<[`WorkloadDelivery`](https://docs.bijection.com/api/interfaces/server.WorkloadDelivery) & \{ `file`: `string`  }>

***

### end

▸ **end**(`result`): `Promise`\<`boolean`>

End a kept result this component holds, named by its id or by the
request key it was kept under: the record, its hold on the file and its
delivery grant end in this commit, and the file is reclaimed once
nothing else retains it. Returns whether one ended. Mutations only.

#### Parameters

| Name | Type |
| :- | :- |
| `result` | [`KeptResultRef`](https://docs.bijection.com/api/modules/server#keptresultref) \| \{ `request_id`: `string`  } |

#### Returns

`Promise`\<`boolean`>


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