Config

Defined in: config.ts:8

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

Port for the proxy server.

---

recordingsDir?

optional recordingsDir?: string

Defined in: config.ts:14

Directory to store recordings, resolved relative to CWD.

---

redaction?

optional redaction?: false | RedactionConfig

Defined in: config.ts:23

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.

---

target?

optional target?: string

Defined in: config.ts:10

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

---

timeout?

optional timeout?: number

Defined in: config.ts:16

Session timeout in milliseconds.

---

websocket?

optional websocket?: WebSocketReplayConfig

Defined in: config.ts:25

WebSocket replay pacing. See WebSocketReplayConfig.