refactor(random.arrayElement): remove default parameter

src/random.ts

@@ -99,41 +99,39 @@ export class Random {
    * Returns random element from the given array.
    *
    * @template T The type of the entries to pick from.
-   * @param array Array to pick the value from. Defaults to `['a', 'b', 'c']`.
+   * @param array Array to pick the value from.
    *
    * @example
-   * faker.random.arrayElement() // 'b'
    * faker.random.arrayElement(['cat', 'dog', 'mouse']) // 'dog'
+   * faker.random.arrayElement([0, 1, 2, 3]) // 3
    */
-  arrayElement<T = string>(
-    array: ReadonlyArray<T> = ['a', 'b', 'c'] as unknown as ReadonlyArray<T>
-  ): T {
-    const index =
-      array.length > 1
-        ? this.faker.datatype.number({ max: array.length - 1 })
-        : 0;
+  arrayElement<T>(array: ReadonlyArray<T>): T {
+    if (array == null || array.length === 0) {
+      throw new FakerError('Cannot get random element from empty array.');
+    }
 
+    const index = this.faker.datatype.number({ max: array.length - 1 });
     return array[index];
   }
 
   /**
    * Returns a subset with random elements of the given array in random order.
    *
    * @template T The type of the entries to pick from.
-   * @param array Array to pick the value from. Defaults to `['a', 'b', 'c']`.
+   * @param array Array to pick the value from.
    * @param count Number of elements to pick.
    *    When not provided, random number of elements will be picked.
    *    When value exceeds array boundaries, it will be limited to stay inside.
    *
    * @example
-   * faker.random.arrayElements() // ['b', 'c']
    * faker.random.arrayElements(['cat', 'dog', 'mouse']) // ['mouse', 'cat']
    * faker.random.arrayElements([1, 2, 3, 4, 5], 2) // [4, 2]
    */
-  arrayElements<T>(
-    array: ReadonlyArray<T> = ['a', 'b', 'c'] as unknown as ReadonlyArray<T>,
-    count?: number
-  ): T[] {
+  arrayElements<T>(array: ReadonlyArray<T>, count?: number): T[] {
+    if (array == null || array.length === 0) {
+      throw new FakerError('Cannot get random element from empty array.');
+    }
+
     if (typeof count !== 'number') {
       count = this.faker.datatype.number({ min: 1, max: array.length });
     } else if (count > array.length) {

src/word.ts

@@ -1,5 +1,17 @@
 import type { Faker } from '.';
 
+function selectWords(length?: number, words: string[] = []): string[] {
+  let wordList = words;
+  if (length) {
+    wordList = words.filter((word) => word.length === length);
+    if (wordList.length === 0) {
+      wordList = words;
+    }
+  }
+
+  return wordList;
+}
+
 /**
  * Module to return various types of words.
  */
@@ -25,18 +37,8 @@ export class Word {
    * faker.word.adjective(100) // 'complete'
    */
   adjective(length?: number): string {
-    let wordList = this.faker.definitions.word.adjective;
-    if (length) {
-      wordList = this.faker.definitions.word.adjective.filter(
-        (word) => word.length === length
-      );
-    }
-
-    // If result of filtered word list is undefined, return an element
-    // from the unfiltered list.
-    return (
-      this.faker.random.arrayElement(wordList) ||
-      this.faker.random.arrayElement(this.faker.definitions.word.adjective)
+    return this.faker.random.arrayElement(
+      selectWords(length, this.faker.definitions.word.adjective)
     );
   }
 
@@ -51,18 +53,8 @@ export class Word {
    * faker.word.adverb(100) // 'sadly'
    */
   adverb(length?: number): string {
-    let wordList = this.faker.definitions.word.adverb;
-    if (length) {
-      wordList = this.faker.definitions.word.adverb.filter(
-        (word: string) => word.length === length
-      );
-    }
-
-    // If result of filtered word list is undefined, return an element
-    // from the unfiltered list.
-    return (
-      this.faker.random.arrayElement(wordList) ||
-      this.faker.random.arrayElement(this.faker.definitions.word.adverb)
+    return this.faker.random.arrayElement(
+      selectWords(length, this.faker.definitions.word.adverb)
     );
   }
 
@@ -77,18 +69,8 @@ export class Word {
    * faker.word.conjunction(100) // 'as long as'
    */
   conjunction(length?: number): string {
-    let wordList = this.faker.definitions.word.conjunction;
-    if (length) {
-      wordList = this.faker.definitions.word.conjunction.filter(
-        (word: string) => word.length === length
-      );
-    }
-
-    // If result of filtered word list is undefined, return an element
-    // from the unfiltered list.
-    return (
-      this.faker.random.arrayElement(wordList) ||
-      this.faker.random.arrayElement(this.faker.definitions.word.conjunction)
+    return this.faker.random.arrayElement(
+      selectWords(length, this.faker.definitions.word.conjunction)
     );
   }
 
@@ -103,18 +85,8 @@ export class Word {
    * faker.word.interjection(100) // 'yowza'
    */
   interjection(length?: number): string {
-    let wordList = this.faker.definitions.word.interjection;
-    if (length) {
-      wordList = this.faker.definitions.word.interjection.filter(
-        (word: string) => word.length === length
-      );
-    }
-
-    // If result of filtered word list is undefined, return an element
-    // from the unfiltered list.
-    return (
-      this.faker.random.arrayElement(wordList) ||
-      this.faker.random.arrayElement(this.faker.definitions.word.interjection)
+    return this.faker.random.arrayElement(
+      selectWords(length, this.faker.definitions.word.interjection)
     );
   }
 
@@ -129,18 +101,8 @@ export class Word {
    * faker.word.noun(100) // 'care'
    */
   noun(length?: number): string {
-    let wordList = this.faker.definitions.word.noun;
-    if (length) {
-      wordList = this.faker.definitions.word.noun.filter(
-        (word: string) => word.length === length
-      );
-    }
-
-    // If result of filtered word list is undefined, return an element
-    // from the unfiltered list.
-    return (
-      this.faker.random.arrayElement(wordList) ||
-      this.faker.random.arrayElement(this.faker.definitions.word.noun)
+    return this.faker.random.arrayElement(
+      selectWords(length, this.faker.definitions.word.noun)
     );
   }
 
@@ -155,18 +117,8 @@ export class Word {
    * faker.word.preposition(100) // 'an'
    */
   preposition(length?: number): string {
-    let wordList = this.faker.definitions.word.preposition;
-    if (length) {
-      wordList = this.faker.definitions.word.preposition.filter(
-        (word: string) => word.length === length
-      );
-    }
-
-    // If result of filtered word list is undefined, return an element
-    // from the unfiltered list.
-    return (
-      this.faker.random.arrayElement(wordList) ||
-      this.faker.random.arrayElement(this.faker.definitions.word.preposition)
+    return this.faker.random.arrayElement(
+      selectWords(length, this.faker.definitions.word.preposition)
     );
   }
 
@@ -181,18 +133,8 @@ export class Word {
    * faker.word.verb(100) // 'mess'
    */
   verb(length?: number): string {
-    let wordList = this.faker.definitions.word.verb;
-    if (length) {
-      wordList = this.faker.definitions.word.verb.filter(
-        (word: string) => word.length === length
-      );
-    }
-
-    // If result of filtered word list is undefined, return an element
-    // from the unfiltered list.
-    return (
-      this.faker.random.arrayElement(wordList) ||
-      this.faker.random.arrayElement(this.faker.definitions.word.verb)
+    return this.faker.random.arrayElement(
+      selectWords(length, this.faker.definitions.word.verb)
     );
   }
 }

test/address.spec.ts

@@ -1,5 +1,5 @@
 import { afterEach, describe, expect, it } from 'vitest';
-import { faker } from '../src';
+import { faker, FakerError } from '../src';
 
 const seededRuns = [
   {
@@ -164,8 +164,8 @@ describe('address', () => {
       it('streetPrefix()', () => {
         faker.seed(seed);
 
-        const streetPrefix = faker.address.streetPrefix();
-        expect(streetPrefix).toEqual(expectations.streetPrefix);
+        // expect an element when `en` locales provide `street_prefix`
+        expect(() => faker.address.streetPrefix()).toThrowError(FakerError);
       });
 
       it('streetSuffix()', () => {