Raw data collected from Benchmark.record.
Event emitter.
record
is emitted after Benchmark.record finishes all iterations.Refer to BenchmarkEventEmitter.on for the event callback signatures.
Get a list of Measurement based on Benchmark.data.
Find the measurement that meets some criteria. In the case of a tie, the first one found wins.
Criteria by which to select a measurement.
Callback to select a specific field of each measurement for comparison. The default uses the mean plus the margin of error.
the matching measurement, or null if no measurements have been taken
Add a measurement directly to Benchmark.data.
Name of what is being tested. Must not be empty.
Measurement to add to the benchmark data.
Measure the time it takes for a function to execute. In addition to returning the measurement itself, this method also stores the result in Benchmark.data for later use/reporting.
With this overload, since no description is provided, the data will not
be recorded directly. However, a record
event will still be emitted,
allowing any listeners (such as reporters) to act on it.
Function to measure. If it returns a promise,
then it will be await
ed automatically as part of the iteration.
Options to customize the measurement.
Measure the time it takes for a function to execute.
In addition to returning the measurement itself, this method also
stores the result in Benchmark.data for later use/reporting,
and Benchmark.events emits a record
event for any listeners.
Name of what is being tested. This can be a series of names for nested categories. Must not be empty.
Function to measure. If it returns a promise,
then it will be await
ed automatically as part of the iteration.
Options to customize the measurement.
Create a report of all the benchmark results.
Generated using TypeDoc
Aggregator for performance results of various tests.