@8ms/helpers 1.5.1 → 1.5.3

package/number/format.d.ts

@@ -0,0 +1,11 @@
+type Format = {
+    compact?: boolean;
+    input: any;
+    minDp?: number;
+    maxDp?: number;
+};
+/**
+ * Take a given number and format it.
+ */
+declare const format: (props: Format) => string;
+export default format;

package/number/format.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getNumber_1 = __importDefault(require("./getNumber"));
+/**
+ * Take a given number and format it.
+ */
+const format = (props) => {
+    const inputValue = (0, getNumber_1.default)({
+        input: props.input,
+    });
+    const options = {
+        minimumFractionDigits: undefined !== props?.minDp ? props?.minDp : 0,
+        maximumFractionDigits: undefined !== props?.maxDp ? props?.maxDp : 2,
+        notation: true === props?.compact ? "compact" : "standard",
+    };
+    // @ts-ignore
+    return Intl.NumberFormat('en-GB', options)
+        .format(inputValue);
+};
+exports.default = format;

package/number/getDivide.js

@@ -8,8 +8,12 @@ const getNumber_1 = __importDefault(require("./getNumber"));
  * Shorthand function to divide number, but fallback if the divisor is 0.
  */
 const getDivide = ({ defaultValue = 0, divisor, numerator }) => {
-    const numeratorInt = (0, getNumber_1.default)({ input: numerator });
-    const divisorInt = (0, getNumber_1.default)({ input: divisor });
+    const numeratorInt = (0, getNumber_1.default)({
+        input: numerator
+    });
+    const divisorInt = (0, getNumber_1.default)({
+        input: divisor
+    });
     if (0 === divisorInt) {
         return defaultValue;
     }

package/number/getPercentIncrease.d.ts

@@ -1,9 +1,10 @@
-/**
- * Formula to work out the percentage increase/decrease.
- */
-declare const getPercentageIncrease: ({ comparison, current, defaultValue }: {
+type GetPercentageIncrease = {
     comparison: any;
     current: any;
     defaultValue: number;
-}) => number;
+};
+/**
+ * Formula to work out the percentage increase/decrease.
+ */
+declare const getPercentageIncrease: ({ comparison, current, defaultValue }: GetPercentageIncrease) => number;
 export default getPercentageIncrease;

package/number/getPercentIncrease.js

@@ -8,8 +8,12 @@ const getNumber_1 = __importDefault(require("./getNumber"));
  * Formula to work out the percentage increase/decrease.
  */
 const getPercentageIncrease = ({ comparison, current, defaultValue }) => {
-    const currentValue = (0, getNumber_1.default)({ input: current });
-    const comparisonValue = (0, getNumber_1.default)({ input: comparison });
+    const currentValue = (0, getNumber_1.default)({
+        input: current
+    });
+    const comparisonValue = (0, getNumber_1.default)({
+        input: comparison
+    });
     if (0 === comparisonValue) {
         return defaultValue;
     }

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name":            "@8ms/helpers",
 	"license":         "UNLICENSED",
-	"version":         "1.5.1",
+	"version":         "1.5.3",
 	"repository":      {
 		"type": "git",
 		"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
@@ -38,7 +38,6 @@
 		"babel-jest":                    "29.6.3",
 		"jest":                          "29.6.3",
 		"node-fetch":                    "3.3.2",
-		"numbro":                        "2.3.6",
 		"timezone-mock":                 "1.3.6",
 		"ts-node":                       "10.9.1",
 		"tslib":                         "2.6.2",

package/swr/isData.js

@@ -3,5 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Check to see if a single SWR has an error.
  */
-const isData = ({ swr }) => undefined === swr.error && undefined !== swr.data && 'undefined' !== swr.data;
+const isData = ({ swr }) => (undefined === swr.error || null === swr.error) &&
+    undefined !== swr.data &&
+    'undefined' !== swr.data;
 exports.default = isData;

package/swr/isError.js

@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Check to see if a single SWR has an error.
  */
-const isError = ({ swr }) => undefined !== swr.error;
+const isError = ({ swr }) => undefined !== swr.error && null !== swr.error;
 exports.default = isError;

package/number/getPercent.d.ts

@@ -1,9 +0,0 @@
-/**
- * Get the percentage of two numbers.
- */
-declare const getPercent: ({ defaultValue, divisor, value }: {
-    defaultValue?: number;
-    divisor: any;
-    value: any;
-}) => number;
-export default getPercent;

package/number/getPercent.js

@@ -1,18 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getNumber_1 = __importDefault(require("./getNumber"));
-/**
- * Get the percentage of two numbers.
- */
-const getPercent = ({ defaultValue = 0, divisor, value }) => {
-    const cleanValue = (0, getNumber_1.default)({ input: value });
-    const cleanDivisor = (0, getNumber_1.default)({ input: divisor });
-    if (0 === cleanDivisor) {
-        return defaultValue;
-    }
-    return cleanValue / cleanDivisor;
-};
-exports.default = getPercent;

package/number/getRounded.d.ts

@@ -1,9 +0,0 @@
-type GetRounded = {
-    decimalPlaces: number;
-    input: any;
-};
-/**
- * Round a number using the Numbro library.
- */
-declare const getRounded: ({ decimalPlaces, input }: GetRounded) => number;
-export default getRounded;

package/number/getRounded.js

@@ -1,22 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getNumber_1 = __importDefault(require("./getNumber"));
-/**
- * Round a number using the Numbro library.
- */
-const getRounded = ({ decimalPlaces, input }) => {
-    const numbro = require('numbro');
-    const inputNumber = (0, getNumber_1.default)({ defaultValue: 0, input });
-    const stringNumber = numbro(inputNumber)
-        .format({
-        average: false,
-        mantissa: decimalPlaces,
-        thousandSeparated: false,
-        trimMantissa: true,
-    });
-    return Number(stringNumber);
-};
-exports.default = getRounded;