On this page

snapshot

History

An object whose methods are used to configure default snapshot settings in the current process. It is possible to apply the same configuration to all files by placing common configuration code in a module preloaded with --require or --import.

M

snapshot.setDefaultSnapshotSerializers

History
snapshot.setDefaultSnapshotSerializers(serializers): void
Attributes
serializers:Array
An array of synchronous functions used as the default serializers for snapshot tests.

This function is used to customize the default serialization mechanism used by the test runner. By default, the test runner performs serialization by calling JSON.stringify(value, null, 2) on the provided value. JSON.stringify() does have limitations regarding circular structures and supported data types. If a more robust serialization mechanism is required, this function should be used.

M

snapshot.setResolveSnapshotPath

History
snapshot.setResolveSnapshotPath(fn): void
Attributes
fn:Function
A function used to compute the location of the snapshot file. The function receives the path of the test file as its only argument. If the test is not associated with a file (for example in the REPL), the input is undefined. fn() must return a string specifying the location of the snapshot file.

This function is used to customize the location of the snapshot file used for snapshot testing. By default, the snapshot filename is the same as the entry point filename with a .snapshot file extension.

PreviousassertNextMockFunctionContext