diff options
Diffstat (limited to 'src/modules/helpers')
| -rw-r--r-- | src/modules/helpers/index.ts | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/src/modules/helpers/index.ts b/src/modules/helpers/index.ts index 7da4fbc8..406f7f19 100644 --- a/src/modules/helpers/index.ts +++ b/src/modules/helpers/index.ts @@ -628,6 +628,26 @@ export class HelpersModule { } /** + * Helper method that converts the given number or range to a number. + * + * @param numberOrRange The number or range to convert. + * @param numberOrRange.min The minimum value for the range. + * @param numberOrRange.max The maximum value for the range. + * + * @example + * faker.helpers.rangeToNumber(1) // 1 + * faker.helpers.rangeToNumber({ min: 1, max: 10 }) // 5 + * + * @since 8.0.0 + */ + rangeToNumber(numberOrRange: number | { min: number; max: number }): number { + if (typeof numberOrRange === 'number') { + return numberOrRange; + } + return this.faker.datatype.number(numberOrRange); + } + + /** * Generates a unique result using the results of the given method. * Used unique entries will be stored internally and filtered from subsequent calls. * |
