Function suite

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

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

    Parameters

    • Optionalname: string

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

    • Optionaloptions: TestOptions

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

    • Optionalfn: SuiteFn

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

    Returns Promise<void>

    Immediately fulfilled with undefined.

    Since

    v20.13.0

  • suite(name?: string, fn?: SuiteFn): Promise<void>

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

    Parameters

    • Optionalname: string

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

    • Optionalfn: SuiteFn

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

    Returns Promise<void>

    Immediately fulfilled with undefined.

    Since

    v20.13.0

  • suite(options?: TestOptions, fn?: SuiteFn): Promise<void>

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

    Parameters

    • Optionaloptions: TestOptions

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

    • Optionalfn: SuiteFn

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

    Returns Promise<void>

    Immediately fulfilled with undefined.

    Since

    v20.13.0

  • suite(fn?: SuiteFn): Promise<void>

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

    Parameters

    • Optionalfn: SuiteFn

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

    Returns Promise<void>

    Immediately fulfilled with undefined.

    Since

    v20.13.0

Settings

Member Visibility