Class BaseConverter

constructor

• new BaseConverter(base, options?): BaseConverter

• The constructor of the BaseConverter class.

  Parameters

  • base: number

    The base number.

  • options: BaseConverterOptions = {}

    Optional parameters, for adjusting conversion rules.

  Returns BaseConverter

Readonly base

Readonly properties

decode

• decode(encodedValue): number

• Decode an encoded number.

  Parameters

  • encodedValue: NumeralOutput

    An encoded number as a NumeralOutput object in the instance base.

  Returns number

  The decoded number.

encode

• encode(numberValue, options?): NumeralOutput

• Encodes the specified number according to the instance base and properties.

  Parameters

  • numberValue: string | number | Decimal

    The number to encode, as a number, string or Decimal type.

  • Optional options: BaseConverterOptions

    The options to use as conversion rules.

  Returns NumeralOutput

  The encoded number as a NumeralOutput object.