@8ms/helpers 2.3.31 → 2.3.33

package/dist/number/index.d.mts

@@ -1,8 +1,8 @@
-//#region src/number/formatStandard.d.ts
+//#region src/number/formatCompact.d.ts
 /**
- * Take a given number and format it.
+ * Take a given number and format as a compact number.
  */
-declare const formatStandard: (input: any, maxDp?: number, minDp?: number) => string;
+declare const formatCompact: (input: any, maxDp?: number, minDp?: number) => string;
 //#endregion
 //#region src/number/formatCurrency.d.ts
 /**
@@ -11,6 +11,12 @@ declare const formatStandard: (input: any, maxDp?: number, minDp?: number) => st
  */
 declare const formatCurrency: (input: any, currency?: string, maxDp?: number, minDp?: number) => string;
 //#endregion
+//#region src/number/formatStandard.d.ts
+/**
+ * Take a given number and format it.
+ */
+declare const formatStandard: (input: any, maxDp?: number, minDp?: number) => string;
+//#endregion
 //#region src/number/getDecimal.d.ts
 /**
  * Return a decimal number after rounding.
@@ -44,4 +50,4 @@ declare const getNumber: (input: any, defaultValue?: number) => number;
  */
 declare const getPercentIncrease: (current: any, comparison: any, defaultValue: number) => number;
 //#endregion
-export { formatCurrency, formatStandard, getDecimal, getNumber, getPercent, getPercentIncrease, getSafeDivide };
+export { formatCompact, formatCurrency, formatStandard, getDecimal, getNumber, getPercent, getPercentIncrease, getSafeDivide };

package/dist/number/index.mjs

@@ -1,17 +1,17 @@
 import { n as getNumber, t as getDecimal } from "../getDecimal-CafxtLhH.mjs";
 
-//#region src/number/formatStandard.ts
+//#region src/number/formatCompact.ts
 /**
-* Take a given number and format it.
+* Take a given number and format as a compact number.
 */
-const formatStandard = (input, maxDp, minDp) => {
+const formatCompact = (input, maxDp, minDp) => {
 	const inputValue = getNumber(input);
-	const maximumDp = maxDp ?? 0;
+	const maximumDp = maxDp ?? 2;
 	const minimumDp = minDp ?? maxDp;
 	return Intl.NumberFormat(void 0, {
 		minimumFractionDigits: maximumDp,
 		maximumFractionDigits: minimumDp,
-		notation: "standard"
+		notation: "compact"
 	}).format(inputValue);
 };
 
@@ -36,6 +36,22 @@ const formatCurrency = (input, currency = "GBP", maxDp, minDp) => {
 	return formatted;
 };
 
+//#endregion
+//#region src/number/formatStandard.ts
+/**
+* Take a given number and format it.
+*/
+const formatStandard = (input, maxDp, minDp) => {
+	const inputValue = getNumber(input);
+	const maximumDp = maxDp ?? 0;
+	const minimumDp = minDp ?? maxDp;
+	return Intl.NumberFormat(void 0, {
+		minimumFractionDigits: maximumDp,
+		maximumFractionDigits: minimumDp,
+		notation: "standard"
+	}).format(inputValue);
+};
+
 //#endregion
 //#region src/number/getSafeDivide.ts
 /**
@@ -75,4 +91,4 @@ const getPercentIncrease = (current, comparison, defaultValue) => {
 };
 
 //#endregion
-export { formatCurrency, formatStandard, getDecimal, getNumber, getPercent, getPercentIncrease, getSafeDivide };
+export { formatCompact, formatCurrency, formatStandard, getDecimal, getNumber, getPercent, getPercentIncrease, getSafeDivide };

package/dist/swr/client/index.d.mts

@@ -1,5 +1,3 @@
-import { c as ApiState } from "../../index-DW9yJLtI.mjs";
-
 //#region src/swr/client/swr.d.ts
 type Swr = {
   data: any;
@@ -7,40 +5,42 @@ type Swr = {
   skipFetch?: boolean;
   url: string;
 };
-type SwrResponse = {
-  data: any;
-  error: any;
+type SwrResponse<TData = unknown> = {
+  data?: TData;
   fetcher: Function;
+  error?: unknown;
   mutate: {
-    data: any;
+    data: object;
     url: string;
   };
-  state?: ApiState;
-  swrMutate: Function;
+  state?: unknown;
+  swrMutate: unknown;
 };
 /**
- * Check to see if a single SWR has an error.
+ * Check to see if a single SWR has data and no error.
  */
-declare const isData: (swr: SwrResponse) => boolean;
+declare const isData: <TData>(swr: SwrResponse<TData>) => swr is SwrResponse<TData> & {
+  data: TData;
+};
 /**
  * Check to see if a single SWR is loading.
  */
-declare const isLoading: (swr: SwrResponse) => boolean;
+declare const isLoading: <TData>(swr: SwrResponse<TData>) => boolean;
 /**
  * Check to see if a single SWR has an error.
  */
-declare const isError: (swr: SwrResponse) => boolean;
+declare const isError: <TData>(swr: SwrResponse<TData>) => boolean;
 /**
  * Are any of SWRs loading
  */
-declare const isAnyLoading: (swrs: SwrResponse[]) => boolean;
+declare const isAnyLoading: <TData>(swrs: SwrResponse<TData>[]) => boolean;
 /**
  * Are any of the SWRs marked as an error.
  */
-declare const isAnyError: (swrs: SwrResponse[]) => boolean;
+declare const isAnyError: <TData>(swrs: SwrResponse<TData>[]) => boolean;
 /**
  * Are all SWRs data ready.
  */
-declare const isAllData: (swrs: SwrResponse[]) => boolean;
+declare const isAllData: <TData>(swrs: SwrResponse<TData>[]) => boolean;
 //#endregion
 export { Swr, SwrResponse, isAllData, isAnyError, isAnyLoading, isData, isError, isLoading };

package/dist/swr/client/index.mjs

@@ -1,6 +1,6 @@
 //#region src/swr/client/swr.ts
 /**
-* Check to see if a single SWR has an error.
+* Check to see if a single SWR has data and no error.
 */
 const isData = (swr) => (void 0 === swr.error || null === swr.error) && "undefined" !== typeof swr.data && "undefined" !== swr.data;
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@8ms/helpers",
 	"license": "UNLICENSED",
-	"version": "2.3.31",
+	"version": "2.3.33",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"