# @types/ical

> TypeScript definitions for ical

Latest version **0.8.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/ical
pnpm add @types/ical
yarn add @types/ical
bun add @types/ical
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.8.3 |
| Published | 2023-11-07 |
| First published | 2019-10-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51443 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/ical
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ical
- npm.io page: https://npm.io/package/@types/ical

## Dependencies (1)

- [rrule](https://npm.io/package/rrule.md) 2.6.4

## Recent versions

- 0.8.3 (latest) — 2023-11-07
- 0.8.0 (ts3.9) — 2021-07-26
- 0.6.3 (ts3.6) — 2021-07-08
- 0.6.2 (ts3.1) — 2020-08-25
- 0.6.1 (ts2.8) — 2019-11-05
- 0.8.2 — 2023-10-18
- 0.8.1 — 2023-09-26
- 0.6.0 — 2019-10-22

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ical/index.d.ts)
````ts
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;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: [rrule](https://npmjs.com/package/rrule)

# Credits
These definitions were written by [Nick Clifford](https://github.com/nickbclifford), and [Matej Vilk](https://github.com/iammatis).

---
_Source: https://npm.io/package/@types/ical · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._