From 93d59697c614a4b567fee63d76201f151a6ecef8 Mon Sep 17 00:00:00 2001 From: Stephen Kubovic Date: Mon, 12 Apr 2021 11:28:13 -0400 Subject: [PATCH] fix(docs): Fix documentation for default value of rollingPercentilesEnabled (#563) rollingPercentilesEnabled option is documented as defaulting to false, but rolling percentiles are enabled by default. --- lib/circuit.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/circuit.js b/lib/circuit.js index 763dfa1b..bbbf3fb3 100644 --- a/lib/circuit.js +++ b/lib/circuit.js @@ -52,7 +52,7 @@ Please use options.errorThresholdPercentage`; * @param {boolean} options.rollingPercentilesEnabled This property indicates * whether execution latencies should be tracked and calculated as percentiles. * If they are disabled, all summary statistics (mean, percentiles) are - * returned as -1. Default: false + * returned as -1. Default: true * @param {Number} options.capacity the number of concurrent requests allowed. * If the number currently executing function calls is equal to * options.capacity, further calls to `fire()` are rejected until at least one