Skip to main content

function describe

Overload 1

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

Alias for suite.

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

Parameters #

#name: string
optional
#options: TestOptions
optional
#fn: SuiteFn
optional

Return Type #

Promise<void>

Overload 2

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

Parameters #

#name: string
optional
#fn: SuiteFn
optional

Return Type #

Promise<void>

Overload 3

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

Parameters #

#options: TestOptions
optional
#fn: SuiteFn
optional

Return Type #

Promise<void>

Overload 4

#describe(fn?: SuiteFn): Promise<void>

Parameters #

#fn: SuiteFn
optional

Return Type #

Promise<void>

namespace describe

Functions #

f
describe.only

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

    f
    describe.skip

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

      f
      describe.todo

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

        Did you find what you needed?

        Privacy policy