aboutsummaryrefslogtreecommitdiff
path: root/src/time.ts
diff options
context:
space:
mode:
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'