interface TestContextAssert | Node.js node:test module | Bun

interface TestContextAssert | Node.js node:test module | BunBuildDocsReferenceGuidesBlogDiscord/node:test/default/TestContextAssertPdeepEqualPdeepStrictEqualPdoesNotMatchPdoesNotRejectPdoesNotThrowPequalPfailMfileSnapshotPifErrorPmatchPnotDeepEqualPnotDeepStrictEqualPnotEqualPnotStrictEqualPokPpartialDeepStrictEqualPrejectsMsnapshotPstrictEqualPthrows

Search the reference...

/

BuildDocsReferenceGuidesBlogDiscord/node:test/default/TestContextAssertPdeepEqualPdeepStrictEqualPdoesNotMatchPdoesNotRejectPdoesNotThrowPequalPfailMfileSnapshotPifErrorPmatchPnotDeepEqualPnotDeepStrictEqualPnotEqualPnotStrictEqualPokPpartialDeepStrictEqualPrejectsMsnapshotPstrictEqualPthrows

interface

test.default.TestContextAssertinterface TestContextAssertdeepEqual: (actual: unknown, expected: unknown, message?: string | Error) => voiddeepStrictEqual: (actual: unknown, expected: T, message?: string | Error) => asserts actual is TdoesNotMatch: (value: string, regExp: RegExp, message?: string | Error) => voiddoesNotReject: {(block: Promiseunknown> | () => Promiseunknown>, message?: string | Error) => Promisevoid>; (block: Promiseunknown> | () => Promiseunknown>, error: AssertPredicate, message?: string | Error) => Promisevoid>}doesNotThrow: {(block: () => unknown, message?: string | Error) => void; (block: () => unknown, error: AssertPredicate, message?: string | Error) => void}equal: (actual: unknown, expected: unknown, message?: string | Error) => voidfail: (message?: string | Error) => neverifError: (value: unknown) => asserts value is undefined | nullmatch: (value: string, regExp: RegExp, message?: string | Error) => voidnotDeepEqual: (actual: unknown, expected: unknown, message?: string | Error) => voidnotDeepStrictEqual: (actual: unknown, expected: unknown, message?: string | Error) => voidnotEqual: (actual: unknown, expected: unknown, message?: string | Error) => voidnotStrictEqual: (actual: unknown, expected: unknown, message?: string | Error) => voidok: (value: unknown, message?: string | Error) => asserts valuepartialDeepStrictEqual: (actual: unknown, expected: unknown, message?: string | Error) => voidrejects: {(block: Promiseunknown> | () => Promiseunknown>, message?: string | Error) => Promisevoid>; (block: Promiseunknown> | () => Promiseunknown>, error: AssertPredicate, message?: string | Error) => Promisevoid>}strictEqual: (actual: unknown, expected: T, message?: string | Error) => asserts actual is Tthrows: {(block: () => unknown, message?: string | Error) => void; (block: () => unknown, error: AssertPredicate, message?: string | Error) => void} { 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." data-algolia-static="false" data-algolia-merged="false" data-type="Method">fileSnapshot(value: any,path: string,options?: AssertSnapshotOptions): void;

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.

@param 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.

@param path

The file where the serialized value is written.

@param options

Optional configuration options.

{ 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)] }); }); ```" data-algolia-static="false" data-algolia-merged="false" data-type="Method">snapshot(value: any,options?: AssertSnapshotOptions): void;

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

@param 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.

Resources

ReferenceDocsGuidesDiscordMerch StoreGitHubBlog 

Toolkit

RuntimePackage managerTest runnerBundlerPackage runner

Project

Bun 1.0Bun 1.1Bun 1.2Bun 1.3RoadmapContributingLicense

Baked with ❤️ in San Francisco

We're hiring →