katanakit-js / useFakeDate

Function: useFakeDate()

function useFakeDate(from?, to?): Promise<Date>;

Defined in: src/core/services/faker.service.ts:217

Generates a random date within an optional range.

Parameters

Parameter	Type	Description
from?	string | number | Date	Lower bound (default: 1970-01-01).
to?	string | number | Date	Upper bound (default: faker's reference date, see useFakeSetDefaultRefDate — the current time when unset).

Returns

Promise<Date>

A Date instance.

Example

const hiredAt = await useFakeDate(new Date("2020-01-01"), new Date("2025-12-31"));