Skip to content
πŸ“… Calendar link generator for popular services
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.travis.yml πŸ‘· Add Travis CI Mar 27, 2019
LICENSE Setup typekit-library-starter Jan 16, 2019
README.md πŸ“ Use NPM package for badge Mar 27, 2019
index.test.ts
index.ts
interfaces.ts ✨ Add Google link generator Mar 27, 2019
package.json ⬆️ Bump typescript from 3.4.4 to 3.4.5 Apr 24, 2019
tsconfig.json 🏷 Add new Typescript config Mar 27, 2019
yarn.lock ⬆️ Bump typescript from 3.4.4 to 3.4.5 Apr 24, 2019

README.md

Calendar Link

Travis Coverage Status GitHub Vulnerabilities NPM type definitions NPM

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

You can’t perform that action at this time.