More helpers

Author: ogroppo

CHANGELOG.md

@@ -1,5 +1,16 @@
 # deverything
 
+## 5.3.0
+
+### Minor Changes
+
+- deprecated chunkedAsync
+- deplecated chunkedDynamic
+- added getCountryName
+- added getFlagEmoji
+- added paginationToSkipTake
+- added skipTakeToPagination
+
 ## 5.2.0
 
 ### Minor Changes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "deverything",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "Everything you need for Dev",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

src/helpers/chunkedAsync.ts

@@ -2,11 +2,7 @@ import { chunkArray } from "./chunkArray";
 import { sleep } from "./sleep";
 
 /**
- * @description Run a series of (async) functions in order and return the results
- * @param array
- * @param chunkSize
- * @param fn
- * @param options.minChunkTimeMs - Minimum time to process each chunk
+ * @deprecated Use pMap/pAll/pReduce instead
  */
 export const chunkedAsync = async <T>(
   array: T[],

src/helpers/chunkedDynamic.ts

@@ -2,15 +2,7 @@ import { clamp } from "./clamp";
 import { sleep } from "./sleep";
 
 /**
- * @description Run a series of (async) functions with dynamic chunk sizes
- * @param array - Array to chunk
- * @param initialChunkSize - Size of initial chunk
- * @param fn - Function to run on each chunk
- * @param options.idealChunkDuration - Ideal time to process each chunk, the chunk size will adjust to meet this duration
- * @param options.maxChunkSize - Maximum chunk size (default 200)
- * @param options.minChunkDuration - Minimum time to process each chunk (useful for rate limiting)
- * @param options.minChunkSize - Minimum chunk size (default 1)
- * @param options.sleepTimeMs - Time to sleep between each chunk
+ * @deprecated Use pMap/pAll/pReduce instead
  */
 export const chunkedDynamic = async <T>(
   array: T[],

src/helpers/getCountryName.test.ts

@@ -0,0 +1,26 @@
+import { describe, expect, test } from "vitest";
+import { getCountryName } from "./getCountryName";
+
+describe("getCountryName", () => {
+  test("iso2 codes", () => {
+    expect(getCountryName("GB")).toBe("United Kingdom");
+    expect(getCountryName("US")).toBe("United States");
+    expect(getCountryName("FR")).toBe("France");
+  });
+
+  test("iso3 codes", () => {
+    expect(getCountryName("GBR")).toBe("United Kingdom");
+    expect(getCountryName("USA")).toBe("United States");
+    expect(getCountryName("FRA")).toBe("France");
+  });
+
+  test("case insensitive", () => {
+    expect(getCountryName("gb")).toBe("United Kingdom");
+    expect(getCountryName("gbr")).toBe("United Kingdom");
+  });
+
+  test("falls back to input for unknown codes", () => {
+    expect(getCountryName("XX")).toBe("XX");
+    expect(getCountryName("XXX")).toBe("XXX");
+  });
+});

src/helpers/getCountryName.ts

@@ -0,0 +1,9 @@
+const countryNames = new Intl.DisplayNames(["en"], { type: "region" });
+
+/**
+ * Returns the English display name for an alpha-2 (e.g. "GB") country code.
+ * Falls back to the original input when the code is unrecognised.
+ */
+export const getCountryName = (countryCode: string): string | undefined => {
+  return countryNames.of(countryCode.toUpperCase());
+};

src/helpers/getFlagEmoji.test.ts

@@ -0,0 +1,19 @@
+import { describe, expect, test } from "vitest";
+import { getFlagEmoji } from "./getFlagEmoji";
+
+describe("getFlagEmoji", () => {
+  test("iso2 codes", () => {
+    expect(getFlagEmoji("GB")).toBe("🇬🇧");
+    expect(getFlagEmoji("US")).toBe("🇺🇸");
+    expect(getFlagEmoji("FR")).toBe("🇫🇷");
+  });
+
+  test("case insensitive", () => {
+    expect(getFlagEmoji("gb")).toBe("🇬🇧");
+    expect(getFlagEmoji("Gb")).toBe("🇬🇧");
+  });
+
+  test("returns something odd for unknown codes", () => {
+    expect(getFlagEmoji("XX")).toBe("🇽🇽");
+  });
+});

src/helpers/getFlagEmoji.ts

@@ -0,0 +1,15 @@
+/**
+ * Returns the flag emoji for an ISO 3166-1 country code.
+ * Accepts alpha-2 (e.g. "GB") codes.
+ * Returns broken emoji when the code is unrecognised.
+ */
+export const getFlagEmoji = (countryCode: string): string => {
+  if (countryCode.length !== 2)
+    throw new Error("Invalid country code, must be 2 characters long");
+
+  const codePoints = countryCode
+    .toUpperCase()
+    .split("")
+    .map((char) => 127397 + char.charCodeAt(0));
+  return String.fromCodePoint(...codePoints);
+};

src/helpers/index.ts

@@ -3,10 +3,10 @@ export * from "./arrayDiff";
 export * from "./arrayIntersection";
 export * from "./capitalize";
 export * from "./chunkArray";
-export * from "./chunkText";
 export * from "./chunkedAll";
 export * from "./chunkedAsync";
 export * from "./chunkedDynamic";
+export * from "./chunkText";
 export * from "./clamp";
 export * from "./cleanSpaces";
 export * from "./copyToClipboard";
@@ -20,6 +20,8 @@ export * from "./first";
 export * from "./firstKey";
 export * from "./firstValue";
 export * from "./getCookieByName";
+export * from "./getCountryName";
+export * from "./getFlagEmoji";
 export * from "./getKeys";
 export * from "./getUrlSearchParam";
 export * from "./getUrlSearchParams";
@@ -37,6 +39,7 @@ export * from "./moveToLast";
 export * from "./normalizeNumber";
 export * from "./normalizeString";
 export * from "./omit";
+export * from "./paginationToSkipTake";
 export * from "./parseArray";
 export * from "./parseDate";
 export * from "./parsePrimitive";
@@ -52,6 +55,7 @@ export * from "./setObjectPath";
 export * from "./setUrlSearchParams";
 export * from "./shuffle";
 export * from "./singleton";
+export * from "./skipTakeToPagination";
 export * from "./sleep";
 export * from "./stringify";
 export * from "./toggleArrayValue";

src/helpers/paginationToSkipTake.test.ts

@@ -0,0 +1,32 @@
+import { describe, expect, test } from "vitest";
+import { paginationToSkipTake } from "./paginationToSkipTake";
+
+describe("paginationToSkipTake", () => {
+  test("first page", () => {
+    expect(paginationToSkipTake({ page: 1, perPage: 10 })).toEqual({
+      skip: 0,
+      take: 10,
+    });
+  });
+
+  test("second page", () => {
+    expect(paginationToSkipTake({ page: 2, perPage: 10 })).toEqual({
+      skip: 10,
+      take: 10,
+    });
+  });
+
+  test("third page with different perPage", () => {
+    expect(paginationToSkipTake({ page: 3, perPage: 25 })).toEqual({
+      skip: 50,
+      take: 25,
+    });
+  });
+
+  test("perPage of 1", () => {
+    expect(paginationToSkipTake({ page: 5, perPage: 1 })).toEqual({
+      skip: 4,
+      take: 1,
+    });
+  });
+});