diff options
| author | ST-DDT <[email protected]> | 2022-04-20 08:22:09 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-04-20 06:22:09 +0000 |
| commit | b99bbb5ee6d4b8c311afb00eaaa67c193ca0c4ef (patch) | |
| tree | 7e7fa060fbf0d4971e92cea4c28299a9936d28e4 /src | |
| parent | 00b9d4be4bff3b3f64edf163768af71c99bceed1 (diff) | |
| download | faker-b99bbb5ee6d4b8c311afb00eaaa67c193ca0c4ef.tar.xz faker-b99bbb5ee6d4b8c311afb00eaaa67c193ca0c4ef.zip | |
docs: fix lost description texts (#836)
Diffstat (limited to 'src')
| -rw-r--r-- | src/internet.ts | 4 | ||||
| -rw-r--r-- | src/time.ts | 4 |
2 files changed, 5 insertions, 3 deletions
diff --git a/src/internet.ts b/src/internet.ts index fa4ae6e8..df830bca 100644 --- a/src/internet.ts +++ b/src/internet.ts @@ -47,7 +47,7 @@ export class Internet { * @param lastName The optional last name to use. If not specified, a random one will be chosen. * @param provider The mail provider domain to use. If not specified, a random free mail provider will be chosen. * @param options The options to use. Defaults to `{ allowSpecialCharacters: false }`. - * @param options.allowSpecialCharacters Whether special characters such as `.!#$%&'*+-/=?^_`{|}~` should be included + * @param options.allowSpecialCharacters Whether special characters such as ``.!#$%&'*+-/=?^_`{|}~`` should be included * in the email address. Defaults to `false`. * * @example @@ -90,7 +90,7 @@ export class Internet { * @param firstName The optional first name to use. If not specified, a random one will be chosen. * @param lastName The optional last name to use. If not specified, a random one will be chosen. * @param options The options to use. Defaults to `{ allowSpecialCharacters: false }`. - * @param options.allowSpecialCharacters Whether special characters such as `.!#$%&'*+-/=?^_`{|}~` should be included + * @param options.allowSpecialCharacters Whether special characters such as ``.!#$%&'*+-/=?^_`{|}~`` should be included * in the email address. Defaults to `false`. * * @example diff --git a/src/time.ts b/src/time.ts index 8eeaef42..c33638a7 100644 --- a/src/time.ts +++ b/src/time.ts @@ -10,13 +10,15 @@ export class Time { /** * Returns recent time. * - * @param format The format to use. Defaults to `'unix'`. + * @param format The format to use. * * - `'abbr'` Return a string with only the time. `Date.toLocaleTimeString`. * - `'date'` Return a date instance. * - `'wide'` Return a string with a long time. `Date.toTimeString()`. * - `'unix'` Returns a unix timestamp. * + * Defaults to `'unix'`. + * * @example * faker.time.recent() // 1643067231856 * faker.time.recent('abbr') // '12:34:07 AM' |