@formatjs/intl-pluralrules 6.2.4 → 6.3.2

package/index.d.ts

@@ -1,4 +1,49 @@
-import { type LDMLPluralRule, type NumberFormatDigitInternalSlots, type PluralRulesData, type PluralRulesLocaleData } from "@formatjs/ecma402-abstract";
+import { Decimal as Decimal$1 } from "@formatjs/bigdecimal";
+
+//#region packages/ecma402-abstract/types/core.d.ts
+type Locale = string;
+interface LocaleData<T> {
+  data: T;
+  locale: Locale;
+}
+//#endregion
+//#region packages/ecma402-abstract/types/plural-rules.d.ts
+type LDMLPluralRule = "zero" | "one" | "two" | "few" | "many" | "other";
+interface PluralRangesData {
+  cardinal?: Record<string, LDMLPluralRule>;
+  ordinal?: Record<string, LDMLPluralRule>;
+}
+interface PluralRulesData {
+  categories: {
+    cardinal: string[];
+    ordinal: string[];
+  };
+  fn: (val: number | string, ord?: boolean, exponent?: number) => LDMLPluralRule;
+  pluralRanges?: PluralRangesData;
+}
+type PluralRulesLocaleData = LocaleData<PluralRulesData>;
+//#endregion
+//#region packages/ecma402-abstract/types/number.d.ts
+type NumberFormatNotation = "standard" | "scientific" | "engineering" | "compact";
+type RoundingPriorityType = "auto" | "morePrecision" | "lessPrecision";
+type NumberFormatRoundingType = "morePrecision" | "lessPrecision" | "significantDigits" | "fractionDigits";
+type RoundingModeType = "ceil" | "floor" | "expand" | "trunc" | "halfCeil" | "halfFloor" | "halfExpand" | "halfTrunc" | "halfEven";
+interface NumberFormatDigitInternalSlots {
+  minimumIntegerDigits: number;
+  minimumSignificantDigits: number;
+  maximumSignificantDigits: number;
+  roundingType: NumberFormatRoundingType;
+  minimumFractionDigits: number;
+  maximumFractionDigits: number;
+  notation: NumberFormatNotation;
+  roundingIncrement: number;
+  roundingMode: RoundingModeType;
+  trailingZeroDisplay: TrailingZeroDisplay;
+  roundingPriority: RoundingPriorityType;
+}
+type TrailingZeroDisplay = "auto" | "stripIfInteger";
+//#endregion
+//#region packages/intl-pluralrules/index.d.ts
 /**
 * Type augmentation for Intl.PluralRules
 *
@@ -9,70 +54,73 @@ import { type LDMLPluralRule, type NumberFormatDigitInternalSlots, type PluralRu
 * Mirrors Intl.NumberFormat notation option for proper plural selection with compact numbers
 */
 declare global {
-	namespace Intl {
-		interface PluralRules {
-			selectRange(start: number | bigint, end: number | bigint): LDMLPluralRule;
-		}
-		interface PluralRulesOptions {
-			notation?: "standard" | "compact";
-			compactDisplay?: "short" | "long";
-		}
-	}
+  namespace Intl {
+    interface PluralRules {
+      selectRange(start: number | bigint, end: number | bigint): LDMLPluralRule;
+    }
+    interface PluralRulesOptions {
+      notation?: "standard" | "compact";
+      compactDisplay?: "short" | "long";
+    }
+  }
 }
