diff options
| author | ST-DDT <[email protected]> | 2023-04-17 10:13:48 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-04-17 08:13:48 +0000 |
| commit | 62b1aed46b108b08b25fcedf8d2606870cffb233 (patch) | |
| tree | 8626a5101dfb7a63752397f8e02d914ed1c5c225 /src/faker.ts | |
| parent | 153e0ca29742c42814a97117f7d976f23e93c0d4 (diff) | |
| download | faker-62b1aed46b108b08b25fcedf8d2606870cffb233.tar.xz faker-62b1aed46b108b08b25fcedf8d2606870cffb233.zip | |
chore: consistent jsdocs tag formatting (#2056)
Diffstat (limited to 'src/faker.ts')
| -rw-r--r-- | src/faker.ts | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/faker.ts b/src/faker.ts index 3d93009e..a694fcc2 100644 --- a/src/faker.ts +++ b/src/faker.ts @@ -46,7 +46,6 @@ import { mergeLocales } from './utils/merge-locales'; * * faker.person.firstName(); // 'John' * faker.person.lastName(); // 'Doe' - * * @example * import { Faker, es } from '@faker-js/faker'; * // const { Faker, es } = require('@faker-js/faker'); @@ -347,6 +346,7 @@ export class Faker { * by logging the result and explicitly setting it if needed. * * @param seed The seed to use. Defaults to a random number. + * * @returns The seed that was set. * * @see [Reproducible Results](https://next.fakerjs.dev/guide/usage.html#reproducible-results) @@ -381,6 +381,7 @@ export class Faker { * by logging the result and explicitly setting it if needed. * * @param seedArray The seed array to use. + * * @returns The seed array that was set. * * @see [Reproducible Results](https://next.fakerjs.dev/guide/usage.html#reproducible-results) @@ -415,6 +416,7 @@ export class Faker { * by logging the result and explicitly setting it if needed. * * @param seed The seed or seed array to use. + * * @returns The seed that was set. * * @see [Reproducible Results](https://next.fakerjs.dev/guide/usage.html#reproducible-results) |
