TooFast - v3.0.3
    Preparing search index...

    Interface MeasureOptions

    interface MeasureOptions {
        afterBatch?: HookCallback;
        afterIteration?: HookCallback;
        afterWarmup?: HookCallback;
        batchIntermissionTimeout?: number;
        batchIterationCount?: number;
        batchTimeout?: number;
        beforeBatch?: HookCallback;
        beforeIteration?: HookCallback;
        measureTimeout?: number;
        targetRme?: number;
        warmupIterationCount?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    afterBatch? afterIteration? afterWarmup? batchIntermissionTimeout? batchIterationCount? batchTimeout? beforeBatch? beforeIteration? measureTimeout? targetRme? warmupIterationCount?

    Properties

    afterBatch?: HookCallback
    afterIteration?: HookCallback
    afterWarmup?: HookCallback
    batchIntermissionTimeout?: number

    The delay between batched measurements. VM is expected to run garbage collector during this delay.

    200
    batchIterationCount?: number

    The maximum number of iterations in a batch.

    Infinity
    batchTimeout?: number

    The maximum duration of batched measurements.

    1_000
    beforeBatch?: HookCallback
    beforeIteration?: HookCallback
    measureTimeout?: number

    Maximum measure duration. Doesn't include the duration of warmup iterations.

    10_000
    targetRme?: number

    The maximum relative margin of error that must be reached for each measurement [0, 1].

    0.002
    warmupIterationCount?: number

    The maximum number of warmup iterations that are run before each measurement.

    1

    Settings

    Member Visibility

    On This Page

    Properties