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

Class: RequestRecorder

Defined in: packages/planning-center-people-ts/src/testing/recorder.ts:10

Constructors

Constructor

new RequestRecorder(config): RequestRecorder

Defined in: packages/planning-center-people-ts/src/testing/recorder.ts:15

Parameters

config

RecordingConfig

Returns

RequestRecorder

Methods

startRecording()

startRecording(): void

Defined in: packages/planning-center-people-ts/src/testing/recorder.ts:23

Start recording requests

Returns

void

stopRecording()

stopRecording(): void

Defined in: packages/planning-center-people-ts/src/testing/recorder.ts:31

Stop recording and save to file

Returns

void

recordRequest()

recordRequest(endpoint, method, params, data, response): void

Defined in: packages/planning-center-people-ts/src/testing/recorder.ts:39

Record a request/response pair

Parameters

endpoint

string

method

string

params

Record<string, any>

data

any

response

any

Returns

void

replayRequest()

replayRequest(endpoint, method, params, data): any

Defined in: packages/planning-center-people-ts/src/testing/recorder.ts:68

Replay a recorded request

Parameters

endpoint

string

method

string

params

Record<string, any>

data

any

Returns

any

shouldRecord()

shouldRecord(endpoint, method): boolean

Defined in: packages/planning-center-people-ts/src/testing/recorder.ts:90

Check if we should record or replay

Parameters

endpoint

string

method

string

Returns

boolean

getRequests()

getRequests(): RecordedRequest[]

Defined in: packages/planning-center-people-ts/src/testing/recorder.ts:102

Get all recorded requests

Returns

RecordedRequest[]

clearRequests()

clearRequests(): void

Defined in: packages/planning-center-people-ts/src/testing/recorder.ts:109

Clear recorded requests

Returns

void