fileSnapshot
abstract fun fileSnapshot(value: Any?, path: String, options: AssertSnapshotOptions = definedExternally)(source)
This function serializes value and writes it to the file specified by path.
test('snapshot test with default serialization', (t) => {
t.assert.fileSnapshot({ value1: 1, value2: 2 }, './snapshots/snapshot.json');
});Content copied to clipboard
This function differs from context.assert.snapshot() in the following ways:
The snapshot file path is explicitly provided by the user.
Each snapshot file is limited to a single snapshot value.
No additional escaping is performed by the test runner.
These differences allow snapshot files to better support features such as syntax highlighting.
Since
v22.14.0
Parameters
value
A value to serialize to a string. If Node.js was started with the --test-update-snapshots flag, the serialized value is written to path. Otherwise, the serialized value is compared to the contents of the existing snapshot file.
path
The file where the serialized value is written.
options
Optional configuration options.