Class NockRecorder

Class providing the implementation of the t.nock.snapshot() functionality

Index

Constructors

Accessors

paused recording

Methods

finish load pause resume start writeSnapshot

Constructors

constructor

new NockRecorder(test, caller): NockRecorder
Parameters
- test: TestBase
- caller: Function | ((...a: any[]) => any)
Returns NockRecorder
- Defined in src/nock/src/recorder.ts:66

Accessors

paused

get paused(): boolean
Returns boolean
- Defined in src/nock/src/recorder.ts:108

recording

get recording(): boolean
Returns boolean
- Defined in src/nock/src/recorder.ts:112

Methods

finish

finish(): void
Finish the recording and write state

Returns void
- Defined in src/nock/src/recorder.ts:192

load

load(name, options?): Scope[]
Attempt to load the recorded nock snapshot json file.

If snapshots are being written, then make actual requests and save the recorded values to the snapshot json file.

Otherwise, load http request results from the snapshot json.
Parameters
- name: string
- options: NockRecorderLoadOptions = {}
Returns Scope[]
- Defined in src/nock/src/recorder.ts:124

pause

pause(): void
pause the recording

Returns void
- Defined in src/nock/src/recorder.ts:203

resume

resume(): void
resume recording

Returns void
- Defined in src/nock/src/recorder.ts:224

start

start(name, options?): void
Start recording http requests
Parameters
- name: string
- options: NockRecorderOptionsMaybe = {}
Returns void
- Defined in src/nock/src/recorder.ts:162

writeSnapshot

writeSnapshot(): void
Write the recorded snapshot json to the appropriate file

Returns void
- Defined in src/nock/src/recorder.ts:240