TestContextAssert

[<Interface>]
type TestContextAssert =
    abstract member Item (string) : obj array -> unit with get, set
    abstract member fileSnapshot (value: obj, path: string, ?options: AssertSnapshotOptions) : unit
    abstract member snapshot (value: obj, ?options: AssertSnapshotOptions) : unit


Assembly	`Xantham.Fable.Node`
Implements	`Base`

Properties

abstract member Item (string) : obj array -> unit with get, set

Methods

abstract member fileSnapshot (value: obj, path: string, ?options: AssertSnapshotOptions) : unit

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');
});

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

Parameter
`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.

abstract member snapshot (value: obj, ?options: AssertSnapshotOptions) : unit

This function implements assertions for snapshot testing.

test('snapshot test with default serialization', (t) => {
t.assert.snapshot({ value1: 1, value2: 2 });
});

test('snapshot test with custom serialization', (t) => {
t.assert.snapshot({ value3: 3, value4: 4 }, {
serializers: [(value) => JSON.stringify(value)]
});
});

@since v22.3.0

Parameter
`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 the snapshot file. Otherwise, the serialized value is compared to the corresponding value in the existing snapshot file.