-export interface PluralRulesInternal extends NumberFormatDigitInternalSlots {
-	initializedPluralRules: boolean;
-	locale: string;
-	type: "cardinal" | "ordinal";
-	notation: "standard" | "compact";
-	compactDisplay?: "short" | "long";
-	dataLocaleData?: any;
+interface PluralRulesInternal extends NumberFormatDigitInternalSlots {
+  initializedPluralRules: boolean;
+  locale: string;
+  type: "cardinal" | "ordinal";
+  notation: "standard" | "compact";
+  compactDisplay?: "short" | "long";
+  dataLocaleData?: any;
 }
-export declare class PluralRules {
-	constructor(locales?: string | string[], options?: Intl.PluralRulesOptions);
-	resolvedOptions(): Intl.ResolvedPluralRulesOptions;
-	select(val: number | bigint): LDMLPluralRule;
-	/**
-	* Intl.PluralRules.prototype.selectRange ( start, end )
-	*
-	* Returns a string indicating which plural rule applies to a range of numbers.
-	* This is useful for formatting ranges like "1-2 items" vs "2-3 items" where
-	* different languages have different plural rules for ranges.
-	*
-	* Specification: https://tc39.es/ecma402/#sec-intl.pluralrules.prototype.selectrange
-	*
-	* @param start - The start value of the range (number or bigint)
-	* @param end - The end value of the range (number or bigint)
-	* @returns The plural category for the range (zero, one, two, few, many, or other)
-	*
-	* @example
-	* const pr = new Intl.PluralRules('en');
-	* pr.selectRange(1, 2); // "other" (English: "1-2 items")
-	* pr.selectRange(1, 1); // "one" (same value: "1 item")
-	*
-	* @example
-	* const prFr = new Intl.PluralRules('fr');
-	* prFr.selectRange(0, 1); // "one" (French: "0-1 vue")
-	* prFr.selectRange(1, 2); // "other" (French: "1-2 vues")
-	*
-	* @example
-	* // BigInt support (spec-compliant, but Chrome has a bug as of early 2025)
-	* pr.selectRange(BigInt(1), BigInt(2)); // "other"
-	*
-	* @throws {TypeError} If start or end is undefined
-	* @throws {RangeError} If start or end is not a finite number (Infinity, NaN)
-	*
-	* @note Chrome's native implementation (as of early 2025) has a bug where it throws
-	* "Cannot convert a BigInt value to a number" when using BigInt arguments. This is
-	* a browser bug - the spec requires BigInt support. This polyfill handles BigInt correctly.
-	*/
-	selectRange(start: number | bigint, end: number | bigint): LDMLPluralRule;
-	toString(): string;
-	static supportedLocalesOf(locales?: string | string[], options?: Pick<Intl.PluralRulesOptions, "localeMatcher">): string[];
-	static __addLocaleData(...data: PluralRulesLocaleData[]): void;
-	static localeData: Record<string, PluralRulesData>;
-	static availableLocales: Set<string>;
-	static __defaultLocale: string;
-	static getDefaultLocale(): string;
-	static relevantExtensionKeys: never[];
-	static polyfilled: boolean;
+declare class PluralRules {
+  constructor(locales?: string | string[], options?: Intl.PluralRulesOptions);
+  resolvedOptions(): Intl.ResolvedPluralRulesOptions;
+  select(val: number | bigint): LDMLPluralRule;
+  /**
+  * Intl.PluralRules.prototype.selectRange ( start, end )
+  *
+  * Returns a string indicating which plural rule applies to a range of numbers.
+  * This is useful for formatting ranges like "1-2 items" vs "2-3 items" where
+  * different languages have different plural rules for ranges.
+  *
+  * Specification: https://tc39.es/ecma402/#sec-intl.pluralrules.prototype.selectrange
+  *
+  * @param start - The start value of the range (number or bigint)
+  * @param end - The end value of the range (number or bigint)
+  * @returns The plural category for the range (zero, one, two, few, many, or other)
+  *
+  * @example
+  * const pr = new Intl.PluralRules('en');
+  * pr.selectRange(1, 2); // "other" (English: "1-2 items")
+  * pr.selectRange(1, 1); // "one" (same value: "1 item")
+  *
+  * @example
+  * const prFr = new Intl.PluralRules('fr');
+  * prFr.selectRange(0, 1); // "one" (French: "0-1 vue")
+  * prFr.selectRange(1, 2); // "other" (French: "1-2 vues")
+  *
+  * @example
+  * // BigInt support (spec-compliant, but Chrome has a bug as of early 2025)
+  * pr.selectRange(BigInt(1), BigInt(2)); // "other"
+  *
+  * @throws {TypeError} If start or end is undefined
+  * @throws {RangeError} If start or end is not a finite number (Infinity, NaN)
+  *
+  * @note Chrome's native implementation (as of early 2025) has a bug where it throws
+  * "Cannot convert a BigInt value to a number" when using BigInt arguments. This is
+  * a browser bug - the spec requires BigInt support. This polyfill handles BigInt correctly.
+  */
+  selectRange(start: number | bigint, end: number | bigint): LDMLPluralRule;
+  toString(): string;
+  static supportedLocalesOf(locales?: string | string[], options?: Pick<Intl.PluralRulesOptions, "localeMatcher">): string[];
+  static __addLocaleData(...data: PluralRulesLocaleData[]): void;
+  static localeData: Record<string, PluralRulesData>;
+  static availableLocales: Set<string>;
+  static __defaultLocale: string;
+  static getDefaultLocale(): string;
+  static relevantExtensionKeys: never[];
+  static polyfilled: boolean;
 }
+//#endregion
+export { PluralRules, PluralRulesInternal };
+//# sourceMappingURL=index.d.ts.map