planning-center-monorepo v1.0.0

planning-center-monorepo / planning-center-people-ts/src / RecordingConfig

Interface: RecordingConfig

Defined in: packages/planning-center-people-ts/src/testing/types.ts:108 

Properties

recordPath

recordPath: string

Defined in: packages/planning-center-people-ts/src/testing/types.ts:110 

Path to save recorded requests/responses

mode

mode: "record" | "replay" | "auto"

Defined in: packages/planning-center-people-ts/src/testing/types.ts:112 

Whether to record new requests or replay existing ones

filter()?

optional filter: (endpoint, method) => boolean

Defined in: packages/planning-center-people-ts/src/testing/types.ts:114 

Filter which requests to record

Parameters

endpoint

string

method

string

Returns

boolean

transform()?

optional transform: (response) => any

Defined in: packages/planning-center-people-ts/src/testing/types.ts:116 

Transform recorded responses

Parameters

response

any

Returns

any

getConfig()?

optional getConfig: () => object

Defined in: packages/planning-center-people-ts/src/testing/types.ts:118 

Optional getConfig for debug logging (e.g. when recording client has debug)

Returns

object

debug?

optional debug: boolean | PcoDebugOptions