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

# RedactOptions

> Interface exported by @botmesh/core.

Defined in: [testing/transcripts/redact.ts:52](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/transcripts/redact.ts#L52)

Options for [redactTranscript](https://botmesh.afaya.com.co/api/core/functions/redactTranscript.md).

## Properties

### emails?

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

Defined in: [testing/transcripts/redact.ts:54](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/transcripts/redact.ts#L54)

Redact emails in texts (default `true`).

***

### phones?

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

Defined in: [testing/transcripts/redact.ts:56](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/transcripts/redact.ts#L56)

Redact phone-like digit runs (7+ digits) in texts (default `true`).

***

### ids?

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

Defined in: [testing/transcripts/redact.ts:58](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/transcripts/redact.ts#L58)

Replace chat/sender/message ids with placeholders (default `true`).

***

### displayNames?

```ts theme={null}
displayNames?: "drop" | "placeholder" | "keep";
```

Defined in: [testing/transcripts/redact.ts:64](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/transcripts/redact.ts#L64)

Display names: `'placeholder'` (default) replaces them with `<name:N>` in the
field and in every text; `'drop'` removes the field but still redacts the name
in texts; `'keep'` leaves them untouched.

***

### outboundPatterns?

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

Defined in: [testing/transcripts/redact.ts:70](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/transcripts/redact.ts#L70)

Apply the email/phone/custom patterns to outbound texts too (default `false`:
outbound texts only get values learned from inbound turns). Replay such a
golden with `replayTranscript(..., { redact: { ... } })`.

***

### surrogates?

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

Defined in: [testing/transcripts/redact.ts:76](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/transcripts/redact.ts#L76)

Use format-valid surrogates instead of `<email:N>` / `<phone:N>`
(`email1@redacted.invalid`, `+10000000001`), so validation steps in flows
accept the redacted input on replay. Default `false`.

***

### dropStartedAt?

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

Defined in: [testing/transcripts/redact.ts:78](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/transcripts/redact.ts#L78)

Drop `startedAt` (the wall-clock start) (default `true`).

***

### rules?

```ts theme={null}
rules?: RedactionRule[];
```

Defined in: [testing/transcripts/redact.ts:80](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/transcripts/redact.ts#L80)

Extra patterns.

***

### allow?

```ts theme={null}
allow?: string[];
```

Defined in: [testing/transcripts/redact.ts:82](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/transcripts/redact.ts#L82)

Values that must never be redacted (e.g. a support phone printed by the bot).

***

### map?

```ts theme={null}
map?: RedactionMap;
```

Defined in: [testing/transcripts/redact.ts:84](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/transcripts/redact.ts#L84)

Reuse placeholders across transcripts. Mutated in place.


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