Skip to content

commenthol/date-holidays-ical

Repository files navigation

date-holidays-ical

Generate ical (.ics) files from date-holidays data

NPM version Build Status

This tool exports data from date-holidays into iCal format.

Usage

  Usage: holidays-ical [options]

  Options:

    -h, --help         output usage information
    -V, --version      output the version number
    -o, --out <file>   write to file
    -y, --year <year>  year
    -f, --fullday      ical events are per full day
    -s, --showcode     show country code in each ical summary
    -n, --name <name>  instead of country code add your own name to each ical summary
    -q, --query        query for available countries, states, regions by shortcode

  Examples:

    Query for available Countries:
    $ holiday-ical -q

    Query for available States in New Zealand:
    $ holiday-ical -q NZ

    Calender for 2017 New Zealand, Auckland Province:
    $ holiday-ical -f -y 2017 NZ.au

Import the generated file into your calendar tool of choice.

API

var ical = require('date-holidays-ical')()

// query for available countries
var res = ical.query()
//> { AD: 'Andorra',
//>   ..
//>   UY: 'Uruguay' }

// initialize with country, e.g. Uruguay
res = ical.init('UY')
//> true

// get iCal Calender
res = ical.calendar(2016)

LICENSE

ICS

References

About

Generate ical (.ics) files from date-holidays data

Resources

License

Stars

Watchers

Forks

Packages

No packages published