Skip to content

bastengao/chinese-holidays-node

Repository files navigation

chinese-holidays

提供具有中国特色的休假安排或者工作日查询。

Install

npm install chinese-holidays

Usage

支持在线更新数据和本地离线数据两种方式。

var ChineseHolidays = require('chinese-holidays');

ChineseHolidays.ready().then(function(book, err){
  if err != null {
    return
  }

  元旦 = new Date(2016, 0, 1)
  // 是否休假(含正常的周六、周日)
  book.isHoliday(元旦)
  // true

  // 是否是工作日(含节假日的调休)
  book.isWorkingday(元旦)
  // fase


  // 列出已知的节假日
  book.all().forEach(function(holiday){
    console.log(holiday.name)
    console.log(holiday.days().map(function(date) { return moment(date).format('YYYY-MM-DD') }))
  })
  // 元旦
  // ["2016-01-01", "2016-01-02", "2016-01-03"]
  // ...

  // 列出所有的特殊日子(节假日和调休)
  book.events().forEach(function(event){
    console.log(event.name, event.days(), event.isHoliday(), event.isWorkingday())
  })
})


// disable update from remote, default is false.
const options = {
  offline: true
};
ChineseHolidays.ready(options)

Documentation

API documentation

Support

支持在线更新节假日数据,如果无法联网则使用本地打包的数据。

References

License

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