import type { FakeVehicle } from "../../types/index.js"; /** * Seeds the faker instance for reproducible output, or rolls a new random seed. * * The sequence depends on the seed, the number of calls made since it was set * and the faker major version — keep the call order stable for stable output. * * @param seed - Optional numeric seed. Omit it to generate a fresh random seed * (log the returned value and pass it back later to replay the exact run). * @returns The seed that was set. * * @example * ```ts * import { useFakeSeed, useFakeUuid } from "katanakit-js"; * * const seed = await useFakeSeed(); // random, but loggable/replayable * await useFakeSeed(seed); // replays the same sequence * await useFakeUuid(); * ``` */ export declare function useFakeSeed(seed?: number): Promise; /** * Pins the reference date faker uses for relative date helpers, so * date-dependent output stays reproducible next to {@link useFakeSeed}. * * @param refDate - 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 The reference date now in effect. * * @example * ```ts * 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 * ``` */ export declare function useFakeSetDefaultRefDate(refDate?: Date | number | string | (() => Date)): Promise; /** * Generates a v4 UUID. * * @returns A random UUID string. * * @example * ```ts * const id = await useFakeUuid(); * ``` */ export declare function useFakeUuid(): Promise; /** * Generates a fake email address. * * @returns An email address. */ export declare function useFakeEmail(): Promise; /** * Generates a fake full name. * * @returns A full name, e.g. `"Ada Lovelace"`. */ export declare function useFakeFullName(): Promise; /** * Generates a fake first name. * * @returns A first name. */ export declare function useFakeFirstName(): Promise; /** * Generates a fake last name. * * @returns A last name. */ export declare function useFakeLastName(): Promise; /** * Generates a fake phone number. * * @returns A phone number string. */ export declare function useFakePhone(): Promise; /** * Generates a fake company name. * * @returns A company name. */ export declare function useFakeCompanyName(): Promise; /** * Generates a fake URL. * * @returns An absolute URL. */ export declare function useFakeUrl(): Promise; /** * Generates lorem-ipsum text. * * @param words - Number of words (default: `12`). * @returns A space-separated string of words. */ export declare function useFakeText(words?: number): Promise; /** * Generates an integer within an inclusive range. * * @param min - Lower bound (default: `0`). * @param max - Upper bound (default: `100`). * @returns A random integer between `min` and `max`. * * @example * ```ts * const age = await useFakeNumber(18, 65); * ``` */ export declare function useFakeNumber(min?: number, max?: number): Promise; /** * Generates a random boolean. * * @returns `true` or `false`. */ export declare function useFakeBoolean(): Promise; /** * Generates a random date within an optional range. * * @param from - Lower bound (default: `1970-01-01`). * @param to - Upper bound (default: faker's reference date, see * {@link useFakeSetDefaultRefDate} — the current time when unset). * @returns A `Date` instance. * * @example * ```ts * const hiredAt = await useFakeDate(new Date("2020-01-01"), new Date("2025-12-31")); * ``` */ export declare function useFakeDate(from?: Date | number | string, to?: Date | number | string): Promise; /** * Generates a generic fake vehicle (brand, model, type, fuel, color, vin, plate). * * @returns A {@link FakeVehicle} object. * * @example * ```ts * const vehicle = await useFakeVehicle(); * // { brand: "Jeep", model: "Wrangler", plate: "HJ47FNP", ... } * ``` */ export declare function useFakeVehicle(): Promise; /** * Builds an array of fake items from a factory (sync or async). * * @typeParam T - Item type produced by the factory. * @param factory - Called once per item; receives the zero-based index. * @param count - Number of items to generate (non-negative integer). * @returns A promise resolving to the generated array. * * @example * ```ts * const vehicles = await useFakeList(() => useFakeVehicle(), 5); * const relations = await useFakeList((index) => ({ user: users[index % users.length] }), 10); * ``` */ export declare function useFakeList(factory: (index: number) => T | Promise, count: number): Promise; //# sourceMappingURL=faker.service.d.ts.map