Type Alias SuiteLike

Optional Readonlyfilepath

Readonlyname

run

• run(abortSignal?: AbortSignal): Suite.Results | PromiseLike<Suite.Results>

  Runs this SuiteLike.

  Parameters

  • OptionalabortSignal: AbortSignal

  Returns Suite.Results | PromiseLike<Suite.Results>

  The results of running this SuiteLike

  Example

  A synchronous implementation:

  const results = suite.run();
  Copy

  Example

  An asynchronous implementation:

  const results = await suite.run();
  Copy

  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();
  Copy