pete/lib/createReport

(require("pete/lib/createReport"))(options, state) → {module:pete/lib/createReport~Report}

Description:

  • Creates report object from runner's options and state.

Source:
Parameters:
Name Type Description
options module:pete/lib/RunOptions
state module:pete/lib/RunState
Returns:
Type
module:pete/lib/createReport~Report

Type Definitions

Report

Description:

  • Information about test run.

    percentiles.p1 to percentiles.p100 are optional, depending on options.percentiles passed to test function.

Source:
Properties:
Name Type Attributes Description
id string

Unique identifier of place from which test function was called
name string

Name of the test
mode string

For example: "skip", "todo", "warmup" or "regular"
type string

Type of runner used to call target function
limitCPUTime NanoTime

Maximum time target function can run
limitRealTime NanoTime

Maximum total real time test can run
limitSamples number

Maximum number of times target function should be run
args Array.<string>

Arguments passed to target function
exitOnError boolean

Should test be cancelled after error
started NanoTime
finished NanoTime
totalCPUTime NanoTime

Sum of time it took to run target function
totalRealTime NanoTime

Time it took to run whole test
samples number

Number of times target function was run
min number

see external:Histogram
max number

see external:Histogram
mean number

see external:Histogram
stddev number

see external:Histogram
percentiles object
Properties
Name Type Attributes Description
p1 number <optional>

If test options contained percentile 1, p1 will contain its value
p100 number <optional>

If test options contained percentile 100, p100 will contain its value
error Error <optional>

If there was any, while running the test

Information about test run.

percentiles.p1 to percentiles.p100 are optional, depending on options.percentiles passed to test function.

Type:
  • object