Methods

add(other:RecordableHistogram):Void

Adds the values from other to this histogram.

record(val:EitherType<Float, Dynamic>):Void

Records val in the histogram.

// TODO: allow BigInt when hxnodejs gains a BigInt type (Node accepts numberbigint).

recordDelta():Void

Calculates the amount of time (in nanoseconds) that has passed since the previous call to recordDelta() and records that amount in the histogram.

Inherited Variables

Defined by Histogram

read onlycount:Float

The number of samples recorded by the histogram.

read onlycountBigInt:Dynamic

The number of samples recorded by the histogram (as a BigInt).

// TODO: type as BigInt when hxnodejs provides one.

read onlyexceeds:Float

The number of times the event loop delay exceeded the maximum 1 hour event loop delay threshold.

read onlyexceedsBigInt:Dynamic

The number of times the event loop delay exceeded the maximum 1 hour event loop delay threshold (as a BigInt).

read onlymax:Float

The maximum recorded event loop delay.

read onlymaxBigInt:Dynamic

The maximum recorded event loop delay (as a BigInt).

read onlymean:Float

The mean of the recorded event loop delays.

read onlymin:Float

The minimum recorded event loop delay.

read onlyminBigInt:Dynamic

The minimum recorded event loop delay (as a BigInt).

read onlypercentiles:Map<Float, Float>

Returns a Map object detailing the accumulated percentile distribution.

read onlypercentilesBigInt:Dynamic

Returns a Map object detailing the accumulated percentile distribution (BigInt keys/values).

// TODO: type as Map when hxnodejs provides BigInt.

read onlystddev:Float

The standard deviation of the recorded event loop delays.

Inherited Methods

Defined by Histogram

percentile(percentile:Float):Float

Returns the value at the given percentile.

Parameters:

percentile

A percentile value in the range (0, 100].

percentileBigInt(percentile:Float):Dynamic

Returns the value at the given percentile (as a BigInt).

Parameters:

percentile

A percentile value in the range (0, 100].

reset():Void

Resets the collected histogram data.