chinese-calendar-indexer

1.0.13 • Public • Published

chinese lunar calendar indexer 中國農曆黃曆查詢器

install:

npm install chinese-calendar-indexer

demo code:

const CalendarIndexer = require('chinese-calendar-indexer');
const moment = require('moment-timezone');


const timeZone = 'Asia/Shanghai';


(async () => {

	try {

		let calendarIndexer = new CalendarIndexer();
		let curDate = moment.tz(moment().clone().tz(timeZone), timeZone)
		let lunarData = await calendarIndexer.indexChineseLunar(curDate);
		console.log(lunarData);

	} catch(e) {
		console.log(e);
	}

})();  //end top async()

output is:

{
  year: 2020,
  month: 10,
  day: 28,
  lunarMonth: '九月',
  lunarMonthDigit: 9,
  lunarDay: '十二',
  lunarDayDigit: 12,
  isLunarLeapMonth: false,
  chineseYear: '庚子',
  chineseMonth: '丙戌',
  chineseDay: '甲辰',
  chineseTerm: '霜降',
  chineseTermOffset: 5
}

if it doesn't find calendar data, the result is:

{
  year: 1000,
  month: 1,
  day: 1,
  lunarMonth: '',
  lunarMonthDigit: 0,
  lunarDay: '',
  lunarDayDigit: 0,
  isLunarLeapMonth: false,
  chineseYear: '',
  chineseMonth: '',
  chineseDay: '',
  chineseTerm: '',
  chineseTermOffset: ''
}

Package Sidebar

Install

npm i chinese-calendar-indexer

Weekly Downloads

0

Version

1.0.13

License

MIT

Unpacked Size

501 kB

Total Files

5

Last publish

Collaborators

  • creatxr