aboutsummaryrefslogtreecommitdiff
path: root/src/time.ts
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2022-04-20 08:22:09 +0200
committerGitHub <[email protected]>2022-04-20 06:22:09 +0000
commitb99bbb5ee6d4b8c311afb00eaaa67c193ca0c4ef (patch)
tree7e7fa060fbf0d4971e92cea4c28299a9936d28e4 /src/time.ts
parent00b9d4be4bff3b3f64edf163768af71c99bceed1 (diff)
downloadfaker-b99bbb5ee6d4b8c311afb00eaaa67c193ca0c4ef.tar.xz
faker-b99bbb5ee6d4b8c311afb00eaaa67c193ca0c4ef.zip
docs: fix lost description texts (#836)
Diffstat (limited to 'src/time.ts')
-rw-r--r--src/time.ts4
1 files changed, 3 insertions, 1 deletions
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'