Class RomanNumbers

Utilities for converting numbers into Unicode Roman numerals.

Index

Constructors

Methods

convert convertString

Constructors

constructor

new RomanNumbers(): RomanNumbers
Returns RomanNumbers

Methods

`Static`convert

convert(input: number, style?: RomanNumbersStyle): string
Convert a numeric value to a Roman numeral string.
Parameters
- input: number
  Value between 0 and 3999 (inclusive) to convert.
- style: RomanNumbersStyle = RomanNumbersStyle.Alphabets
  Output styling to apply; defaults to ASCII letters.
Returns string
The Roman numeral representation of input in the desired style.

Throws
RomanNumbersError If the value is outside the supported range.
- Defined in src/RomanNumbers/RomanNumbers.ts:65

`Static`convertString

convertString(input: string, style?: RomanNumbersStyle): string
Parse a string and convert it to a Roman numeral string.
Parameters
- input: string
  String containing a base-10 integer representation.
- style: RomanNumbersStyle = RomanNumbersStyle.Alphabets
  Output styling to apply; defaults to ASCII letters.
Returns string
The Roman numeral representation of the parsed number.

Throws
RomanNumbersError If parsing fails or the value is unsupported.
- Defined in src/RomanNumbers/RomanNumbers.ts:117