Variable formats

Type declaration

• alphabet: {
      config: {
          alphabet: string;
      };
      format(ex: DecimalSource, acc?: number, max?: number, type?: FormatType, start?: DecimalSource, startDouble?: boolean, abbStart?: number): string;
      getAbbreviation(ex: DecimalSource, start?: DecimalSource, startDouble?: boolean, abbStart?: number): string;
  }

  Alphabet format

  • config: {
        alphabet: string;
    }

    • alphabet: string

  • format:function

    • format(ex, acc?, max?, type?, start?, startDouble?, abbStart?): string

    • Format the value into alphabet format (a, b, c, ..., z, aa, ab, ac, ... aaa, aab, ... aaaa, ... aaaaaaaaaaaaaaa, ... aaaaaaaaaaaaaaa(2), aaaaaaaaaaaaaaa(3), ...) Basically base 26 for the exponential part / 3 Work in progress

      Parameters

      • ex: DecimalSource

        The value to format
      • acc: number = 2

        The accuracy
      • max: number = 9

        The maximum value before switching to an abbreviation
      • type: FormatType = "mixed_sc"

        The type of format to use
      • start: DecimalSource = ...

        The starting value. Defaults to 1e15, or 1 quadrillion.
      • startDouble: boolean = false

        Whether to start at aa instead of a. Defaults to false.
      • OptionalabbStart: number

        The starting value for abbreviations. Defaults to 9.

      Returns string

      • The formatted value

  • getAbbreviation:function

    • getAbbreviation(ex, start?, startDouble?, abbStart?): string

    • Get the abbreviation for a number

      Parameters

      • ex: DecimalSource

        The value to get the abbreviation for
      • start: DecimalSource = ...

        The starting value
      • startDouble: boolean = false

        Whether to start at aa instead of a
      • abbStart: number = 9

        The starting value for abbreviations

      Returns string

      • The abbreviation

• elemental: {
      config: {
          element_lists: string[][];
      };
      abbreviationLength(group: number): number;
      beyondOg(x: number): string;
      format(value: Decimal, acc?: number): string;
      formatElementalPart(abbreviation: string, n: Decimal): string;
      getAbbreviation(group: number, progress: number): string;
      getAbbreviationAndValue(x: Decimal): [string, Decimal];
      getOffset(group: number): number;
  }

  • config: {
        element_lists: string[][];
    }

    • element_lists: string[][]

      The list of elements

  • abbreviationLength:function

    • abbreviationLength(group): number

    • Parameters

      • group: number

      Returns number

  • beyondOg:function

    • beyondOg(x): string

    • Parameters

      • x: number

      Returns string

  • format:function

    • format(value, acc?): string

    • Parameters

      • value: Decimal
      • acc: number = 2

      Returns string

  • formatElementalPart:function

    • formatElementalPart(abbreviation, n): string

    • Parameters

      • abbreviation: string
      • n: Decimal

      Returns string

  • getAbbreviation:function

    • getAbbreviation(group, progress): string

    • Parameters

      • group: number
      • progress: number

      Returns string

  • getAbbreviationAndValue:function

    • getAbbreviationAndValue(x): [string, Decimal]

    • Parameters

      • x: Decimal

      Returns [string, Decimal]

  • getOffset:function

    • getOffset(group): number

    • Parameters

      • group: number

      Returns number

• eng: {
      format(ex: DecimalSource, acc?: number): string;
  }

  Engineering format

  • format:function

    • format(ex, acc?): string

    • Format the value into engineering format

      Parameters

      • ex: DecimalSource

        The value to format
      • acc: number = 2

        The accuracy

      Returns string

      • The formatted value

      Example

      console.log(FORMATS.eng.format(1e20, 2)); // 100.00e18
      Copy

• ev: ((num: DecimalSource, c2?: boolean) => string)

  • • (num, c2?): string

    • Format the value into eV (includes metric prefixes)

      Parameters

      • num: DecimalSource

        The value to format
      • c2: boolean = false

        Whether to include /c^2

      Returns string

      The formatted value

      Deprecated

      Use metric instead

