unitz-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

The class which holds Rates mapped by their abbreviations.

Hierarchy

  • Rates

Index

Properties

Methods

Properties

Static registered

registered: RateMap

An object of rates mapped by their abbreviation.

see

Rates.add

Methods

Static add

  • add(unit: string, rate: string, names: string[]): void

  • Adds one or many rates given the unit, rate, and all abbreviations.

    Parameters

    • unit: string

      The unit.

    • rate: string

      The rate unit.

    • names: string[]

      The list of abbreviations for this rate.

    Returns void

Static addDefaults

  • addDefaults(): void

  • Adds all rates in the library to be available when parsing.

    Returns void

Static get

  • get(input: string): Rate

  • Gets the rate for the given input or undefined if none exists.

    Parameters

    • input: string

      The input to find a rate for.

    Returns Rate

    The rate mapped by the input, otherwise undefined.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc