DocsReferenceGuidesBlog
Discord logo
Discord
GitHub logo
Bun

namespace

test.describe

function describe(
name?: string,
options?: TestOptions,
fn?: SuiteFn
): Promise<void>;

Alias for suite.

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

function describe(
name?: string,
fn?: SuiteFn
): Promise<void>;

Alias for suite.

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

function describe(
options?: TestOptions,
fn?: SuiteFn
): Promise<void>;

Alias for suite.

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

function describe(
fn?: SuiteFn
): Promise<void>;

Alias for suite.

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

namespace describe

  • function only(
    name?: string,
    options?: TestOptions,
    fn?: SuiteFn
    ): Promise<void>;

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

    function only(
    name?: string,
    fn?: SuiteFn
    ): Promise<void>;

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

    function only(
    options?: TestOptions,
    fn?: SuiteFn
    ): Promise<void>;

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

    function only(
    fn?: SuiteFn
    ): Promise<void>;

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

  • function skip(
    name?: string,
    options?: TestOptions,
    fn?: SuiteFn
    ): Promise<void>;

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

    function skip(
    name?: string,
    fn?: SuiteFn
    ): Promise<void>;

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

    function skip(
    options?: TestOptions,
    fn?: SuiteFn
    ): Promise<void>;

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

    function skip(
    fn?: SuiteFn
    ): Promise<void>;

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

  • function todo(
    name?: string,
    options?: TestOptions,
    fn?: SuiteFn
    ): Promise<void>;

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

    function todo(
    name?: string,
    fn?: SuiteFn
    ): Promise<void>;

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

    function todo(
    options?: TestOptions,
    fn?: SuiteFn
    ): Promise<void>;

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

    function todo(
    fn?: SuiteFn
    ): Promise<void>;

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