Options
All
  • Public
  • Public/Protected
  • All
Menu

A suite of related tests that can be run together.

Hierarchy

  • SuiteLike

Implemented by

Index

Properties

Methods

Properties

filepath?: string

The filepath to this SuiteLike, when available.

name: string

The name of this SuiteLike.

Methods

  • Runs this SuiteLike.

    example

    A synchronous implementation:

    const results = suite.run();
    
    example

    An asynchronous implementation:

    const results = await suite.run();
    
    example

    Using an AbortSignal to cancel the suite:

    const ac = new AbortController();
    const signal = ac.signal;

    suite
    .run(signal)
    .then(console.log)
    .catch(error => {
    if (error.name === 'AbortError') {
    console.log('The suite was aborted');
    }
    });

    ac.abort();

    Parameters

    • Optional abortSignal: AbortSignal

    Returns Suite.Results | PromiseLike<Suite.Results>

    The results of running this SuiteLike

Generated using TypeDoc