grade
Run benchmark files and gather reports.
Install
Install with npm:
npm i -g grade
Usage
Create a new benchmark file in the benchmark
folder and setup some benchmarks:
var grade = ; // create a new instance of Benchmarkvar Benchmark = gradeBenchmark;var benchmark = ; // create a method that will run before the method under testvar beforeI = 0; { beforeI++;} // create a method that will run after the method under testvar afterI = 0; { afterI++;} // create the actual method under testvar total = 0;var { var i = 0; while i++ < 50000 {} total += beforeI + afterI;}; // add the actual benchmark to the list of benchmarks to runbenchmark; // export the benchmark object so the runner knows what to runmoduleexports = benchmark;
Grade
Grade the benchmarks and return the results
options
{Object}: Options containingfiles
return
{Array} List of results
Benchmark
Create a new instance of Benchmark. Use this to add benchmarks in a file.
options
{Object}: Additional options to pass totimer.execute
Add a new benchmark to the run.
title
{String}: Describe the benchmark.fn
{Function}: The actual function to run.before
{Function}: A function to call before the benchmark is run.after
{Function}: A function to call after the benchmark is run.
Run the registered benchmarks and return timings.
return
{Array} List of timings.
Timer
Execute a benchmark for the specified number of seconds. Seconds is an accumulation of the actual run time of the function under test. This ensures the timing and setup/teardown steps don't interfer with the actual benchmark.
max
{number}: Number of seconds to run the tests for.fn
{Function}: Function under testbeforeFn
{Function}: Function to run before running the testafterFn
{Function}: Function to run after running the testreturn
{Object} Results of the benchmark
Author
Brian Woodward
License
Copyright (c) 2014 Brian Woodward, contributors.
Released under the MIT license
This file was generated by verb-cli on July 25, 2014.