Function split

  • split(
        cp: number,
        options?: {
            omit?: ("pp" | "gp" | "sp" | "cp")[];
            pad?: boolean;
            standard?: boolean;
        },
    ): Record<"pp" | "gp" | "sp" | "cp", number>

  • Split copper currency into multiple currencies favoring the one with highest rates.

    Parameters

    • cp: number

      Copper

    • Optionaloptions: { omit?: ("pp" | "gp" | "sp" | "cp")[]; pad?: boolean; standard?: boolean } = {}

      Additional options

      • Optionalomit?: ("pp" | "gp" | "sp" | "cp")[]

        Omit these types from the result. Baseline currency can not be omitted.

      • Optionalpad?: boolean

        Pad return value by including zeroed currencies

      • Optionalstandard?: boolean

        If true, no coinage of greater value than the pf1.config.currency.standard standard currency is included.

    Returns Record<"pp" | "gp" | "sp" | "cp", number>

    The various currencies.

Settings

Member Visibility