@8ms/helpers 2.3.32 → 2.3.33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,8 +1,8 @@
1
- //#region src/number/formatStandard.d.ts
1
+ //#region src/number/formatCompact.d.ts
2
2
  /**
3
- * Take a given number and format it.
3
+ * Take a given number and format as a compact number.
4
4
  */
5
- declare const formatStandard: (input: any, maxDp?: number, minDp?: number) => string;
5
+ declare const formatCompact: (input: any, maxDp?: number, minDp?: number) => string;
6
6
  //#endregion
7
7
  //#region src/number/formatCurrency.d.ts
8
8
  /**
@@ -11,6 +11,12 @@ declare const formatStandard: (input: any, maxDp?: number, minDp?: number) => st
11
11
  */
12
12
  declare const formatCurrency: (input: any, currency?: string, maxDp?: number, minDp?: number) => string;
13
13
  //#endregion
14
+ //#region src/number/formatStandard.d.ts
15
+ /**
16
+ * Take a given number and format it.
17
+ */
18
+ declare const formatStandard: (input: any, maxDp?: number, minDp?: number) => string;
19
+ //#endregion
14
20
  //#region src/number/getDecimal.d.ts
15
21
  /**
16
22
  * Return a decimal number after rounding.
@@ -44,4 +50,4 @@ declare const getNumber: (input: any, defaultValue?: number) => number;
44
50
  */
45
51
  declare const getPercentIncrease: (current: any, comparison: any, defaultValue: number) => number;
46
52
  //#endregion
47
- export { formatCurrency, formatStandard, getDecimal, getNumber, getPercent, getPercentIncrease, getSafeDivide };
53
+ export { formatCompact, formatCurrency, formatStandard, getDecimal, getNumber, getPercent, getPercentIncrease, getSafeDivide };
@@ -1,17 +1,17 @@
1
1
  import { n as getNumber, t as getDecimal } from "../getDecimal-CafxtLhH.mjs";
2
2
 
3
- //#region src/number/formatStandard.ts
3
+ //#region src/number/formatCompact.ts
4
4
  /**
5
- * Take a given number and format it.
5
+ * Take a given number and format as a compact number.
6
6
  */
7
- const formatStandard = (input, maxDp, minDp) => {
7
+ const formatCompact = (input, maxDp, minDp) => {
8
8
  const inputValue = getNumber(input);
9
- const maximumDp = maxDp ?? 0;
9
+ const maximumDp = maxDp ?? 2;
10
10
  const minimumDp = minDp ?? maxDp;
11
11
  return Intl.NumberFormat(void 0, {
12
12
  minimumFractionDigits: maximumDp,
13
13
  maximumFractionDigits: minimumDp,
14
- notation: "standard"
14
+ notation: "compact"
15
15
  }).format(inputValue);
16
16
  };
17
17
 
@@ -36,6 +36,22 @@ const formatCurrency = (input, currency = "GBP", maxDp, minDp) => {
36
36
  return formatted;
37
37
  };
38
38
 
39
+ //#endregion
40
+ //#region src/number/formatStandard.ts
41
+ /**
42
+ * Take a given number and format it.
43
+ */
44
+ const formatStandard = (input, maxDp, minDp) => {
45
+ const inputValue = getNumber(input);
46
+ const maximumDp = maxDp ?? 0;
47
+ const minimumDp = minDp ?? maxDp;
48
+ return Intl.NumberFormat(void 0, {
49
+ minimumFractionDigits: maximumDp,
50
+ maximumFractionDigits: minimumDp,
51
+ notation: "standard"
52
+ }).format(inputValue);
53
+ };
54
+
39
55
  //#endregion
40
56
  //#region src/number/getSafeDivide.ts
41
57
  /**
@@ -75,4 +91,4 @@ const getPercentIncrease = (current, comparison, defaultValue) => {
75
91
  };
76
92
 
77
93
  //#endregion
78
- export { formatCurrency, formatStandard, getDecimal, getNumber, getPercent, getPercentIncrease, getSafeDivide };
94
+ export { formatCompact, formatCurrency, formatStandard, getDecimal, getNumber, getPercent, getPercentIncrease, getSafeDivide };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@8ms/helpers",
3
3
  "license": "UNLICENSED",
4
- "version": "2.3.32",
4
+ "version": "2.3.33",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"