Interface ICallRecordingOptions

Options for the CallRecorder, derived from IClientOptions.

Hierarchy

  • ICallRecordingOptions

Properties

enabled endpoint? fetchImpl? flushIntervalMs? maxBufferBytes? sampleRate? tracks?

Properties

enabled

enabled: boolean

Whether recording is enabled (mirrors enableCallRecording).

Optional endpoint

endpoint?: string

Endpoint path (relative to host) for recording POSTs.

Optional fetchImpl

fetchImpl?: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
}

Type declaration

    • (input, init?): Promise<Response>

    • Injectable fetch for tests. Defaults to global fetch.

      Parameters

      • input: RequestInfo | URL
      • Optional init: RequestInit

      Returns Promise<Response>

    • (input, init?): Promise<Response>

    • Injectable fetch for tests. Defaults to global fetch.

      Parameters

      • input: RequestInfo
      • Optional init: RequestInit

      Returns Promise<Response>

Optional flushIntervalMs

flushIntervalMs?: number

Interval (ms) between intermediate flushes.

Optional maxBufferBytes

maxBufferBytes?: number

Hard cap (bytes) on the in-memory packet buffer.

Optional sampleRate

sampleRate?: number

Sample rate (Hz) advertised in the recording envelope.

Optional tracks

tracks?: RecordingTrackKind[]

Which tracks to record.

Settings

Member Visibility

Theme

On This Page