@types/ical NPM

Installation

npm install --save @types/ical

Summary

This package contains type definitions for ical (https://github.com/peterbraden/ical.js).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ical.

index.d.ts

// Type definitions for ical 0.8
// Project: https://github.com/peterbraden/ical.js
// Definitions by: Nick Clifford <https://github.com/nickbclifford>
//                 Matej Vilk <https://github.com/iammatis>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// Minimum TypeScript Version: 3.9
import { RRule } from 'rrule';

export type CalendarComponentType = 'VEVENT' | 'VTODO' | 'VJOURNAL' | 'VFREEBUSY' | 'VTIMEZONE' | 'VALARM';

export interface ParamList {
    params: { [key: string]: string };
    val: string;
}

export type FreeBusyType = 'FREE' | 'BUSY';

export interface FreeBusy {
    type: FreeBusyType;
    start: Date;
    end: Date;
}

// All properties (except type) are optional
// Typed as string | ParamList by default, exceptions listed below
export type CalendarComponent = {
    type: CalendarComponentType;
    summary?: string
    description?: string
    url?: string
    uid?: string
    location?: string
    start?: Date
    end?: Date
    rrule?: RRule
    exdate?: { [datestr: string]: Date }
    recurrences?: CalendarComponent[]
    class?: string
    transparency?: string
    geo?: Geo
    completion?: string
    completed?: Date
    categories?: string[]
    freebusy?: FreeBusy
    dtstamp?: Date
    created?: Date
    lastmodified?: Date
    recurrenceid?: Date
} & { [prop: string]: string | ParamList | undefined };

export interface Geo {
    lat: number;
    lon: number;
}

export interface FullCalendar {
    [uid: string]: CalendarComponent;
}

export function parseICS(icsData: string): FullCalendar;
export function parseFile(filename: string): FullCalendar;