feiertagejs
TypeScript icon, indicating that this package has built-in type declarations

1.4.0 • Public • Published

Feiertage.js

npm version Build Status

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

Installation

Quick Examples

ES Modules (Typescript/Javasript)

The prefered whay is to directly import the typescript module. However, you can also use .js. Please find here some examples and full api here.

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','ALL'));

// get all holiday for a single year: getHolidays()
// returns an array of "Holiday" Objects. Please see the docs.md for all properties.
const holidays2023 = getHolidays('2023','BUND');


console.log('date', holidays2023[0].date); // = Date("2023-01-01");
console.log('name', holidays2023[0].name); // 'NEUJAHRSTAG' (constant) 
console.log('translation', holidays2023[0].translate('de')); // German translation: Neujahrstag
console.log('equals?', holidays2023[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 "Holiday" Objects. Please see the docs.md for all properties.

var holidays2023 = feiertagejs.getHolidays('2023', 'BUND');

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

API doc

The full API doc can be found here.

Feedback and Questions

You have two options two give feedback or ask questions:

  • Comment the official release post
  • Open issues or pullrequests on github

Contributors

Thank you for contributing:

  • thetric
  • SteveOswald

Feedback

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

Package Sidebar

Install

npm i feiertagejs

Weekly Downloads

5,220

Version

1.4.0

License

MIT

Unpacked Size

207 kB

Total Files

13

Last publish

Collaborators

  • sfakir