polish-number-to-words/dist/cjs/pluralize.d.ts

Spell numbers using words in Polish | Napisz liczbę słownie po polsku

/**
 * Pluralizes a number in Polish.
 * @param num A number (e.g., 1, 2, 5, -3)
 * @param singular Form for 1 (e.g., "kot")
 * @param plural234 Form for 2–4 (e.g., "koty")
 * @param plural5 Form for 5 and others (e.g., "kotów")
 * @throws Throws an error if a non-integer value is passed in. Specify a fraction word to be able to pass in fractional numbers.
 * @returns Correct word form.
 */
export declare function pluralizePl(num: number, singular: string, plural234: string, plural5: string): string;
/**
 * Pluralizes a number in Polish, with support for non-string values.
 * @param num A number (e.g., 1, 2, 5, -3)
 * @param singular Value to use for 1 (e.g., "kot")
 * @param plural234 Value to use for 2–4 (e.g., "koty")
 * @param plural5 Value to use for 5 and others (e.g., "kotów")
 * @throws Throws an error if a non-integer value is passed in. Specify a fraction value to be able to pass in fractional numbers.
 * @returns Correct value based on the number.
 */
export declare function pluralizePl<T>(num: number, singular: T, plural234: T, plural5: T): T;
/**
 * Pluralizes a number in Polish with support for fractions.
 * @param num A number (e.g., 1, 2, 5, -3, 2.25)
 * @param singular Form for 1 (e.g., "kot")
 * @param plural234 Form for 2–4 (e.g., "koty")
 * @param plural5 Form for 5 and others (e.g., "kotów")
 * @param fractionForm Form for fractional values (e.g., "kota")
 * @returns Correct word form.
 */
export declare function pluralizePl(num: number, singular: string, plural234: string, plural5: string, fractionForm: string): string;
/**
 * Pluralizes a number in Polish with support for fractions, and with support for non-string values.
 * @param num A number (e.g., 1, 2, 5, -3, 2.25)
 * @param singular Value to use for 1 (e.g., "kot")
 * @param plural234 Value to use for 2–4 (e.g., "koty")
 * @param plural5 Value to use for 5 and others (e.g., "kotów")
 * @param fractionForm Value to use for fractional values (e.g., "kota")
 * @returns Correct value based on the number.
 */
export declare function pluralizePl<T>(num: number, singular: T, plural234: T, plural5: T, fractionForm: T): T;
export declare class PluralizerPL {
    readonly singular: string;
    readonly plural234: string;
    readonly plural5: string;
    constructor(singular: string, plural234: string, plural5: string);
    pluralize(num: number): string;
    toString(): string;
}