# Config

Canonical: <https://test-proxy-recorder.dev/docs/reference/api/interfaces/config/>
Docs index: <https://test-proxy-recorder.dev/docs/> · All docs as one file: <https://test-proxy-recorder.dev/llms-full.txt>

---

Defined in: [config.ts:8](https://github.com/asmyshlyaev177/test-proxy-recorder/blob/d1bacb3b39a3cf6f7f5a5391a8201868e4629861/packages/test-proxy-recorder/src/config.ts#L8)

Shape of a `test-proxy-recorder.config.{ts,js,mjs}` file. Every field is
optional; any value passed as a CLI flag overrides the matching config value.

## Properties

### port?

> `optional` **port?**: `number`

Defined in: [config.ts:12](https://github.com/asmyshlyaev177/test-proxy-recorder/blob/d1bacb3b39a3cf6f7f5a5391a8201868e4629861/packages/test-proxy-recorder/src/config.ts#L12)

Port for the proxy server.

***

### recordingsDir?

> `optional` **recordingsDir?**: `string`

Defined in: [config.ts:14](https://github.com/asmyshlyaev177/test-proxy-recorder/blob/d1bacb3b39a3cf6f7f5a5391a8201868e4629861/packages/test-proxy-recorder/src/config.ts#L14)

Directory to store recordings, resolved relative to CWD.

***

### redaction?

> `optional` **redaction?**: `false` \| [`RedactionConfig`](/docs/reference/api/interfaces/redactionconfig/)

Defined in: [config.ts:23](https://github.com/asmyshlyaev177/test-proxy-recorder/blob/d1bacb3b39a3cf6f7f5a5391a8201868e4629861/packages/test-proxy-recorder/src/config.ts#L23)

Secret redaction. **On by default** — the Authorization/Cookie/Set-Cookie
headers are stripped from recordings unless you turn it off. Pass a config
object to customize what gets redacted, or `false` to disable it entirely.
See [RedactionConfig](/docs/reference/api/interfaces/redactionconfig/).

***

### target?

> `optional` **target?**: `string`

Defined in: [config.ts:10](https://github.com/asmyshlyaev177/test-proxy-recorder/blob/d1bacb3b39a3cf6f7f5a5391a8201868e4629861/packages/test-proxy-recorder/src/config.ts#L10)

Target API service URL, e.g. `http://localhost:3000`.

***

### timeout?

> `optional` **timeout?**: `number`

Defined in: [config.ts:16](https://github.com/asmyshlyaev177/test-proxy-recorder/blob/d1bacb3b39a3cf6f7f5a5391a8201868e4629861/packages/test-proxy-recorder/src/config.ts#L16)

Session timeout in milliseconds.

***

### websocket?

> `optional` **websocket?**: [`WebSocketReplayConfig`](/docs/reference/api/interfaces/websocketreplayconfig/)

Defined in: [config.ts:25](https://github.com/asmyshlyaev177/test-proxy-recorder/blob/d1bacb3b39a3cf6f7f5a5391a8201868e4629861/packages/test-proxy-recorder/src/config.ts#L25)

WebSocket replay pacing. See [WebSocketReplayConfig](/docs/reference/api/interfaces/websocketreplayconfig/).