npm

npm’s 2019 JavaScript ecosystem survey analysis is now available! Get your copy here »

calendar-link

1.0.1 • Public • Published

Calendar Link

Travis Coverage Status GitHub Vulnerabilities Made in Enschede

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

NPM

Usage

import { google, outlook, yahoo } from "calendar-link"
 
// Set event as an object
const event = {
  title: "My birthday party",
  description: "Be there!",
  starts: "2019-12-29 18:00:00 +0100",
  duration: [3, "hour"]
};
 
// Then fetch the link
google(event); // https://calendar.google.com/calendar/render...
outook(event); // https://outlook.live.com/owa/...
yahoo(event); // https://calendar.yahoo.com/?v=60&title=...

Options

Property Description Allowed values
title 👍 Event title String
start 👍 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)
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)

Support key

Emoji Meaning
👍 Required
🤙 Any one is required
👌 Supported but not required
🤞 Not all calendars support

License

MIT © Anand Chowdhary

Keywords

none

install

npm i calendar-link

Downloadsweekly downloads

9

version

1.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability