Feat: Add totalmax/min char count support

README.md

@@ -161,3 +161,23 @@ console.log(totalSlugs);
 ```
 
 Again, this `1000` is just an example. Importantly, this could help you determine that you're not comfortable with this limited combinatoric space and you can choose to add additional categories.
+
+
+# Character Count Constraints
+
+You can provide a `totalMax` and/or a `totalMin` to specify the number of characters for the generated slug:
+
+```javascript
+const shortSlug = generateSlug(2, {
+  categories: {
+    noun: ["animals"],
+    adjective: ["color"],
+  },
+  partsOfSpeech: ["adjective", "noun"],
+  charCount: {
+    totalMax: 15,
+    totalMin: 10,
+  },
+});
+// green-alligator
+```

index.ts

@@ -9,14 +9,18 @@ interface FixedLengthArray<T extends any, L extends number> extends Array<T> {
 
 type Case = "kebab" | "camel" | "title" | "lower" | "sentence";
 
+type CharCountOptions = {
+  totalMax?: number;
+  totalMin?: number;
+};
+
 type Options<T, L extends number> = {
   partsOfSpeech: FixedLengthArray<T, L>;
-  categories: Partial<
-    {
-      [K in PartsOfSpeech]: Categories[K][];
-    }
-  >;
+  categories: Partial<{
+    [K in PartsOfSpeech]: Categories[K][];
+  }>;
   format: Case;
+  charCount?: CharCountOptions;
 };
 
 export type RandomWordOptions<N extends number> = Partial<
@@ -32,13 +36,14 @@ export function generateSlug<N extends number>(
     partsOfSpeech: getDefaultPartsOfSpeech(numWords),
     categories: {},
     format: "kebab",
+    charCount: {},
   };
   const opts: Options<PartsOfSpeech, typeof numWords> = {
     ...defaultOptions,
     ...options,
   };
 
-  const words = [];
+  let words = [];
 
   for (let i = 0; i < numWords; i++) {
     const partOfSpeech = opts.partsOfSpeech[i];
@@ -50,7 +55,36 @@ export function generateSlug<N extends number>(
     words.push(rand);
   }
 
-  return formatter(words, opts.format);
+  let slug = formatter(words, opts.format);
+
+  if (
+    opts.charCount?.totalMax !== undefined &&
+    slug.length > opts.charCount.totalMax
+  ) {
+    while (slug.length > opts.charCount.totalMax) {
+      words.pop();
+      slug = formatter(words, opts.format);
+    }
+  }
+  if (
+    opts.charCount?.totalMin !== undefined &&
+    slug.length < opts.charCount.totalMin
+  ) {
+    while (slug.length < opts.charCount.totalMin) {
+      const partOfSpeech: PartsOfSpeech =
+        opts.partsOfSpeech[words.length % numWords];
+      const candidates: string[] = getWordsByCategory(
+        partOfSpeech,
+        opts.categories[partOfSpeech] as Categories[typeof partOfSpeech][]
+      );
+      const rand: string =
+        candidates[Math.floor(Math.random() * candidates.length)];
+      words.push(rand);
+      slug = formatter(words, opts.format);
+    }
+  }
+
+  return slug;
 }
 
 function getDefaultPartsOfSpeech<N extends number>(length: N) {
@@ -119,3 +153,4 @@ export function totalUniqueSlugs<N extends number>(
   }
   return combos;
 }
+

test/randomWordSlugs.test.ts

@@ -62,6 +62,38 @@ describe("wordList", () => {
   });
 });
 
+describe("generateSlug", () => {
+  it("respects totalMax character count", () => {
+    const maxChars = 15;
+    const slug = generateSlug(2, {
+      categories: {
+        noun: ["animals"],
+        adjective: ["color"],
+      },
+      partsOfSpeech: ["adjective", "noun"],
+      charCount: {
+        totalMax: maxChars,
+      },
+    });
+    expect(slug.length).toBeLessThanOrEqual(maxChars);
+  });
+
+  it("respects totalMin character count", () => {
+    const minChars = 10;
+    const slug = generateSlug(2, {
+      categories: {
+        noun: ["animals"],
+        adjective: ["color"],
+      },
+      partsOfSpeech: ["adjective", "noun"],
+      charCount: {
+        totalMin: minChars,
+      },
+    });
+    expect(slug.length).toBeGreaterThanOrEqual(minChars);
+  });
+});
+
 describe("generateSlug", () => {
   test("generates three random kebab-cased words by default", () => {
     const slug = generateSlug();
@@ -184,3 +216,4 @@ describe("totalUniqueSlugs", () => {
     expect(num).toBe(actualTotal);
   });
 });
+