Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typing for alarms #308

Merged
merged 10 commits into from
Feb 28, 2024
Merged

typing for alarms #308

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
105647a
added parsing for alarms
jonnytest1 Jan 31, 2024
e4136ac
moved VALARM block into VEVENT
jonnytest1 Jan 31, 2024
5671c24
found second VALARM outside of VEVENT
jonnytest1 Jan 31, 2024
62450f2
added alarm related asserts
jonnytest1 Jan 31, 2024
5db9a17
added alarm related asserts
jonnytest1 Jan 31, 2024
6d2a0b8
added VTODO parent case
jonnytest1 Jan 31, 2024
f5c2ea5
moved second VALARM into VTODO as a test case
jonnytest1 Jan 31, 2024
4392db3
added type definitons
jonnytest1 Feb 28, 2024
0b8bf09
fomratter did stuff
jonnytest1 Feb 28, 2024
87e3b6f
Merge branch 'jens-maus:master' into master
jonnytest1 Feb 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions node-ical.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,48 @@ declare module 'node-ical' {

type TimeZoneDictionary = Record<string, TimeZoneDef | undefined>;

/**
* Example :
* TRIGGER:-P15M
* TRIGGER;RELATED=END:P5M
* TRIGGER;VALUE=DATE-TIME:19980101T050000Z
*/
type Trigger = string;

/**
* https://www.kanzaki.com/docs/ical/valarm.html
*/
export interface VAlarm extends BaseComponent {
type: 'VALARM';
action: 'AUDIO' | 'DISPLAY' | 'EMAIL' | 'PROCEDURE';
trigger: Trigger;
description?: string;
/**
* https://www.kanzaki.com/docs/ical/repeat.html
*/
repeat?: number;
/**
* Time between repeated alarms (if repeat is set)
* DURATION:PT15M
*/
duration?;
/**
* Everything except DISPLAY
* https://www.kanzaki.com/docs/ical/attach.html
*/
attach;
/**
* For action = email
*/
summary?: string;

/**
* For action = email
*/
attendee?: Attendee;

}

export interface VEvent extends BaseComponent {
type: 'VEVENT';
method: Method;
Expand Down Expand Up @@ -91,6 +133,8 @@ declare module 'node-ical' {
exdate: any;
geo: any;
recurrenceid: any;

alarms?: VAlarm[];
}

/**
Expand Down
Loading