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

# ClaimOptions

> Interface exported by @botmesh/core/spi.

Defined in: [durability/types.ts:103](https://github.com/andresayac/botmesh/blob/main/packages/core/src/durability/types.ts#L103)

Options of [InboxJournal.claim](https://botmesh.afaya.com.co/api/core/spi/interfaces/InboxJournal.md#claim) / [OutboxJournal.claimDue](https://botmesh.afaya.com.co/api/core/spi/interfaces/OutboxJournal.md#claimdue).

## Extends

* [`LeaseOptions`](https://botmesh.afaya.com.co/api/core/spi/interfaces/LeaseOptions)

## Extended by

* [`OutboxClaimOptions`](https://botmesh.afaya.com.co/api/core/spi/interfaces/OutboxClaimOptions)

## Properties

### owner

```ts theme={null}
owner: string;
```

Defined in: [durability/types.ts:91](https://github.com/andresayac/botmesh/blob/main/packages/core/src/durability/types.ts#L91)

Who takes the lease.

#### Inherited from

[`LeaseOptions`](https://botmesh.afaya.com.co/api/core/spi/interfaces/LeaseOptions).[`owner`](https://botmesh.afaya.com.co/api/core/spi/interfaces/LeaseOptions#owner)

***

### leaseMs

```ts theme={null}
leaseMs: number;
```

Defined in: [durability/types.ts:93](https://github.com/andresayac/botmesh/blob/main/packages/core/src/durability/types.ts#L93)

Lease duration in ms.

#### Inherited from

[`LeaseOptions`](https://botmesh.afaya.com.co/api/core/spi/interfaces/LeaseOptions).[`leaseMs`](https://botmesh.afaya.com.co/api/core/spi/interfaces/LeaseOptions#leasems)

***

### now

```ts theme={null}
now: number;
```

Defined in: [durability/types.ts:95](https://github.com/andresayac/botmesh/blob/main/packages/core/src/durability/types.ts#L95)

Current time (epoch ms).

#### Inherited from

[`LeaseOptions`](https://botmesh.afaya.com.co/api/core/spi/interfaces/LeaseOptions).[`now`](https://botmesh.afaya.com.co/api/core/spi/interfaces/LeaseOptions#now)

***

### limit

```ts theme={null}
limit: number;
```

Defined in: [durability/types.ts:105](https://github.com/andresayac/botmesh/blob/main/packages/core/src/durability/types.ts#L105)

Max records to claim.

***

### reclaimOwn?

```ts theme={null}
reclaimOwn?: boolean;
```

Defined in: [durability/types.ts:111](https://github.com/andresayac/botmesh/blob/main/packages/core/src/durability/types.ts#L111)

Also take records leased by `owner` itself whose lease has not expired yet: a
restarted process with a stable `instanceId` reclaims what its previous
incarnation left in flight, without waiting for the lease to expire.

***

### partitions?

```ts theme={null}
partitions?: (key) => boolean;
```

Defined in: [durability/types.ts:113](https://github.com/andresayac/botmesh/blob/main/packages/core/src/durability/types.ts#L113)

Only claim records whose partition (inbox) or chat (outbox) passes this filter (multi-replica ownership).

#### Parameters

| Parameter | Type |
| - | - |
| `key` | `string` |

#### Returns

`boolean`


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