refactor: use enum for LengthStrategy

Author: Shinigami92

src/index.ts

@@ -92,4 +92,5 @@ export {
   generateMersenne32Randomizer,
   generateMersenne53Randomizer,
 } from './utils/mersenne';
-export type { Casing, LengthStrategy, NumberRange } from './utils/types';
+export { LengthStrategy } from './utils/types';
+export type { Casing, LengthStrategyType, NumberRange } from './utils/types';

src/modules/lorem/module.ts

@@ -1,5 +1,5 @@
 import { ModuleBase } from '../../internal/module-base';
-import type { LengthStrategy, NumberRange } from '../../utils/types';
+import type { LengthStrategyType, NumberRange } from '../../utils/types';
 import { filterWordListByLength } from '../word/filter-word-list-by-length';
 
 /**
@@ -46,7 +46,7 @@ export class LoremModule extends ModuleBase {
            *
            * @default 'any-length'
            */
-          strategy?: LengthStrategy;
+          strategy?: LengthStrategyType;
         } = {}
   ): string {
     if (typeof options === 'number') {

src/modules/word/filter-word-list-by-length.ts

@@ -1,6 +1,6 @@
 import { FakerError } from '../../errors/faker-error';
 import { groupBy } from '../../internal/group-by';
-import type { LengthStrategy, NumberRange } from '../../utils/types';
+import type { LengthStrategyType, NumberRange } from '../../utils/types';
 
 /**
  * The error handling strategies for the `filterWordListByLength` function.
@@ -54,7 +54,7 @@ const STRATEGIES = {
 export function filterWordListByLength(options: {
   wordList: ReadonlyArray<string>;
   length?: number | NumberRange;
-  strategy?: LengthStrategy;
+  strategy?: LengthStrategyType;
 }): string[] {
   const { wordList, length, strategy = 'fail' } = options;
 

src/modules/word/module.ts

@@ -1,6 +1,6 @@
 import { FakerError } from '../../errors/faker-error';
 import { ModuleBase } from '../../internal/module-base';
-import type { LengthStrategy, NumberRange } from '../../utils/types';
+import type { LengthStrategyType, NumberRange } from '../../utils/types';
 import { filterWordListByLength } from './filter-word-list-by-length';
 
 /**
@@ -37,7 +37,7 @@ export class WordModule extends ModuleBase {
            *
            * @default 'fail'
            */
-          strategy?: LengthStrategy;
+          strategy?: LengthStrategyType;
         } = {}
   ): string {
     if (typeof options === 'number') {
@@ -82,7 +82,7 @@ export class WordModule extends ModuleBase {
            *
            * @default 'fail'
            */
-          strategy?: LengthStrategy;
+          strategy?: LengthStrategyType;
         } = {}
   ): string {
     if (typeof options === 'number') {
@@ -127,7 +127,7 @@ export class WordModule extends ModuleBase {
            *
            * @default 'fail'
            */
-          strategy?: LengthStrategy;
+          strategy?: LengthStrategyType;
         } = {}
   ): string {
     if (typeof options === 'number') {
@@ -172,7 +172,7 @@ export class WordModule extends ModuleBase {
            *
            * @default 'fail'
            */
-          strategy?: LengthStrategy;
+          strategy?: LengthStrategyType;
         } = {}
   ): string {
     if (typeof options === 'number') {
@@ -217,7 +217,7 @@ export class WordModule extends ModuleBase {
            *
            * @default 'fail'
            */
-          strategy?: LengthStrategy;
+          strategy?: LengthStrategyType;
         } = {}
   ): string {
     if (typeof options === 'number') {
@@ -262,7 +262,7 @@ export class WordModule extends ModuleBase {
            *
            * @default 'fail'
            */
-          strategy?: LengthStrategy;
+          strategy?: LengthStrategyType;
         } = {}
   ): string {
     if (typeof options === 'number') {
@@ -307,7 +307,7 @@ export class WordModule extends ModuleBase {
            *
            * @default 'fail'
            */
-          strategy?: LengthStrategy;
+          strategy?: LengthStrategyType;
         } = {}
   ): string {
     if (typeof options === 'number') {
@@ -350,7 +350,7 @@ export class WordModule extends ModuleBase {
            *
            * @default 'fail'
            */
-          strategy?: LengthStrategy;
+          strategy?: LengthStrategyType;
         } = {}
   ): string {
     const wordMethods = this.faker.helpers.shuffle([

src/utils/types.ts

@@ -23,18 +23,31 @@ export interface NumberRange {
 
 /**
  * The strategy to apply when no words with a matching length are found.
- *
- * Available error handling strategies:
- *
- * - `fail`: Throws an error if no words with the given length are found.
- * - `shortest`: Returns any of the shortest words.
- * - `closest`: Returns any of the words closest to the given length.
- * - `longest`: Returns any of the longest words.
- * - `any-length`: Returns a word with any length.
  */
-export type LengthStrategy =
-  | 'fail'
-  | 'closest'
-  | 'shortest'
-  | 'longest'
-  | 'any-length';
+export enum LengthStrategy {
+  /**
+   * Throws an error if no words with the given length are found.
+   */
+  Fail = 'fail',
+  /**
+   * Returns any of the words closest to the given length.
+   */
+  Closest = 'closest',
+  /**
+   * Returns any of the shortest words.
+   */
+  Shortest = 'shortest',
+  /**
+   * Returns any of the longest words.
+   */
+  Longest = 'longest',
+  /**
+   * Returns a word with any length.
+   */
+  AnyLength = 'any-length',
+}
+
+/**
+ * The strategy to apply when no words with a matching length are found.
+ */
+export type LengthStrategyType = `${LengthStrategy}`;