Skip to content

Latest commit

 

History

History
491 lines (139 loc) · 4.27 KB

docs.md

File metadata and controls

491 lines (139 loc) · 4.27 KB
Raw

src/index.js

flow(funcs)

Parameters
Name Type Description
funcs Array.<Function> functions to flow left to right  
Returns
  • Function passes args through the functions, bound to this

module.exports()

Returns
  • Void

formatNumber(number)

Converts a number to a more readable comma-separated string representation.

Parameters
Name Type Description
number number The number to convert.  
Returns
  • string The more readable string representation.

constructor(dir)

Parameters
Name Type Description
dir string directory for the file with the record  
Returns
  • Void

cycle(event) private method

Parameters
Name Type Description
event Benchmark.Event  
Returns
  • Record @chainable

filename()

Parameters
Name Type Description
filename='./results.json' String Optional
Returns
  • Record @chainable

load([force=false])

Parameters
Name Type Description
force=false Boolean force reload Optional
Returns
  • Record @chainable

save()

Returns
  • Record @chainable

getDiv(max)

Parameters
Name Type Description
max number  
Returns
  • number

trend()

Returns
  • Object.<points, max, min> trend graph data

avgs(prop)

Parameters
Name Type Description
prop string map to this property to average with that data  
Returns
  • Averages averages

avg(data)

Parameters
Name Type Description
data Array.<number>  
Returns
  • number average

fastest()

Returns
  • Array.<string> test case name

echoAvgs()

Returns
  • Record @chainable

echoFastest()

Returns
  • Record @chainable

echoTrend()

Returns
  • Record @chainable

suite(dir[, auto=false])

Parameters
Name Type Description
dir string  
auto=false Boolean Optional
Returns
  • Object {suite, record}

suite([auto=false])

Parameters
Name Type Description
auto=false Boolean Optional
Returns
  • Benchmark.Suite

setup([auto=true])

Parameters
Name Type Description
auto=true Boolean automatically sets up echoing and saving Optional
Returns
  • Record @chainable

add(name, cb)

Parameters
Name Type Description
name string  
cb Function  
Returns
  • Record @chainable

run(async)

Parameters
Name Type Description
async boolean  
Returns
  • Record @chainable

runAsync(async)

Parameters
Name Type Description
async boolean  
Returns
  • Record @chainable

runTimes([times=10])

Parameters
Name Type Description
times=10 Number Optional
Returns
  • Record @chainable

Documentation generated with doxdox.