react-intlayer/dist/types/client/format/useUnit.d.ts

Easily internationalize i18n your React applications with type-safe multilingual content management.

import * as _intlayer_types11 from "@intlayer/types";

//#region src/client/format/useUnit.d.ts

/**
 * React hook that provides a unit formatting function
 * based on the current locale from {@link useLocaleBase}.
 *
 * This hook wraps {@link createUnit} to return a formatter
 * that can convert values into human-readable localized units
 * (e.g., "10 km", "5 lbs").
 *
 * @example
 * ```tsx
 * const formatUnit = useUnit();
 * const distance = formatUnit(10, { unit: "kilometer" });
 * // "10 km" (depending on locale)
 * ```
 *
 * @returns {Function} A unit formatting function that accepts a value and optional formatting options.
 */
declare const useUnit: () => (value: string | number, options?: Intl.NumberFormatOptions & {
  locale?: _intlayer_types11.LocalesValues;
}) => string;
//#endregion
export { useUnit };
//# sourceMappingURL=useUnit.d.ts.map