• expMult: ((a: DecimalSource, b: DecimalSource, base?: number) => Decimal)

  • • (a, b, base?): Decimal

    • Exponential multiplier

      Parameters

      • a: DecimalSource

        The value to exponentiate
      • b: DecimalSource

        The exponent
      • base: number = 10

        The base

      Returns Decimal

      • The value after being exponentiated

• format: ((ex: DecimalSource, acc?: number, max?: number, type?: FormatType) => string)

  • • (ex, acc?, max?, type?): string

    • Format the value into a specific format type

      Parameters

      • ex: DecimalSource

        The value to format
      • acc: number = 2

        The desired accuracy (number of significant figures), defaults to 2.
      • max: number = 9

        The maximum number of decimal places to display, defaults to 9.
      • type: FormatType = "mixed_sc"

        The type of format to use (default "mixed_sc")

      Returns string

      • The formatted value

• formatGain: ((amt: DecimalSource, gain: DecimalSource, type?: FormatType, acc?: number, max?: number) => string)

  • • (amt, gain, type?, acc?, max?): string

    • Format the gain

      Parameters

      • amt: DecimalSource

        The amount
      • gain: DecimalSource

        The gain
      • type: FormatType = "mixed_sc"

        The type
      • Optionalacc: number

        The accuracy
      • Optionalmax: number

        The maximum value

      Returns string

      • The formatted gain

      Example

      console.log(formatGain(1e20, 1e10)); // (+1.00e10/sec)
      console.log(formatGain(1e200, 1e210)); // (+10.00 OoMs/sec)
      Copy

• formatMult: ((ex: DecimalSource, acc?: number) => string)

  • • (ex, acc?): string

    • Format the multiplier

      Parameters

      • ex: DecimalSource

        The value to format
      • acc: number = 2

        The accuracy

      Returns string

      • The formatted multiplier

• formatPercent: ((ex: DecimalSource) => string)

  • • (ex): string

    • Format the percent

      Parameters

      • ex: DecimalSource

        The value to format

      Returns string

      • The formatted percent

• formatReduction: ((ex: DecimalSource) => string)

  • • (ex): string

    • Format the reduction

      Parameters

      • ex: DecimalSource

        The value to format

      Returns string

      • The formatted reduction

• formatST: ((ex: DecimalSource, acc?: number, max?: number, type?: FormatType) => string)

  • • (ex, acc?, max?, type?): string

    • Format the value into standard (letter abbv) format

      Parameters

      • ex: DecimalSource
      • acc: number = 2
      • max: number = 9
      • type: FormatType = "st"

      Returns string

      Deprecated

      Use format instead (with the type "st")

• formatTime: ((ex: DecimalSource, acc?: number, type?: string) => string)

  • • (ex, acc?, type?): string

    • Format the time

      Parameters

      • ex: DecimalSource

        The value to format (in seconds)
      • acc: number = 2

        The accuracy
      • type: string = "s"

        The type

      Returns string

      • The formatted time

• formatTimeLong: ((ex: DecimalSource, ms?: boolean, acc?: number, max?: number, type?: FormatType) => string)

  • • (ex, ms?, acc?, max?, type?): string

    • Format the time long

      Parameters

      • ex: DecimalSource

        The value to format (in seconds)
      • ms: boolean = false

        Whether to include milliseconds
      • acc: number = 0

        The accuracy
      • max: number = 9

        The maximum value
      • type: FormatType = "mixed_sc"

        The type

      Returns string

      • The formatted time

• inf: {
      format(ex: DecimalSource, acc?: number, max?: number): string;
  }

  Infinity format

  • format:function

    • format(ex, acc?, max?): string

    • Parameters

      • ex: DecimalSource
      • Optionalacc: number
      • Optionalmax: number

      Returns string

