Package Exports

@devmen/moment-feestdagen

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@devmen/moment-feestdagen) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

moment-feestdagen

With moment-feestdagen you are able to check whether or not a certain date is a Dutch holiday. The list is complete when it comes to official national Dutch holidays. Most regional holidays are not included (yet). moment-feestdagen is a Moment.js plugin.

How to use moment-feestdagen?

Install moment-feestdagen to your package.json by running npm install @devmen/moment-feestdagen --save
Make sure moment.js is also installed with npm install moment --save
Import both

// ES6
import moment from 'moment'
import '@devmen/moment-feestdagen'

// node
const moment = require('moment');
const { isDutchHoliday } = require('@devmen/moment-feestdagen');

Use Moment.js to convert any date format to a Moment object.
Use isDutchHoliday() on that Moment object, it takes two optional values

string | Array<string> for province codes
boolean for whether or not it should exclude holidays without an official day off

Examples since version 1.0.0

const isTodayDutchHoliday = moment().isDutchHoliday();
// returns an object with the name, boolean if its an official day off and an array with provincecodes where the holiday is in effect
// retruns false (boolean) if today is a holiday, but not an official day off
// retruns false (boolean) if today is not a holiday

const isDateDutchHoliday = moment('2019-05-05').isDutchHoliday();
// returns an object about 'Bevrijdingsdag' because it's a holiday in all provinces

const isDateDutchHolidayEverywhere = moment('2019-03-02').isDutchHoliday();
// returns false because it's not a holiday in all provinces

const isDateDutchHolidayInZuidHolland = moment('2019-03-02').isDutchHoliday('ZH');
// returns false because it's not a holiday in ZH

const isDateDutchHolidayInLimburg = moment('2019-03-02').isDutchHoliday('LI');
// returns an object because it's a holiday in LI

const isDateDutchHoliday = moment('2019-04-19').isDutchHoliday()
// returns false because Good Friday is not a official day off

const isDateDutchHoliday = moment('2019-04-19').isDutchHoliday([], false)
// returns an object because it's a holiday, and not an official day off
// remark: notice the empty array to enable the second parameter to be set with the boolean

// province codes:
// NH = Noord-Holland
// ZH = Zuid-Holland
// ZE = Zeeland
// NB = Noord-Brabant
// UT = Utrecht
// FL = Flevoland
// FR = Friesland
// GR = Groningen
// DR = Drenthe
// OV = Overijssel
// GE = Gelderland
// LI = Limburg

Shoutout

moment-feiertage by DaniSchenk This npm package heavily influenced and inspired this module. The way it works is very similar, but is aimed at German holidays.