Package detail

calendar-link

AnandChowdhary364.2kMIT2.10.0

📅 Calendar link generator for popular services, like Google, Outlook, and Yahoo.

nodejs, typescript, calendar, calendar-link, google-calendar, outlook, yahoo

readme

📅 Calendar Link

JavaScript library to generate an event link for Google Calendar, Yahoo! Calendar, Microsoft Outlook, etc.

Usage

// Usage with Node.js
const { google, outlook, office365, yahoo, ics } = require("calendar-link");

// Usage with TypeScript or ES6
import { google, outlook, office365, yahoo, ics } from "calendar-link";

// Set event as an object
const event = {
  title: "My birthday party",
  description: "Be there!",
  start: "2019-12-29 18:00:00 +0100",
  duration: [3, "hour"],
};

// Then fetch the link
google(event); // https://calendar.google.com/calendar/render...
outlook(event); // https://outlook.live.com/owa/...
office365(event); // https://outlook.office.com/owa/...
yahoo(event); // https://calendar.yahoo.com/?v=60&title=...
ics(event); // standard ICS file based on https://icalendar.org

Options

Property	Description	Allowed values
`title` (required)	Event title	String
`start` (required)	Start time	JS Date / ISO 8601 string / Unix Timestamp
`end`	End time	JS Date / ISO 8601 string / Unix Timestamp
`duration`	Event duration	Array with value (Number) and unit (String)
`allDay`	All day event	Boolean
`rRule`	Recurring event	iCal recurrence rule string NOTE: Only supported by `google` and `ics`
`description`	Information about the event	String
`location`	Event location in words	String
`busy`	Mark on calendar as busy?	Boolean
`guests`	Emails of other guests	Array of emails (String)
`url`	Calendar document URL	String

Notes

Any one of the fields end, duration, or allDay is required.
The allowed units in duration are listed here: https://day.js.org/docs/en/durations/creating#list-of-all-available-units.
The url field defaults to document.URL if a global document object exists. For server-side rendering, you should supply the url manually. Not all calendars support the guests and url fields.
If you don't pass the start and end time in UTC, Google will convert it to UTC but Outlook won't, so it's a good idea to use UTC when passing dates and times
There are some known issues in Office 365 because of which we can't generate a consistent link in all devices (#542)

Compatibility

This package uses URLSearchParams (Node.js >= 10, 97%+ browsers), but if you need to include a polyfill, you can include url-search-params-polyfill first.

License

MIT © Anand Chowdhary

changelog

v2.10.0 (2025-05-20)

📝 Release notes · 💻 Compare · 🔖 Tag · 🗄️ Archive (zip · tar.gz)

✨ New features

a9581ed Add support for ICS file's UID field

v2.9.0 (2025-05-19)

📝 Release notes · 💻 Compare · 🔖 Tag · 🗄️ Archive (zip · tar.gz)

✨ New features

dfd7975 Set ics PRODID correctly (#621) (Issues: #621)

🐛 Bug fixes

194118a Events without end should not necessarily end "now" (#622) (Issues: #622)

⬆️ Dependency updates

dd4bc49 Upgrade dependencies and workflows for improved CI performance

v2.8.0 (2024-12-23)

📝 Release notes · 💻 Compare · 🔖 Tag · 🗄️ Archive (zip · tar.gz)

✨ New features

581db9f Add status X-MICROSOFT for allDay support

v2.7.0 (2024-07-31)

📝 Release notes · 💻 Compare · 🔖 Tag · 🗄️ Archive (zip · tar.gz)

✨ New features

003905a Add Microsoft Teams Calendar Event Generation Feature (#604) (Issues: #604)

v2.6.1 (2024-07-31)

📝 Release notes · 💻 Compare · 🔖 Tag · 🗄️ Archive (zip · tar.gz)

🐛 Bug fixes

6da873c Fix Snapshot Tests for ICS Links (#600) (Issues: #600)

v2.6.0 (2023-09-29)

📝 Release notes · 💻 Compare · 🔖 Tag · 🗄️ Archive (zip · tar.gz)

✨ New features

2d2067f Trigger release manually

v2.5.1 (2023-07-19)

📝 Release notes · 💻 Compare · 🔖 Tag · 🗄️ Archive (zip · tar.gz)

🐛 Bug fixes

e4a2eaa Fix ICS file generation with CLRF and absent fields (#553) (Issues: #553)

v2.5.0 (2023-07-12)

📝 Release notes · 💻 Compare · 🔖 Tag · 🗄️ Archive (zip · tar.gz)

✨ New features

4828504 Use ubuntu-latest for CI
0ac72d5 Release new version

v2.4.0 (2022-10-21)

📝 Release notes · 💻 Compare · 🔖 Tag · 🗄️ Archive (zip · tar.gz)

✨ New features

9b3efb4 Add support for local time in Outlook and Office365

⬆️ Dependency updates

4d551e8 Bump parse-path from 4.0.2 to 7.0.0 (#488) (Issues: #488)- dc0df9e Bump actions/setup-node from 2.1.5 to 3.5.1 (#486) (Issues: #486)- da3fa08 Bump actions/checkout from 2.3.4 to 3.1.0 (#485) (Issues: #485)- 6756c4b Bump typescript from 4.2.3 to 4.8.4 (#481) (Issues: #481)- c184373 Bump actions/stale from 3 to 6 (#478) (Issues: #478)- 7ea8657 Bump ansi-regex, ansi-regex and ansi-regex (#490) (Issues: #490)- 5755074 Bump actions/cache from 2 to 3.0.11 (#493) (Issues: #493)