math-helper-functions - npm Package Compare versions

Comparing version 3.1.2 to 3.2.0

dist/index.d.ts

@@ -221,2 +221,12 @@ /**
 
-export { calcBuckets, calcDiff, calcDistribution, calcDistributionAsArray, calcDistributionWithSeries, calcDomain, calcHistogram, calcMax, calcMean, calcMedian, calcMin, calcPercent, calcQuartiles, calcStdDeviation, calcSum, calcVariance, calcWeightedMean, calcWeightedMedian, getMinMaxFromBucket, ruleOfThree };
+/**
+ * Gets the percentile of an array of values
+ *
+ * @param {(number|null)[]} array Array to find percentile of
+ * @param {number} percentile Amount between 0 and 1
+ *
+ * @returns {number|undefined} Percentile
+ */
+declare function getPercentile(array: (number | null)[], percentile: number): number | undefined;
+
+export { calcBuckets, calcDiff, calcDistribution, calcDistributionAsArray, calcDistributionWithSeries, calcDomain, calcHistogram, calcMax, calcMean, calcMedian, calcMin, calcPercent, calcQuartiles, calcStdDeviation, calcSum, calcVariance, calcWeightedMean, calcWeightedMedian, getMinMaxFromBucket, getPercentile, ruleOfThree };

dist/index.js

@@ -69,2 +69,3 @@ "use strict";
   getMinMaxFromBucket: () => getMinMaxFromBucket,
+  getPercentile: () => getPercentile,
   ruleOfThree: () => ruleOfThree
@@ -314,2 +315,11 @@ });
 }
+
+// src/modules/percentiles.ts
+var import_d3_array5 = require("d3-array");
+function getPercentile(array, percentile) {
+  if (percentile > 1 || percentile < 0) {
+    throw new Error("percentile must be a number between 0 and 1");
+  }
+  return (0, import_d3_array5.quantile)(array, percentile);
+}
 // Annotate the CommonJS export names for ESM import in node:
@@ -336,3 +346,4 @@ 0 && (module.exports = {
   getMinMaxFromBucket,
+  getPercentile,
   ruleOfThree
 });

package.json

 {
   "name": "math-helper-functions",
-  "version": "3.1.2",
+  "version": "3.2.0",
   "description": "Helper with misc. math functions such as sums, averages, max, min, etc",
@@ -5,0 +5,0 @@ "main": "./dist/index.js",

README.md

@@ -61,2 +61,3 @@ # math-helper-functions
 - [getMinMaxFromBucket](modules.md#getminmaxfrombucket)
+- [getPercentile](modules.md#getpercentile)
 - [ruleOfThree](modules.md#ruleofthree)
@@ -593,2 +594,27 @@
 
+### getPercentile
+
+▸ **getPercentile**(`array`, `percentile`): `number` \| `undefined`
+
+Gets the percentile of an array of values
+
+#### Parameters
+
+| Name         | Type                   | Description                 |
+| :----------- | :--------------------- | :-------------------------- |
+| `array`      | (`null` \| `number`)[] | Array to find percentile of |
+| `percentile` | `number`               | Amount between 0 and 1      |
+
+#### Returns
+
+`number` \| `undefined`
+
+Percentile
+
+#### Defined in
+
+[modules/percentiles.ts:11](https://github.com/alrico88/math-helper-functions/blob/master/src/modules/percentiles.ts#L11)
+
+---
+
 ### ruleOfThree
@@ -595,0 +621,0 @@

src/index.ts

@@ -18,1 +18,2 @@ export {
 export { ruleOfThree, calcPercent } from './modules/percentages';
+export { getPercentile } from './modules/percentiles';

src/modules/arrays.ts

@@ -15,5 +15,5 @@ import dlv from 'dlv';
   if (isNonEmptyString(property)) {
-    return array.map((d) => dlv(d, property));
+    return array.map((d) => dlv(d as object, property));
   }
   return array;
 }

No alert changes

Improved metrics

Total package byte prevSize

66543

increased by3.97%

Number of package files

15

increased by7.14%

Lines of code

1363

increased by3.34%

Number of lines in readme file

643

increased by4.21%

No dependency changes