chore: update jsdocs

faker-js · Apr 29, 2022 · 2567396 · 2567396
1 parent 3d7c307
commit 2567396
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -112,7 +112,8 @@ export interface Transaction {
 }
 
 /**
- * Module with various helper methods that don't fit in a particular category.
+ * Module with various helper methods that transform the method input rather than returning values from locales.
+ * The transformation process may call methods that use the locale data.
  */
 export class Helpers {
   constructor(private readonly faker: Faker) {

diff --git a/src/random.ts b/src/random.ts
@@ -168,7 +168,7 @@ export class Random {
    * @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.random.objectKey()
+   * @see faker.helpers.objectKey()
    *
    * @example
    * const object = { keyA: 'valueA', keyB: 42 };
@@ -188,7 +188,7 @@ export class Random {
    * @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.random.objectValue()
+   * @see faker.helpers.objectValue()
    *
    * @example
    * const object = { keyA: 'valueA', keyB: 42 };
@@ -211,8 +211,8 @@ export class Random {
    * If this is set to `'value'`, this method will a return a random value of the given instance.
    * Defaults to `'value'`.
    *
-   * @see faker.random.objectKey()
-   * @see faker.random.objectValue()
+   * @see faker.helpers.objectKey()
+   * @see faker.helpers.objectValue()
    *
    * @example
    * const object = { keyA: 'valueA', keyB: 42 };
@@ -236,8 +236,8 @@ export class Random {
    * If this is set to `'value'`, this method will a return a random value of the given instance.
    * Defaults to `'value'`.
    *
-   * @see faker.random.objectKey()
-   * @see faker.random.objectValue()
+   * @see faker.helpers.objectKey()
+   * @see faker.helpers.objectValue()
    *
    * @example
    * const object = { keyA: 'valueA', keyB: 42 };