0.2.0 • Published 7 years ago

public-google-calendar v0.2.0

Weekly downloads
14
License
MIT
Repository
github
Last release
7 years ago

###public-google-calendar

Module for NodeJS. Retrieves all events from a public Google Calendar and returns them date-sorted in a simplified object.

#####Installation:

npm install public-google-calendar

#####Example:

var PublicGoogleCalendar = require('public-google-calendar')
  , publicGoogleCalendar = new PublicGoogleCalendar({ calendarId: 'id-of-public-google-calendar' });
  
publicGoogleCalendar.getEvents(function(err, events) {
  if (err) { return console.log(err.message); }
  // events is now array of all calendar events
});

#####API:

publicGoogleCalendar.getEvents(options, callback)

By default, returns a date-sorted array (latest event first) of Google Calendar events.

Options (optional): earliestFirst: reverse sort order (default: false) expandRecurring: expand recurring events (default: true) 'endDate': (number, milliseconds since epoch) return only events before this moment (default: three years from now)

Callback: called with arguments error and events, an array of objects with following properties: summary: string location: string status: string description: string start: Date object end: Date object id: string (event id) baseEvent: if event is part of a series of expanded events, this points to the base event of the series

#####Testing:

Run tests with Grunt:

grunt jasmine_node