Options
All
  • Public
  • Public/Protected
  • All
Menu

Calendar Link

Greenkeeper badge 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 calendarLink 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, 'hours']
};

// Then fetch the link
calendarLink.google(event); // https://calendar.google.com/calendar/render...
calendarLink.outook(event); // https://outlook.live.com/owa/...
calendarLink.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 / Unix Timestamp end 🤙 | End time | JS Date / ISO 8601 / 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

Index

Functions

sanitizeEvent

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc