nengo v3.0.0

Nengo

A library that converts Gregorian calendar dates into the traditional Japanese calendar years.

Installation

npm install nengo

Usage

Currently two functions are provided by nengo as shown below:

const { japaneseYear, gregorianYearRange } = require('nengo');

To convert the Gregorian date into the Japanese calendar, use the japaneseYear function. The output should be an object containing data related to the Japanese calendar year:

japaneseYear(new Date(2019, 5))

// {
//   "startYear": 2019,
//   "names": {
//     "kanji": "令和",
//     "hiragana": "れいわ",
//     "english": "Reiwa"
//   }
// }

You can also obtain the start and end year of a particular Japanese period in Gregorian calendar year format, using the gregorianYearRange function.

gregorianYearRange("平成");

// {
//   startYear: 1989,
//   endYear: 2018
// }

Tests

To run the test suite, run the command:

npm test

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/KevinAdu/nengo.

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using the following command:

npm run lint

License

The gem is available as open source under the terms of the MIT License.