aboutsummaryrefslogtreecommitdiff
path: root/src/time.ts
diff options
context:
space:
mode:
authorShinigami <[email protected]>2022-05-03 15:48:20 +0200
committerGitHub <[email protected]>2022-05-03 15:48:20 +0200
commita2da7c496e9a3741d165ddfe6128b50837fec361 (patch)
tree88d371bc19487bc8a34d9043035aed8e4fedd7d5 /src/time.ts
parentcc46a0c19af2752b6210c24b715fcce20197b6d9 (diff)
downloadfaker-a2da7c496e9a3741d165ddfe6128b50837fec361.tar.xz
faker-a2da7c496e9a3741d165ddfe6128b50837fec361.zip
refactor!: reorganize src folder (#909)
Diffstat (limited to 'src/time.ts')
-rw-r--r--src/time.ts57
1 files changed, 0 insertions, 57 deletions
diff --git a/src/time.ts b/src/time.ts
deleted file mode 100644
index c33638a7..00000000
--- a/src/time.ts
+++ /dev/null
@@ -1,57 +0,0 @@
-import type { LiteralUnion } from './faker';
-import { deprecated } from './internal/deprecated';
-
-/**
- * Module to generate time of dates in various formats.
- *
- * @deprecated You should stop using this module, as it will be removed in the future.
- */
-export class Time {
- /**
- * Returns recent time.
- *
- * @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'
- * faker.time.recent('date') // 2022-03-01T20:35:47.402Z
- * faker.time.recent('wide') // '00:34:11 GMT+0100 (Central European Standard Time)'
- * faker.time.recent('unix') // 1643067231856
- *
- * @deprecated You should stop using this function, as it will be removed in the future. Use the native `new Date()` with one of the wanted functions directly.
- */
- recent(
- format: LiteralUnion<'abbr' | 'date' | 'wide' | 'unix'> = 'unix'
- ): string | number | Date {
- deprecated({
- deprecated: 'faker.time.recent()',
- proposed: 'native `new Date()` and call the function you want on it',
- since: 'v6.1.0',
- until: 'v7.0.0',
- });
-
- let date: string | number | Date = new Date();
-
- switch (format) {
- case 'abbr':
- date = date.toLocaleTimeString();
- break;
- case 'wide':
- date = date.toTimeString();
- break;
- case 'unix':
- date = date.getTime();
- break;
- }
-
- return date;
- }
-}