Class Suite

constructor

• new Suite(name: string, options: Options): Suite

  Creates a new (Suite:class).

  Parameters

  • name: string

    The name of the (Suite:class)
  • options: Options

    Options for the (Suite:class)

  Returns Suite

  Example

  import { Suite } from '@jonahsnider/benchmark';
  
  const suite = new Suite('concatenation', { warmup: { durationMs: 10_000 }, run: { durationMs: 10_000 } });
  Copy

  Example

  Suites that specify a filepath can be run in a separate thread in a (Benchmark:class).

  import { Suite } from '@jonahsnider/benchmark';
  
  const suite = new Suite('concatenation', {
    warmup: { durationMs: 10_000 },
    run: { durationMs: 10_000 },
    filepath: import.meta.url
  });
  Copy

Readonlyname

Readonlyoptions

tests

filepath

• get filepath(): undefined | string

  This (Suite:class)'s filepath, if it was provided. Used for running the (Suite:class) in a separate thread.

  Returns undefined | string

addTest

• addTest(testName: string, test: Test): this

  Adds a test to this (Suite:class).

  Parameters

  • testName: string

    The name of the test
  • test: Test

    The test to add

  Returns this

  this

  Example

  const test = new Test(() => 'a' + 'b');
  
  suite.addTest('+', test);
  Copy

• addTest(testName: string, fn: () => unknown): this

  Creates and adds a test to this (Suite:class).

  Parameters

  • testName: string

    The name of the test
  • fn: () => unknown

    The function to run

  Returns this

  this

  Example

  suite.addTest('+', () => 'a' + 'b');
  Copy

run

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

  Runs this (Suite:class) using (Suite:class).options.

  Parameters

  • OptionalabortSignal: AbortSignal

  Returns Promise<Suite.Results>

  The results of running this (Suite:class)

  Example

  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