TestContext

An object containing assertion methods bound to the test context. The top-level functions from the node:assert module are exposed here for the purpose of creating test plans.

Note: Some of the functions from node:assert contain type assertions. If these are called via the TestContext assert object, then the context parameter in the test's function signature must be explicitly typed (ie. the parameter must have a type annotation), otherwise an error will be raised by the TypeScript compiler:

import { test, type TestContext } from 'node:test';

// The test function's context parameter must have a type annotation.
test('example', (t: TestContext) => {
t.assert.deepStrictEqual(actual, expected);
});

// Omitting the type annotation will result in a compilation error.
test('example', t => {
t.assert.deepStrictEqual(actual, expected); // Error: 't' needs an explicit type annotation.
});

@since v22.2.0, v20.15.0

The absolute path of the test file that created the current test. If a test file imports additional modules that generate tests, the imported tests will return the path of the root test file.

@since v22.6.0

The name of the test and each of its ancestors, separated by >.

@since v22.3.0

Each test provides its own MockTracker instance.

The name of the test.

@since v18.8.0, v16.18.0

test('top level test', async (t) => {
await fetch('some/uri', { signal: t.signal });
});

@since v18.7.0, v16.17.0

This function is used to create subtests under the current test. This function behaves in the same fashion as the top level test function.

@since v18.0.0

Returns. A {@link Promise} resolved with undefined once the test completes.