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

• 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

• 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