namespace suite | Node.js node:test module

namespace suite | Node.js node:test module | BunBuild Docs Reference Guides Blog Discord/node:test/default/suite Fsuite FexpectFailure Fonly Fskip Ftodo

Search the reference...

Build Docs Reference Guides Blog Discord/node:test/default/suite Fsuite FexpectFailure Fonly Fskip Ftodo

namespace

test.default.suitefunction suite(name?: string,options?: TestOptions,fn?: SuiteFn): Promisevoid>;

The suite() function is imported from the node:test module.

@param name

The name of the suite, which is displayed when reporting test results. Defaults to the name property of fn, or '' if fn does not have a name.

@param options

Configuration options for the suite. This supports the same options as test.

@param fn

The suite function declaring nested tests and suites. The first argument to this function is a SuiteContext object.

@returns

Immediately fulfilled with undefined.

function suite(name?: string,fn?: SuiteFn): Promisevoid>;

The suite() function is imported from the node:test module.

@param name

The name of the suite, which is displayed when reporting test results. Defaults to the name property of fn, or '' if fn does not have a name.

@param fn

The suite function declaring nested tests and suites. The first argument to this function is a SuiteContext object.

@returns

Immediately fulfilled with undefined.

function suite(options?: TestOptions,fn?: SuiteFn): Promisevoid>;

The suite() function is imported from the node:test module.

@param options

Configuration options for the suite. This supports the same options as test.

@param fn

The suite function declaring nested tests and suites. The first argument to this function is a SuiteContext object.

@returns

Immediately fulfilled with undefined.

function suite(fn?: SuiteFn): Promisevoid>;

The suite() function is imported from the node:test module.

@param fn

The suite function declaring nested tests and suites. The first argument to this function is a SuiteContext object.

@returns

Immediately fulfilled with undefined.

namespace suitefunction expectFailure(name?: string,options?: TestOptions,fn?: SuiteFn): Promisevoid>;

This flips the pass/fail reporting for a specific test or suite: a flagged test case must throw in order to pass, and a flagged test case that does not throw fails.

function expectFailure(name?: string,fn?: SuiteFn): Promisevoid>;

This flips the pass/fail reporting for a specific test or suite: a flagged test case must throw in order to pass, and a flagged test case that does not throw fails.

function expectFailure(options?: TestOptions,fn?: SuiteFn): Promisevoid>;

This flips the pass/fail reporting for a specific test or suite: a flagged test case must throw in order to pass, and a flagged test case that does not throw fails.

function expectFailure(fn?: SuiteFn): Promisevoid>;

This flips the pass/fail reporting for a specific test or suite: a flagged test case must throw in order to pass, and a flagged test case that does not throw fails.

function only(name?: string,options?: TestOptions,fn?: SuiteFn): Promisevoid>;

Shorthand for marking a suite as only. This is the same as calling suite with options.only set to true.

function only(name?: string,fn?: SuiteFn): Promisevoid>;

Shorthand for marking a suite as only. This is the same as calling suite with options.only set to true.

function only(options?: TestOptions,fn?: SuiteFn): Promisevoid>;

Shorthand for marking a suite as only. This is the same as calling suite with options.only set to true.

function only(fn?: SuiteFn): Promisevoid>;

Shorthand for marking a suite as only. This is the same as calling suite with options.only set to true.

function skip(name?: string,options?: TestOptions,fn?: SuiteFn): Promisevoid>;

Shorthand for skipping a suite. This is the same as calling suite with options.skip set to true.

function skip(name?: string,fn?: SuiteFn): Promisevoid>;

Shorthand for skipping a suite. This is the same as calling suite with options.skip set to true.

function skip(options?: TestOptions,fn?: SuiteFn): Promisevoid>;

Shorthand for skipping a suite. This is the same as calling suite with options.skip set to true.

function skip(fn?: SuiteFn): Promisevoid>;

Shorthand for skipping a suite. This is the same as calling suite with options.skip set to true.

function todo(name?: string,options?: TestOptions,fn?: SuiteFn): Promisevoid>;

Shorthand for marking a suite as TODO. This is the same as calling suite with options.todo set to true.

function todo(name?: string,fn?: SuiteFn): Promisevoid>;

Shorthand for marking a suite as TODO. This is the same as calling suite with options.todo set to true.

function todo(options?: TestOptions,fn?: SuiteFn): Promisevoid>;

Shorthand for marking a suite as TODO. This is the same as calling suite with options.todo set to true.

function todo(fn?: SuiteFn): Promisevoid>;

Shorthand for marking a suite as TODO. This is the same as calling suite with options.todo set to true.

Resources

Reference Docs Guides Discord Merch Store GitHub Blog

Toolkit

Runtime Package manager Test runner Bundler Package runner

Project

Bun 1.0 Bun 1.1 Bun 1.2 Bun 1.3 Roadmap Contributing License

Baked with ❤️ in San Francisco

We're hiring →

namespace suite | Node.js node:test module | Bun

namespace suite | Node.js node:test module | Bun,AI智能索引,全网链接索引,智能导航,网页索引