formatNumber — @gj-kit/format

A public function from @gj-kit/format. The signature below is taken directly from the 0.1.1 release declaration.

Verified import example

import { formatNumber } from '@gj-kit/format';

Signature, parameters, and return type

/**
 * Locale-grouped plain number (`12,345`). Deliberately NOT a passthrough to
 * Intl's own option bag — only Hermes-safe options are accepted.
 *
 * A locale the runtime's Intl rejects throws `FormatError('ERR_LOCALE_INVALID')`
 * and out-of-range fraction digits throw `FormatError('ERR_FRACTION_DIGITS_INVALID')`
 * — configuration errors, never data errors (§1-3).
 */
declare function formatNumber<TFallback = string>(value: number | null | undefined, options: FormatNumberOptions<TFallback>): string | TFallback;

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

Release context

• Package: @gj-kit/format
• Version: 0.1.1
• Public entry: .
• Source: GitHub