@intility/bifrost-react/dist/hooks/useRelativeTime.d.ts

React library for Intility's design system, Bifrost.

export type RelativeTimeFormatterOptions = {
    /** Optional Intl.RelativeTimeFormatOptions object (overrides bifrost defaults) */
    options?: Intl.RelativeTimeFormatOptions;
    /** Optional Intl.LocalesArgument (overrides current bifrost locale, "en-us" or "nb-no") */
    locale?: Intl.LocalesArgument;
};
/**
 * Relative time formatter using locale and options from the current Bifrost
 * context (can be overridden).
 *
 * @param date - The date to format relative to now
 * @param options - Optional Configuration options
 * @param options.locale - Optional locale override (defaults to current Bifrost locale, e.g. "en-us" or "nb-no")
 * @param options.options - Optional Intl.RelativeTimeFormatOptions override (default `{ numeric: "auto", style: "long" }`)
 * @returns {string} A formatted relative time string (e.g. "5 minutes ago" or "in 2 hours")
 *
 * @see https://bifrost.intility.com/react/useRelativeTime
 *
 * @example
 * // e.g. "5 minutes ago" or "in 2 hours" depending on the date provided
 * const relativeTime = useRelativeTime(dateObjectOrISOString);
 */
export default function useRelativeTime(date: Date | string, { locale: localeOverride, options: optionsOverride, }?: RelativeTimeFormatterOptions | undefined): string;