Class Suite

A collection of (Test:class)s that are different implementations of the same thing (ex. different ways of sorting an array).

Example

import { Suite } from '@jonahsnider/benchmark';

const suite = new Suite('concatenation', { warmup: { durationMs: 10_000 }, run: { durationMs: 10_000 } })
  .addTest('+', () => 'a' + 'b')
  .addTest('templates', () => `${'a'}${'b'}`)
  .addTest('.concat()', () => 'a'.concat('b'));

const results = await suite.run();

console.log(results);

Hierarchy

  • Suite

Implements

Constructors

constructor

Properties

name options tests

Accessors

filepath

Methods

addTest run

Constructors

constructor

  • Creates a new (Suite:class).

    Example

    import { Suite } from '@jonahsnider/benchmark';

    const suite = new Suite('concatenation', { warmup: { durationMs: 10_000 }, run: { durationMs: 10_000 } });

    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
    });

    Parameters

    Returns Suite

Properties

Readonly name

name: string

The name of the (Suite:class)

Readonly options

options: Options

Options for running this (Suite:class) and its warmup.

tests

tests: ReadonlyMap<string, Test<unknown>> = ...

The tests in this (Suite:class).

Accessors

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

Methods

addTest

  • Adds a test to this (Suite:class).

    Example

    const test = new Test(() => 'a' + 'b');

    suite.addTest('+', test);

    Returns

    this

    Parameters

    • testName: string

      The name of the test

    • test: Test<unknown>

      The test to add

    Returns Suite

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

    Example

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

    Returns

    this

    Parameters

    • testName: string

      The name of the test

    • fn: (() => unknown)

      The function to run

        • (): unknown

        • Returns unknown

    Returns Suite

run

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

    Example

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

    Returns

    The results of running this (Suite:class)

    Parameters

    • Optional abortSignal: AbortSignal

    Returns Promise<Suite.Results>

Settings

Member Visibility

Theme

Generated using TypeDoc