Feiertage.js is a small npm module to calculate German holidays for each Bundesland
Switch branches/tags
Nothing to show
Clone or download
Latest commit 8dc2246 Nov 9, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
spec
src
.editorconfig
.gitignore
.prettierrc.json build: externalize prettier config Feb 5, 2018
.travis.yml
CHANGELOG.md
LICENSE
Readme.md
bower.json build(bower): fix `main` entry point Oct 16, 2017
docs.md
index.d.ts add typescript definition Feb 7, 2018
npm.md
package-lock.json
package.json
rollup.config.js
tsconfig.json
tslint.json
yarn.lock

Readme.md

Feiertage.js

npm version Build Status

Feiertage.js is a small npm module to calculate German holidays for each Bundesland.

Installation

This package provides two bundles:

  • an UMD bundle (default, for Node.js and direct usage in the browser)
  • ES Modules (automatically picked up by ES module-aware tools like Webpack, Rollup)

Quick Examples

ES Modules

import { getHolidays, isHoliday, isSpecificHoliday } from 'feiertagejs';

const today = new Date();

console.log(isHoliday(today, 'BW'));
// probably false, because you are working ;)

// check if a day is a specific holiday:
console.log(isSpecificHoliday(today, 'CHRISTIHIMMELFAHRT'));

// get all holiday for a single year: getHolidays()
// returns an array of objects [ {name: '', date: ''} ,...]

const holidays2018 = getHolidays('2018','BUND');

console.log('date', holidays2018[0].date); // = Date("2018-01-01");
console.log('name', holidays2018[0].name); // 'NEUJAHRSTAG' (constant)
console.log('translation', holidays2018[0].trans()); // German translation: Neujahrstag
console.log('equals?', holidays2018[0].equals(date)); // Compare days only (ignore time)

Usage in Node.js

var feiertagejs = require('feiertagejs');

var today = new Date();

console.log(feiertagejs.isHoliday(today, 'BW'));
// probably false, because you are working ;)

// check if a day is a specific holiday:
console.log(feiertagejs.isSpecificHoliday(today, 'CHRISTIHIMMELFAHRT'));

// get all holiday for a single year: getHolidays()
// returns an array of objects [ {name: '', date: ''} ,...]

var holidays2018 = feiertagejs.getHolidays('2018', 'BUND');

console.log('date', holidays2018[0].date); // = Date("2018-01-01");
console.log('name', holidays2018[0].name); // 'NEUJAHRSTAG' (constant)
console.log('translation', holidays2018[0].trans()); // German translation: Neujahrstag
console.log('equals?', holidays2018[0].equals(date)); // Compare days only (ignore time)

API doc

The full API doc can be found here. Note that although the documentation uses custom Flow types (e.g. HolidayType) you are not required to use Flow in your code (see "Usage in Node.js").

Feedback and Questions

You have two options two give feedback:

  • Open issues or pullrequests on github
  • Comment the official release post, unfortunately in German.

Contributors

Thank you for contributing:

  • thetric

Feedback

If you have any questions, feel free to open an issue.