On this page

    M

    createRunner

    History
    createRunner(options?): Object
    Attributes
    options:Object
    yieldBetweenSamples?:boolean
    Schedule an event loop turn between sample callbacks. Disabling this also prevents timer-based abort signals from firing between synchronous callbacks. Benchmark timeouts continue to be checked against a monotonic deadline. Default: true.
    Returns:Object
    An isolated benchmark runner with bound after, afterEach, before, beforeEach, bench, describe, run, and suite functions.

    Creates an explicitly started benchmark runner. Declarations made through one runner do not interact with declarations made through another runner or through the module-level functions. Call the returned run() function to start the runner and obtain its BenchmarksStream.

    Each runner can be started once. Its run() function accepts the same options as the module-level run(). run({ yieldBetweenSamples }) overrides the value passed to createRunner().