katanakit-js / useFakeSetDefaultRefDate

Function: useFakeSetDefaultRefDate()

function useFakeSetDefaultRefDate(refDate?): Promise<Date>;

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

Pins the reference date faker uses for relative date helpers, so date-dependent output stays reproducible next to useFakeSeed.

Parameters

Parameter	Type	Description
refDate?	string | number | Date | (() => Date)	Static date (Date, ISO string or epoch ms) or a factory returning a fresh Date on every call. Omit it to reset to the current time.

Returns

Promise<Date>

The reference date now in effect.

Example

import { useFakeSeed, useFakeSetDefaultRefDate, useFakeDate } from "katanakit-js";

await useFakeSeed(42);
await useFakeSetDefaultRefDate("2026-01-01");
await useFakeDate(); // reproducible between 1970-01-01 and 2026-01-01