# UncageOptions

<!-- https://uncage.vercel.app/docs/api/core/interfaces/uncageoptions/ -->

Defined in: core/src/uncage.ts:31

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-adapters"></a> `adapters` | `RuntimeAdapter`[] | - | core/src/uncage.ts:32 |
| <a id="property-approvals"></a> `approvals?` | `object` | `ttlMs` defaults to 600_000. | core/src/uncage.ts:40 |
| `approvals.ttlMs?` | `number` | - | core/src/uncage.ts:40 |
| <a id="property-datadir"></a> `dataDir?` | `string` | Defaults to `~/.uncage/data`; `'memory://'` keeps everything in memory. | core/src/uncage.ts:36 |
| <a id="property-eventretentiondays"></a> `eventRetentionDays?` | `number` | Defaults to 7. | core/src/uncage.ts:42 |
| <a id="property-logger"></a> `logger?` | `Logger` | - | core/src/uncage.ts:45 |
| <a id="property-security"></a> `security?` | `object` | `allowBypass` (default false) enables the `bypassPermissions` permission mode. | core/src/uncage.ts:44 |
| `security.allowBypass?` | `boolean` | - | core/src/uncage.ts:44 |
| <a id="property-store"></a> `store?` | [`Store`](https://uncage.vercel.app/docs/api/core/interfaces/store.md) | Custom persistence; defaults to `openPgliteStore({ dataDir })`. Closed by `close()`. | core/src/uncage.ts:34 |
| <a id="property-workspace"></a> `workspace?` | `object` | Defaults: `allowedRoots: [process.cwd()]`, `default: process.cwd()`. | core/src/uncage.ts:38 |
| `workspace.allowedRoots?` | `string`[] | - | core/src/uncage.ts:38 |
| `workspace.default?` | `string` | - | core/src/uncage.ts:38 |

## Methods

### onEvent()?

```ts
onEvent?(e): void;
```

Defined in: core/src/uncage.ts:51

Sees every committed event of every session (e.g. to replicate them elsewhere), in sequence
order per session, synchronously after commit. It is never awaited: keep it cheap and
non-blocking. A throw, or a rejection of a returned promise, is logged and never affects the run.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `e` | `UncageEvent` |

#### Returns

`void`