• layer: {
      layers: string[];
      format(ex: DecimalSource, acc?: number, max?: number): string;
  }

  Layer format

  • layers: string[]

  • format:function

    • format(ex, acc?, max?): string

    • Parameters

      • ex: DecimalSource
      • acc: number = 2
      • Optionalmax: number

      Returns string

• metric: ((num: DecimalSource, type?:
      | 0
      | 1
      | 2
      | 3) => string)

  • • (num, type?): string

    • Converts a number to a metric representation based on the specified type.

      Parameters

      • num: DecimalSource

        The number to convert.
      • type:
            | 0
            | 1
            | 2
            | 3 = 0

        The type of metric representation to return.

        • 0: Returns the number with the metric abbreviation (e.g., "1.23 K").
        • 1: Returns only the metric abbreviation (e.g., "K").
        • 2: Returns the number divided by the metric value (e.g., "1.23").
        • 3: Returns the alternative name of the metric abbreviation (e.g., "Kilo").

      Returns string

      The metric representation of the number. If the number is greater than the highest metric value, the function returns the highest metric abbreviation.

      Example

      metric(1234, 0); // Returns "1.23 K"
      metric(1234, 1); // Returns "K"
      metric(1234, 2); // Returns "1.23"
      metric(1234, 3); // Returns "Kilo"
      Copy

• mixed_sc: {
      format(ex: DecimalSource, acc?: number, max?: number): string;
  }

  Mixed scientific format

  • format:function

    • format(ex, acc?, max?): string

    • Format the value into mixed scientific format (standard or scientific depending on the value)

      Parameters

      • ex: DecimalSource

        The value to format
      • Optionalacc: number

        The accuracy
      • max: number = 9

        The maximum value

      Returns string

      • The formatted value

      Example

      console.log(FORMATS.mixed_sc.format(1e20, 2, 9)); // 100.00 Qt
      console.log(FORMATS.mixed_sc.format(1e400, 2, 303)); // 1.00e400
      Copy

• old_sc: {
      format(ex: DecimalSource, acc: number): string;
  }

  Old scientific format

  • format:function

    • format(ex, acc): string

    • Format the value into old scientific format

      Parameters

      • ex: DecimalSource

        The value to format
      • acc: number

        The accuracy

      Returns string

      • The formatted value

• omega: {
      config: {
          greek: string;
          infinity: string;
      };
      format(value: DecimalSource): string;
  }

  Omega format

  • config: {
        greek: string;
        infinity: string;
    }

    • greek: string

    • infinity: string

  • format:function

    • format(value): string

    • Format the value into omega format

      Parameters

      • value: DecimalSource

        The value to format

      Returns string

      • The formatted value

• omega_short: {
      config: {
          greek: string;
          infinity: string;
      };
      format(value: DecimalSource): string;
  }

  Short omega format

  • config: {
        greek: string;
        infinity: string;
    }

    • greek: string

    • infinity: string

  • format:function

    • format(value): string

    • Format the value into short omega format

      Parameters

      • value: DecimalSource

        The value to format

      Returns string

      • The formatted value

• standard: {
      tier1(x: number): string;
      tier2(x: number): string;
  }

  Standard (letter abbv) format

  • tier1:function

    • tier1(x): string

    • Gets the letter abbreviation for a number (e.g. 1 -> K) (0-1e3000)

      Parameters

      • x: number

        The number to get the letter abbreviation for

      Returns string

      • The letter abbreviation

  • tier2:function

    • tier2(x): string

    • Gets the tier 2 letter abbreviation for a number (e.g. 1 -> Mi) (1e3000+)

      Parameters

      • x: number

        The number to get the letter abbreviation for

      Returns string

      • The letter abbreviation

• toSubscript: ((value: number) => string)

  • • (value): string

    • Convert a number to a subscript

      Parameters

      • value: number

        The value to convert

      Returns string

      • The value in subscript

• toSuperscript: ((value: number) => string)

  • • (value): string

    • Convert a number to a superscript

      Parameters

      • value: number

        The value to convert

      Returns string

      • The value in superscript