UNPKG

ical-generator

Version:

ical-generator is a small piece of code which generates ical calendar files

47 lines (46 loc) 1.85 kB
/** * ical-generator entrypoint */ import ICalCalendar, { ICalCalendarData } from './calendar'; /** * Create a new, empty calendar and returns it. * * ```javascript * import ical from 'ical-generator'; * * // or use require: * // const ical = require('ical-generator'); * * const cal = ical(); * ``` * * You can pass options to setup your calendar or use setters to do this. * * ```javascript * import ical from 'ical-generator'; * * // or use require: * // const ical = require('ical-generator'); * const cal = ical({domain: 'sebbo.net'}); * * // is the same as * * const cal = ical().domain('sebbo.net'); * * // is the same as * * const cal = ical(); * cal.domain('sebbo.net'); * ``` * * @param data Calendar data */ declare function ical(data?: ICalCalendarData): ICalCalendar; export default ical; export { default as ICalAlarm, ICalAlarmData, ICalAlarmType, ICalAlarmTypeValue, ICalAlarmJSONData, ICalAttachment } from './alarm'; export { default as ICalAttendee, ICalAttendeeData, ICalAttendeeType, ICalAttendeeRole, ICalAttendeeStatus, ICalAttendeeJSONData } from './attendee'; export { default as ICalCalendar, ICalCalendarData, ICalCalendarProdIdData, ICalCalendarMethod, ICalCalendarJSONData } from './calendar'; export { default as ICalCategory, ICalCategoryData } from './category'; export { default as ICalEvent, ICalEventStatus, ICalEventBusyStatus, ICalEventTransparency, ICalEventData, ICalEventJSONData, ICalEventClass, } from './event'; export { ICalDateTimeValue, ICalRepeatingOptions, ICalLocation, ICalGeo, ICalOrganizer, ICalDescription, ICalEventRepeatingFreq, ICalWeekday, ICalTimezone, ICalMomentStub, ICalMomentTimezoneStub, ICalMomentDurationStub, ICalLuxonDateTimeStub, ICalDayJsStub, ICalRRuleStub } from './types'; export { formatDate, formatDateTZ, escape, foldLines } from './tools';