import { T as ToolKey } from '../tool-DA175Utm.js';

/**
 * The value a {@link relativeTime} parameter takes: an amount and a time unit,
 * for example `{ value: -3, unit: "day" }`.
 */
type RelativeTime = {
    value: number;
    unit: Intl.RelativeTimeFormatUnit;
};
/**
 * Formats a relative time such as "3 days ago" or "in 2 hours" with
 * `Intl.RelativeTimeFormat`. The value bundles both inputs as `{ value, unit }`.
 *
 * @param name The template parameter name; its value is a {@link RelativeTime}.
 * @param options Passed to `Intl.RelativeTimeFormat`, e.g. `{ numeric: "auto" }`.
 *
 * @example ```ts
 * msg`Edited ${relativeTime("when")}`;
 * // { when: { value: -3, unit: "day" } } renders "Edited 3 days ago"
 * ```
 */
declare function relativeTime<const Name extends string>(name: Name, options?: Intl.RelativeTimeFormatOptions): ToolKey<Name, RelativeTime>;

export { type RelativeTime, relativeTime };