aboutsummaryrefslogtreecommitdiff
path: root/src/modules/random
diff options
context:
space:
mode:
authorShinigami <[email protected]>2022-05-04 11:48:03 +0200
committerGitHub <[email protected]>2022-05-04 11:48:03 +0200
commit683ee3405c39408d74d74cac0755a26de7a99e35 (patch)
tree30a51b3fe3bf1013149045777f84e0d8de9724c5 /src/modules/random
parent100a1ea230cba422174a6b5103c56bc4cf9c0dc4 (diff)
downloadfaker-683ee3405c39408d74d74cac0755a26de7a99e35.tar.xz
faker-683ee3405c39408d74d74cac0755a26de7a99e35.zip
refactor!: remove deprecations (#916)
Diffstat (limited to 'src/modules/random')
-rw-r--r--src/modules/random/index.ts308
1 files changed, 1 insertions, 307 deletions
diff --git a/src/modules/random/index.ts b/src/modules/random/index.ts
index 7939b298..e3e36ec4 100644
--- a/src/modules/random/index.ts
+++ b/src/modules/random/index.ts
@@ -1,6 +1,5 @@
import type { Faker } from '../..';
import { FakerError } from '../../errors/faker-error';
-import { deprecated } from '../../internal/deprecated';
/**
* Method to reduce array of characters.
@@ -17,7 +16,7 @@ function arrayRemove<T>(arr: T[], values: readonly T[]): T[] {
}
/**
- * Generates random values of different kinds. Some methods are deprecated and have been moved to dedicated modules.
+ * Generates random values of different kinds.
*/
export class Random {
constructor(private readonly faker: Faker) {
@@ -31,267 +30,6 @@ export class Random {
}
/**
- * Returns a single random number between zero and the given max value or the given range with the specified precision.
- * The bounds are inclusive.
- *
- * @param options Maximum value or options object.
- * @param options.min Lower bound for generated number. Defaults to `0`.
- * @param options.max Upper bound for generated number. Defaults to `99999`.
- * @param options.precision Precision of the generated number. Defaults to `1`.
- *
- * @see faker.datatype.number()
- *
- * @example
- * faker.random.number() // 55422
- * faker.random.number(100) // 52
- * faker.random.number({ min: 1000000 }) // 431433
- * faker.random.number({ max: 100 }) // 42
- * faker.random.number({ precision: 0.01 }) // 64246.18
- * faker.random.number({ min: 10, max: 100, precision: 0.01 }) // 36.94
- *
- * @deprecated
- */
- number(
- options?: number | { min?: number; max?: number; precision?: number }
- ): number {
- deprecated({
- deprecated: 'faker.random.number()',
- proposed: 'faker.datatype.number()',
- // since: 'v5.0.0', (?)
- until: 'v7.0.0',
- });
- return this.faker.datatype.number(options);
- }
-
- /**
- * Returns a single random floating-point number for the given precision or range and precision.
- *
- * @param options Precision or options object.
- * @param options.min Lower bound for generated number. Defaults to `0`.
- * @param options.max Upper bound for generated number. Defaults to `99999`.
- * @param options.precision Precision of the generated number. Defaults to `0.01`.
- *
- * @see faker.datatype.float()
- *
- * @example
- * faker.random.float() // 51696.36
- * faker.random.float(0.1) // 52023.2
- * faker.random.float({ min: 1000000 }) // 212859.76
- * faker.random.float({ max: 100 }) // 28.11
- * faker.random.float({ precision: 0.1 }) // 84055.3
- * faker.random.float({ min: 10, max: 100, precision: 0.001 }) // 57.315
- *
- * @deprecated
- */
- float(
- options?: number | { min?: number; max?: number; precision?: number }
- ): number {
- deprecated({
- deprecated: 'faker.random.float()',
- proposed: 'faker.datatype.float()',
- // since: 'v5.0.0', (?)
- until: 'v7.0.0',
- });
- return this.faker.datatype.float(options);
- }
-
- /**
- * 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']`.
- *
- * @example
- * faker.random.arrayElement() // 'b'
- * faker.random.arrayElement(['cat', 'dog', 'mouse']) // 'dog'
- *
- * @deprecated
- */
- arrayElement<T = string>(
- array: ReadonlyArray<T> = ['a', 'b', 'c'] as unknown as ReadonlyArray<T>
- ): T {
- deprecated({
- deprecated: 'faker.random.arrayElement()',
- proposed: 'faker.helpers.arrayElement()',
- since: 'v6.3.0',
- until: 'v7.0.0',
- });
- return this.faker.helpers.arrayElement(array);
- }
-
- /**
- * 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 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]
- *
- * @deprecated
- */
- arrayElements<T>(
- array: ReadonlyArray<T> = ['a', 'b', 'c'] as unknown as ReadonlyArray<T>,
- count?: number
- ): T[] {
- deprecated({
- deprecated: 'faker.random.arrayElements()',
- proposed: 'faker.helpers.arrayElements()',
- since: 'v6.3.0',
- until: 'v7.0.0',
- });
- return this.faker.helpers.arrayElements(array, count);
- }
-
- /**
- * Returns a random key from given object.
- *
- * @template T The type of `Record` to pick from.
- * @template K The keys of `T`.
- * @param object The object to get the keys from.
- * @param field If this is set to `'key'`, this method will a return a random key of the given instance.
- *
- * @see faker.helpers.objectKey()
- *
- * @example
- * const object = { keyA: 'valueA', keyB: 42 };
- * faker.random.objectElement(object, 'key') // 'keyB'
- *
- * @deprecated
- */
- objectElement<T extends Record<string, unknown>, K extends keyof T>(
- object: T,
- field: 'key'
- ): K;
- /**
- * Returns a random value from given object.
- *
- * @template T The type of `Record` to pick from.
- * @template K The keys of `T`.
- * @param object The object to get the values from.
- * @param field If this is set to `'value'`, this method will a return a random value of the given instance.
- *
- * @see faker.helpers.objectValue()
- *
- * @example
- * const object = { keyA: 'valueA', keyB: 42 };
- * faker.random.objectElement(object) // 42
- * faker.random.objectElement(object, 'value') // 'valueA'
- *
- * @deprecated
- */
- objectElement<T extends Record<string, unknown>, K extends keyof T>(
- object: T,
- field?: unknown
- ): T[K];
- /**
- * Returns a random key or value from given object.
- *
- * @template T The type of `Record` to pick from.
- * @template K The keys of `T`.
- * @param object The object to get the keys or values from.
- * @param field If this is set to `'key'`, this method will a return a random key of the given instance.
- * If this is set to `'value'`, this method will a return a random value of the given instance.
- * Defaults to `'value'`.
- *
- * @see faker.helpers.objectKey()
- * @see faker.helpers.objectValue()
- *
- * @example
- * const object = { keyA: 'valueA', keyB: 42 };
- * faker.random.objectElement(object) // 42
- * faker.random.objectElement(object, 'key') // 'keyB'
- * faker.random.objectElement(object, 'value') // 'valueA'
- *
- * @deprecated
- */
- objectElement<T extends Record<string, unknown>, K extends keyof T>(
- object?: T,
- field?: 'key' | 'value'
- ): K | T[K];
- /**
- * Returns a random key or value from given object.
- *
- * @template T The type of `Record` to pick from.
- * @template K The keys of `T`.
- * @param object The object to get the keys or values from.
- * @param field If this is set to `'key'`, this method will a return a random key of the given instance.
- * If this is set to `'value'`, this method will a return a random value of the given instance.
- * Defaults to `'value'`.
- *
- * @see faker.helpers.objectKey()
- * @see faker.helpers.objectValue()
- *
- * @example
- * const object = { keyA: 'valueA', keyB: 42 };
- * faker.random.objectElement(object) // 42
- * faker.random.objectElement(object, 'key') // 'keyB'
- * faker.random.objectElement(object, 'value') // 'valueA'
- *
- * @deprecated
- */
- objectElement<T extends Record<string, unknown>, K extends keyof T>(
- object: T = { foo: 'bar', too: 'car' } as unknown as T,
- field: 'key' | 'value' = 'value'
- ): K | T[K] {
- const useKey = field === 'key';
- deprecated({
- deprecated: `faker.random.objectElement(${useKey ? "obj, 'key'" : ''})`,
- proposed: `faker.helpers.object${useKey ? 'Key' : 'Value'}()`,
- since: 'v6.3.0',
- until: 'v7.0.0',
- });
- return field === 'key'
- ? (this.faker.helpers.objectKey(object) as K)
- : (this.faker.helpers.objectValue(object) as T[K]);
- }
-
- /**
- * Returns a UUID v4 ([Universally Unique Identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier)).
- *
- * @see faker.datatype.uuid()
- *
- * @example
- * faker.random.uuid() // '4136cd0b-d90b-4af7-b485-5d1ded8db252'
- *
- * @deprecated
- */
- uuid(): string {
- deprecated({
- deprecated: 'faker.random.uuid()',
- proposed: 'faker.datatype.uuid()',
- // since: 'v5.0.0', (?)
- until: 'v7.0.0',
- });
- return this.faker.datatype.uuid();
- }
-
- /**
- * Returns the boolean value `true` or `false`.
- *
- * @see faker.datatype.boolean()
- *
- * @example
- * faker.random.boolean() // false
- *
- * @deprecated
- */
- boolean(): boolean {
- deprecated({
- deprecated: 'faker.random.boolean()',
- proposed: 'faker.datatype.boolean()',
- // since: 'v5.0.0', (?)
- until: 'v7.0.0',
- });
- return this.faker.datatype.boolean();
- }
-
- /**
* Returns random word.
*
* @example
@@ -392,26 +130,6 @@ export class Random {
}
/**
- * Returns a random image url.
- *
- * @see faker.random.image()
- *
- * @example
- * faker.random.image() // 'http://placeimg.com/640/480/animals'
- *
- * @deprecated
- */
- image(): string {
- deprecated({
- deprecated: 'faker.random.image()',
- proposed: 'faker.image.image()',
- // since: 'v5.0.0', (?)
- until: 'v7.0.0',
- });
- return this.faker.image.image();
- }
-
- /**
* Returns a random locale, that is available in this faker instance.
* You can use the returned locale with `faker.setLocale(result)`.
*
@@ -621,28 +339,4 @@ export class Random {
return result;
}
-
- /**
- * Returns a hexadecimal number.
- *
- * @param count Length of the generated number. Defaults to `1`.
- *
- * @see faker.datatype.hexadecimal()
- *
- * @example
- * faker.random.hexaDecimal() // '0xb'
- * faker.random.hexaDecimal(10) // '0xaE13F044fb'
- *
- * @deprecated
- */
- hexaDecimal(count?: number): string {
- deprecated({
- deprecated: 'faker.random.hexaDecimal()',
- proposed: 'faker.datatype.hexadecimal()',
- // since: 'v5.0.0', (?)
- until: 'v7.0.0',
- });
-
- return this.faker.datatype.hexadecimal(count);
- }
}