Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

roman-numeral

Spendar892.1kMIT0.2.6

roman numeral converter

roman-numeral, roman, romans, numbers, numeral, converter, Spendar89

readme

Roman Numeral

Simple number to roman numeral converter. Works in both Node and browser environments. Zero external dependencies.

Installation

To install:

npm install --save roman-numeral

Getting Started

To use:

require('roman-numeral').convert(2016); // >> "MMXVI"

Default Conversion Mapping:

{
  "M": 1000 ,
  "CM": 900,
  "D": 500,
  "C": 100,
  "LX": 60,
  "L": 50,
  "XL": 40,
  "X": 10,
  "IX": 9,
  "V": 5,
  "IV": 4,
  "I": 1 
}

Override default by calling romanNumeral.convert with optional mapping argument:

var custom = {
  "Y": 2015,
  "O": 1
};

require("roman-numeral").convert(2016, custom); // >> "YO"

License

MIT