maxWords

src/random/randomParagraph.test.ts

@@ -7,26 +7,35 @@ describe(`randomParagraph`, () => {
     expect(randomParagraph().length).toBeTruthy();
     expect(randomParagraph().endsWith(".")).toBeTruthy();
   });
-});
 
-it(`respects maxCharacters`, () => {
-  const result = randomParagraph({ maxCharacters: 10 });
-  expect(result.length).toBeLessThanOrEqual(10);
-});
+  it(`respects maxCharacters`, () => {
+    const result = randomParagraph({ maxCharacters: 10 });
+    expect(result.length).toBeLessThanOrEqual(10);
+  });
 
-it(`respects words count with a large enough maxCharacters`, () => {
-  const result = randomParagraph({ words: 5, maxCharacters: 1000 });
-  const wordCount = result.split(" ").length;
-  // Subtracting 1 because the last word is followed by a period.
-  expect(wordCount).toEqual(5);
-});
+  it(`generates a random number of words between minWords and maxWords`, () => {
+    const result = randomParagraph({
+      minWords: 5,
+      maxWords: 10,
+      maxCharacters: 1000,
+    });
 
-it(`does not exceed maxCharacters even with large words count`, () => {
-  const result = randomParagraph({ maxCharacters: 10, words: 10 });
-  expect(result.length).toBeLessThanOrEqual(10);
-});
+    const wordCount = result.split(" ").length;
+    expect(wordCount).toBeGreaterThanOrEqual(5);
+    expect(wordCount).toBeLessThanOrEqual(10);
+  });
+
+  it(`does not exceed maxCharacters even with large words count`, () => {
+    const result = randomParagraph({
+      maxCharacters: 10,
+      minWords: 10,
+      maxWords: 20,
+    });
+    expect(result.length).toBeLessThanOrEqual(10);
+  });
 
-it(`returns a string with a period at the end`, () => {
-  const result = randomParagraph();
-  expect(result.endsWith(".")).toBeTruthy();
+  it(`returns a string with a period at the end`, () => {
+    const result = randomParagraph();
+    expect(result.endsWith(".")).toBeTruthy();
+  });
 });

src/random/randomParagraph.ts

@@ -12,13 +12,15 @@ import { randomWord } from "./randomWord";
  */
 export const randomParagraph = ({
   maxCharacters = 200,
-  words = 8,
+  minWords = 8,
+  maxWords = 16,
 }: {
   maxCharacters?: number;
-  words?: number;
+  minWords?: number;
+  maxWords?: number;
 } = {}) => {
   return capitalize(
-    array(randomInt(words, 16), () => randomWord())
+    array(randomInt(minWords, maxWords), () => randomWord())
       .join(" ")
       .slice(0, maxCharacters - 1) + "."
   );