README.md 14.8 KB
Newer Older
Sebastian Pekarek's avatar
Sebastian Pekarek committed
1
2
# ical-generator

Sebastian Pekarek's avatar
Sebastian Pekarek committed
3
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
Sebastian Pekarek's avatar
Sebastian Pekarek committed
4
[![CI Status](https://img.shields.io/travis/sebbo2002/ical-generator.svg?style=flat-square)](https://travis-ci.org/sebbo2002/ical-generator)
5
<!-- [![Test Coverage](https://sebbo.helium.uberspace.de/teamcity-badges/ICalGenerator_UnitTests/coverage-istanbul)](https://ci.sebbo.net/project.html?projectId=ICalGenerator&tab=preport_project1_Test_Coverage&guest=1) -->
Sebastian Pekarek's avatar
Sebastian Pekarek committed
6

Sebastian Pekarek's avatar
Sebastian Pekarek committed
7
8
ical-generator is a small piece of code which generates ical calendar files. I use this to generate subscriptionable
calendar feeds.
Sebastian Pekarek's avatar
Sebastian Pekarek committed
9

10

Sebastian Pekarek's avatar
Sebastian Pekarek committed
11
12
13
14
## Installation

	npm install ical-generator

15

Sebastian Pekarek's avatar
Sebastian Pekarek committed
16
17
18
19
20
21
22
23
24
25
## Upgrade from 0.1.x

ical-generator 0.2.0 introduces a completely new API, but because you guys used 0.1.x a lot, the old API still works. So
you should be able to upgrade from ical-generator 0.1.x to 0.2.0 without any code changes. In case you need the old API
docs, you can find the deprecated documentation [here](https://github.com/sebbo2002/ical-generator/blob/0.1.10/README.md).

In case you have any issues with the new API, feel free to [create an issue](https://github.com/sebbo2002/ical-generator/issues/new).


## Quick Start
Sebastian Pekarek's avatar
Sebastian Pekarek committed
26
27
28
29

```javascript
var ical = require('ical-generator'),
	http = require('http'),
Sebastian Pekarek's avatar
Sebastian Pekarek committed
30
	cal = ical({domain: 'github.com', name: 'my first iCal'});
Sebastian Pekarek's avatar
Sebastian Pekarek committed
31

Sebastian Pekarek's avatar
Sebastian Pekarek committed
32
33
// overwrite domain
cal.domain('sebbo.net');
34

Sebastian Pekarek's avatar
Sebastian Pekarek committed
35
cal.createEvent({
Sebastian Pekarek's avatar
Sebastian Pekarek committed
36
37
38
39
	start: new Date(),
	end: new Date(new Date().getTime() + 3600000),
	summary: 'Example Event',
	description: 'It works ;)',
Sebastian Pekarek's avatar
Sebastian Pekarek committed
40
	location: 'my room',
Sebastian Pekarek's avatar
Sebastian Pekarek committed
41
42
43
44
45
	url: 'http://sebbo.net/'
});

http.createServer(function(req, res) {
	cal.serve(res);
Sebastian Pekarek's avatar
Sebastian Pekarek committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
}).listen(3000, '127.0.0.1', function() {
    console.log('Server running at http://127.0.0.1:3000/');
});
```


## Just another example

```javascript
var ical = require('ical-generator'),

    // Create new Calendar and set optional fields
    cal = ical({
        domain: 'sebbo.net',
        prodId: {company: 'superman-industries.com', product: 'ical-generator'},
        name: 'My Testfeed',
        timezone: 'Europe/Berlin'
    });

// You can also set values like this…
cal.domain('sebbo.net');

// … or get values
cal.domain(); // --> "sebbo.net"

// create a new event
var event = cal.createEvent({
    start: new Date(),
    end: new Date(new Date().getTime() + 3600000),
    timestamp: new Date(),
    summary: 'My Event',
    organizer: 'Sebastian Pekarek <mail@example.com>'
});

// like above, you can also set/change values like this…
event.summary('My Super Mega Awesome Event');

// get the iCal string
cal.toString(); // --> "BEGIN:VCALENDAR…"


// You can also create events directly with ical()
cal = ical({
    domain: 'sebbo.net',
    prodId: '//superman-industries.com//ical-generator//EN',
    events: [
        {
            start: new Date(),
            end: new Date(new Date().getTime() + 3600000),
            timestamp: new Date(),
            summary: 'My Event',
            organizer: 'Sebastian Pekarek <mail@example.com>'
        }
    ]
}).toString();
101
102
103
104
105
106
```



## API

Sebastian Pekarek's avatar
Sebastian Pekarek committed
107
### ical-generator
108

Sebastian Pekarek's avatar
Sebastian Pekarek committed
109
#### ical([_Object_ options])
110

Sebastian Pekarek's avatar
Sebastian Pekarek committed
111
Creates a new [Calendar](#calendar) ([`ICalCalendar`](#calendar)).
112

Sebastian Pekarek's avatar
Sebastian Pekarek committed
113
114
115
116
117
118
119
120
121
122
```javascript
var ical = require('ical-generator'),
    cal = ical();
```

You can pass options to setup your calendar or use setters to do this.

```javascript
var ical = require('ical-generator'),
    cal = ical({domain: 'sebbo.net'});
Sebastian Pekarek's avatar
Sebastian Pekarek committed
123

Sebastian Pekarek's avatar
Sebastian Pekarek committed
124
// is the same as
Sebastian Pekarek's avatar
Sebastian Pekarek committed
125

Sebastian Pekarek's avatar
Sebastian Pekarek committed
126
cal = ical().domain('sebbo.net');
Sebastian Pekarek's avatar
Sebastian Pekarek committed
127

Sebastian Pekarek's avatar
Sebastian Pekarek committed
128
// is the same as
lee's avatar
lee committed
129

Sebastian Pekarek's avatar
Sebastian Pekarek committed
130
131
132
133
134
135
136
cal = ical();
cal.domain('sebbo.net');
```


### Calendar

Sebastian Pekarek's avatar
Sebastian Pekarek committed
137
#### domain([_String_ domain])
lee's avatar
lee committed
138

Sebastian Pekarek's avatar
Sebastian Pekarek committed
139
140
Use this method to set your server's hostname. It will be used to generate the feed's UID. Default hostname is your
server's one (`require('os').hostname()`).
lee's avatar
lee committed
141

142

Sebastian Pekarek's avatar
Sebastian Pekarek committed
143
#### prodId([_String_|_Object_ prodId])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
144
145
146

Use this method to overwrite the default Product Identifier (`//sebbo.net//ical-generator//EN`). `prodId` can be ether
a valid Product Identifier or an object:
147
148

```javascript
Sebastian Pekarek's avatar
Sebastian Pekarek committed
149
cal.prodId({
150
151
	company: 'My Company',
	product: 'My Product',
Sebastian Pekarek's avatar
Sebastian Pekarek committed
152
	language: 'EN' // optional, defaults to EN
153
});
Sebastian Pekarek's avatar
Sebastian Pekarek committed
154
155
156
157

// OR

cal.prodId('//My Company//My Product//EN');
158
159
160
```


Sebastian Pekarek's avatar
Sebastian Pekarek committed
161
#### name([_String_ name])
162

Sebastian's avatar
Sebastian committed
163
Use this method to set your feed's name. Is used to fill `NAME` and `X-WR-CALNAME` in your iCal file.
164
165


Sebastian's avatar
Sebastian committed
166
167
168
169
170
171
172
173
174
#### url([_String_ url])

Use this method to set your feed's URL.

```javascript
var cal = ical().url('https://example.com/calendar.ical');
```


Sebastian Pekarek's avatar
Sebastian Pekarek committed
175
#### timezone([_String_ timezone])
176

Sebastian's avatar
Sebastian committed
177
Use this method to set your feed's timezone. Is used to fill `TIMEZONE-ID` and `X-WR-TIMEZONE` in your iCal.
178
179

```javascript
Sebastian Pekarek's avatar
Sebastian Pekarek committed
180
181
182
var cal = ical().timezone('Europe/Berlin');
```

183
184
185
186
#### method([_String_ method])

Calendar method. May be any of the following: `publish`, `request`, `reply`, `add`, `cancel`, `refresh`, `counter`, `declinecounter`.

Sebastian Pekarek's avatar
Sebastian Pekarek committed
187

Sebastian's avatar
Sebastian committed
188
189
190
191
192
193
194
195
196
#### ttl([_Number_ ttl])

Use this method to set your feed's time to live. Is used to fill `REFRESH-INTERVAL` and `X-PUBLISHED-TTL` in your iCal.

```javascript
var cal = ical().ttl(60 * 60 * 24);
```


Sebastian Pekarek's avatar
Sebastian Pekarek committed
197
#### createEvent([_Object_ options])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
198
199
200
201
202
203
204
205
206
207
208

Creates a new [Event](#event) ([`ICalEvent`](#event)) and returns it. Use options to prefill the event's attributes.
Calling this method without options will create an empty event.

```javascript
var ical = require('ical-generator'),
    cal = ical(),
    event = cal.createEvent({summary: 'My Event'});

// overwrite event summary
event.summary('Your Event');
209
210
```

Sebastian Pekarek's avatar
Sebastian Pekarek committed
211

Sebastian Pekarek's avatar
Sebastian Pekarek committed
212
#### events([_Object_ events])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231

Add Events to calendar or return all attached events.

```javascript
var cal = ical();
cal.events([
    {
        start: new Date(),
        end: new Date(new Date().getTime() + 3600000),
        summary: 'Example Event',
        description: 'It works ;)',
        url: 'http://sebbo.net/'
    }
]);

cal.events(); // --> [ICalEvent]
```


Sebastian Pekarek's avatar
Sebastian Pekarek committed
232
#### save(**_String_ file**[, _Function_ cb])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
233
234
235
236

Save Calendar to disk asynchronously using [fs.writeFile](http://nodejs.org/api/fs.html#fs_fs_writefile_filename_data_options_callback).


Sebastian Pekarek's avatar
Sebastian Pekarek committed
237
#### saveSync(**_String_ file**)
Sebastian Pekarek's avatar
Sebastian Pekarek committed
238
239
240
241

Save Calendar to disk synchronously using [fs.writeFileSync](http://nodejs.org/api/fs.html#fs_fs_writefilesync_filename_data_options).


Sebastian Pekarek's avatar
Sebastian Pekarek committed
242
#### serve(**_http.ServerResponse_ response**)
Sebastian Pekarek's avatar
Sebastian Pekarek committed
243
244
245
246
247
248
249
250
251

Send Calendar to the User when using HTTP. See Quick Start above.


#### toString()

Return Calendar as a String.


Sebastian Pekarek's avatar
Sebastian Pekarek committed
252
253
254
255
256
257
#### toJSON()

Return a shallow copy of the calendar's options for JSON stringification. Can be used for persistance.
```javascript
var cal = ical(),
    json = JSON.stringify(cal);
Sebastian's avatar
Sebastian committed
258
259
260
    
// later
cal = ical(json);
Sebastian Pekarek's avatar
Sebastian Pekarek committed
261
262
```

Sebastian Pekarek's avatar
Sebastian Pekarek committed
263
264
265
266
267
268
269
270
271
272
273
274
275
#### length()

Returns the ammount of events in the calendar.


#### clear()

Empty the Calender.



### Event

Sebastian Pekarek's avatar
Sebastian Pekarek committed
276
#### uid([_String_|_Number_ uid]) or id([_String_|_Number_ id])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
277

Andi Sidwell's avatar
Andi Sidwell committed
278
Use this method to set the event's ID. If not set, an UID will be generated randomly.  When output, the ID will be suffixed with '@' + your calendar's domain.
Sebastian Pekarek's avatar
Sebastian Pekarek committed
279
280


281
#### sequence([_Number_ sequence])
282
283
284
285
286

Use this method to set the event's revision sequence number of the
calendar component within a sequence of revisions.


Sebastian Pekarek's avatar
Sebastian Pekarek committed
287
#### start([_Date_ start])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
288
289
290
291

Appointment date of beginning as Date object. This is required for all events!


Sebastian Pekarek's avatar
Sebastian Pekarek committed
292
#### end([_Date_ end])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
293

Sebastian's avatar
Sebastian committed
294
Appointment date of end as Date object.
Sebastian Pekarek's avatar
Sebastian Pekarek committed
295
296


Andi Sidwell's avatar
Andi Sidwell committed
297
298
299
300
301
302
303
#### timezone([_String_ timezone])

Use this method to set your event's timezone using the TZID property parameter on start and end dates, as per [date-time form #3 in section 3.3.5 of RFC 554](https://tools.ietf.org/html/rfc5545#section-3.3.5).

This and the 'floating' flag (see below) are mutually exclusive, and setting a timezone will unset the 'floating' flag.  If neither 'timezone' nor 'floating' are set, the date will be output with in UTC format (see [date-time form #2 in section 3.3.5 of RFC 554](https://tools.ietf.org/html/rfc5545#section-3.3.5)).


Sebastian Pekarek's avatar
Sebastian Pekarek committed
304
#### timestamp([_Date_ stamp]) or stamp([_Date_ stamp])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
305
306
307
308

Appointment date of creation as Date object. Default to `new Date()`.


Sebastian Pekarek's avatar
Sebastian Pekarek committed
309
#### allDay([_Boolean_ allDay])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
310
311
312
313

When allDay == true -> appointment is for the whole day


Sebastian Pekarek's avatar
Sebastian Pekarek committed
314
#### floating([_Boolean_ floating])
Andi Sidwell's avatar
Andi Sidwell committed
315

316
317
318
319
320
321
322
323
324
325
Appointment is a "floating" time. From [section 3.3.12 of RFC 554](https://tools.ietf.org/html/rfc5545#section-3.3.12):

> Time values of this type are said to be "floating" and are not
> bound to any time zone in particular.  They are used to represent
> the same hour, minute, and second value regardless of which time
> zone is currently being observed.  For example, an event can be
> defined that indicates that an individual will be busy from 11:00
> AM to 1:00 PM every day, no matter which time zone the person is
> in.  In these cases, a local time can be specified.

Andi Sidwell's avatar
Andi Sidwell committed
326
327
This and the 'timezone' setting (see above) are mutually exclusive, and setting the floating flag will unset the 'timezone'.  If neither 'timezone' nor 'floating' are set, the date will be output with in UTC format (see [date-time form #2 in section 3.3.5 of RFC 554](https://tools.ietf.org/html/rfc5545#section-3.3.5)).

328

Sebastian Pekarek's avatar
Sebastian Pekarek committed
329
#### repeating([_Object_ repeating])
Andi Sidwell's avatar
Andi Sidwell committed
330

Sebastian Pekarek's avatar
Sebastian Pekarek committed
331
332
333
Appointment is a repeating event

```javascript
Sebastian Pekarek's avatar
Sebastian Pekarek committed
334
event.repeating({
Sebastian Pekarek's avatar
Sebastian Pekarek committed
335
336
337
    freq: 'MONTHLY', // required
    count: 5,
    interval: 2,
338
339
340
    until: new Date('Jan 01 2014 00:00:00 UTC'),
    byDay: ['su', 'mo'], // repeat only sunday and monday
    byMonth: [1, 2], // repeat only in january und february,
Sebastian's avatar
Sebastian committed
341
342
    byMonthDay: [1, 15], // repeat only on the 1st and 15th
    exclude: [new Date('Dec 25 2013 00:00:00 UTC')] // exclude these dates
Sebastian Pekarek's avatar
Sebastian Pekarek committed
343
344
345
346
});
```


Sebastian Pekarek's avatar
Sebastian Pekarek committed
347
#### summary([_String_ summary])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
348

Sebastian Pekarek's avatar
Sebastian Pekarek committed
349
Appointment summary, defaults to empty string.
Sebastian Pekarek's avatar
Sebastian Pekarek committed
350
351


Sebastian Pekarek's avatar
Sebastian Pekarek committed
352
#### description([_String_ description])
353
354
355

Appointment description

Sebastian Pekarek's avatar
Sebastian Pekarek committed
356

Sebastian's avatar
Sebastian committed
357
358
359
360
361
#### htmlDescription([_String_ htmlDescription])

Some calendar apps may support HTML descriptions. Like in emails, supported HTML tags and styling is limited. 


Sebastian Pekarek's avatar
Sebastian Pekarek committed
362
#### location([_String_ location])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
363

Sebastian Pekarek's avatar
Sebastian Pekarek committed
364
365
Appointment location

Sebastian Pekarek's avatar
Sebastian Pekarek committed
366

Sebastian Pekarek's avatar
Sebastian Pekarek committed
367
#### organizer([_String_|Object organizer])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
368

369
370
371
Appointment organizer

```javascript
Sebastian Pekarek's avatar
Sebastian Pekarek committed
372
373
374
cal.organizer({
    name: 'Organizer\'s Name',
    email: 'organizer@example.com'
375
376
});

Sebastian Pekarek's avatar
Sebastian Pekarek committed
377
// OR
Lisa Övermyr's avatar
Lisa Övermyr committed
378

Sebastian Pekarek's avatar
Sebastian Pekarek committed
379
380
cal.organizer('Organizer\'s Name <organizer@example.com>');
```
Lisa Övermyr's avatar
Lisa Övermyr committed
381

382

Sebastian Pekarek's avatar
Sebastian Pekarek committed
383
#### createAttendee([_Object_ options])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401

Creates a new [Attendee](#attendee) ([`ICalAttendee`](#attendee)) and returns it. Use options to prefill the attendee's attributes.
Calling this method without options will create an empty attendee.

```javascript
var ical = require('ical-generator'),
    cal = ical(),
    event = cal.createEvent(),
    attendee = event.createAttendee({email: 'hui@example.com', 'name': 'Hui'});

// overwrite attendee's email address
attendee.email('hui@example.net');

// add another attendee
event.createAttendee('Buh <buh@example.net>');
```


Sebastian Pekarek's avatar
Sebastian Pekarek committed
402
#### attendees([_Object_ attendees])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416

Add Attendees to the event or return all attached attendees.

```javascript
var event = ical().createEvent();
cal.attendees([
    {email: 'a@example.com', name: 'Person A'},
    {email: 'b@example.com', name: 'Person B'}
]);

cal.attendees(); // --> [ICalAttendee, ICalAttendee]
```


Sebastian Pekarek's avatar
Sebastian Pekarek committed
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
#### createAlarm([_Object_ options])

Creates a new [Alarm](#alarm) ([`ICalAlarm`](#alarm)) and returns it. Use options to prefill the alarm's attributes.
Calling this method without options will create an empty alarm.

```javascript
var ical = require('ical-generator'),
    cal = ical(),
    event = cal.createEvent(),
    alarm = event.createAlarm({type: 'display', trigger: 300});

// add another alarm
event.createAlarm({
    type: 'audio',
    trigger: 300, // 5min before event
});
```


#### alarms([_Object_ alarms])

Add alarms to the event or return all attached alarms.

```javascript
var event = ical().createEvent();
cal.alarms([
    {type: 'display', trigger: 600},
    {type: 'audio', trigger: 300}
]);

Akiva Gordon's avatar
Akiva Gordon committed
447
cal.alarms(); // --> [ICalAlarm, ICalAlarm]
Sebastian Pekarek's avatar
Sebastian Pekarek committed
448
449
450
```


Sebastian Pekarek's avatar
Sebastian Pekarek committed
451
#### url([_String_ url])
452

Sebastian Pekarek's avatar
Sebastian Pekarek committed
453
Appointment URL
454
455


Sebastian Pekarek's avatar
Sebastian Pekarek committed
456
#### status([_String_ status])
457

Akiva Gordon's avatar
Akiva Gordon committed
458
Appointment status. May be any of the following: `confirmed`, `tentative`, `cancelled`.
Sebastian Pekarek's avatar
Sebastian Pekarek committed
459

Sebastian Pekarek's avatar
Sebastian Pekarek committed
460
461


Sebastian Pekarek's avatar
Sebastian Pekarek committed
462
463
### Attendee

Sebastian Pekarek's avatar
Sebastian Pekarek committed
464
#### name([_String_ name])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
465
466
467
468

Use this method to set the attendee's name.


Sebastian Pekarek's avatar
Sebastian Pekarek committed
469
#### email([_String_ email])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
470
471
472
473

The attendee's email address. An email address is required for every attendee!


Sebastian Pekarek's avatar
Sebastian Pekarek committed
474
#### role([_String_ role])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
475

Sebastian Pekarek's avatar
Sebastian Pekarek committed
476
Set the attendee's role, defaults to `REQ-PARTICIPANT`. May be one of the following: `req-participant`, `non-participant`
Sebastian Pekarek's avatar
Sebastian Pekarek committed
477
478


Sebastian Pekarek's avatar
Sebastian Pekarek committed
479
#### status([_String_ status])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
480

Sebastian Pekarek's avatar
Sebastian Pekarek committed
481
Set the attendee's status. May be one of the following: `accepted`, `tentative`, `declined`
Sebastian Pekarek's avatar
Sebastian Pekarek committed
482
483


484
485
#### type([_String_ type])

Sebastian Pekarek's avatar
Sebastian Pekarek committed
486
Set the attendee's type. May be one of the following: `individual`, `group`, `resource`, `room`, `unknown` (See [Section 4.2.3](https://tools.ietf.org/html/rfc2445#section-4.2.3))
487
488
489



Sebastian Pekarek's avatar
Sebastian Pekarek committed
490
#### delegatesTo(**_ICalAttendee_|_Object_ attendee**)
Sebastian Pekarek's avatar
Sebastian Pekarek committed
491
492
493
494
495
496
497
498
499
500
501
502

Creates a new Attendee if passed object is not already an attendee. Will set the delegatedTo and delegatedFrom attributes.

```javascript
var cal = ical(),
    event = cal.createEvent(),
    attendee = cal.createAttendee();

attendee.delegatesTo({email: 'foo@bar.com', name: 'Foo'});
```


Sebastian Pekarek's avatar
Sebastian Pekarek committed
503
#### delegatesFrom(**_ICalAttendee_|_Object_ attendee**)
Sebastian Pekarek's avatar
Sebastian Pekarek committed
504
505
506
507
508
509
510
511
512
513
514
515
516

Creates a new Attendee if passed object is not already an attendee. Will set the delegatedTo and delegatedFrom attributes.

```javascript
var cal = ical(),
    event = cal.createEvent(),
    attendee = cal.createAttendee();

attendee.delegatesFrom({email: 'foo@bar.com', name: 'Foo'});
```



Sebastian Pekarek's avatar
Sebastian Pekarek committed
517
518
519
520
521
522
523
### Alarm

#### type([_String_ type])

Use this method to set the alarm type. Right now, `audio` and `display` is supported.


Sebastian Pekarek's avatar
Sebastian Pekarek committed
524
#### trigger([_Number_|_Date_ trigger]) / triggerBefore([_Number_|_Date_ trigger])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
525
526
527
528
529
530
531
532
533
534
535
536
537

Use this method to set the alarm time.

```javascript
var cal = ical(),
    event = cal.createEvent(),
    alarm = cal.createAlarm();

alarm.trigger(600); // -> 10 minutes before event starts
alarm.trigger(new Date()); // -> now
```


Sebastian Pekarek's avatar
Sebastian Pekarek committed
538
#### triggerAfter([_Number_|_Date_ trigger])
Sebastian Pekarek's avatar
Sebastian Pekarek committed
539
540
541
542
543
544
545
546

Use this method to set the alarm time.

```javascript
var cal = ical(),
    event = cal.createEvent(),
    alarm = cal.createAlarm();

Tobias Mersmann's avatar
Tobias Mersmann committed
547
548
alarm.triggerAfter(600); // -> 10 minutes after the event finishes
alarm.triggerAfter(new Date()); // -> now
Sebastian Pekarek's avatar
Sebastian Pekarek committed
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
```


#### repeat([_Number_ repeat])

Use this method to repeat the alarm.

```javascript
var cal = ical(),
    event = cal.createEvent(),

// repeat the alarm 4 times every 5 minutes…
cal.createAlarm({
    repeat: 4,
    interval: 300
});
```


#### interval([_Number_ interval])

Use this method to set the alarm's interval.

```javascript
var cal = ical(),
    event = cal.createEvent(),

// repeat the alarm 4 times every 5 minutes…
cal.createAlarm({
    repeat: 4,
    interval: 300
});
```


#### attach([_String_|_Object_ attach])

Alarm attachment; used to set the alarm sound if type = audio. Defaults to "Basso".

```javascript
var cal = ical(),
    event = cal.createEvent(),

event.createAlarm({
    attach: 'https://example.com/notification.aud'
});

// OR

event.createAlarm({
    attach: {
        uri: 'https://example.com/notification.aud',
        mime: 'audio/basic'
    }
});
```


#### description([_String_| description])

Alarm description; used to set the alarm message if type = display. Defaults to the event's summary.




Sebastian Pekarek's avatar
Sebastian Pekarek committed
614
615
## Tests

Sebastian Pekarek's avatar
Sebastian Pekarek committed
616
```
Sebastian Pekarek's avatar
Sebastian Pekarek committed
617
npm test
618
619
620
621
622
```


## Copyright and license

Sebastian Pekarek's avatar
Sebastian Pekarek committed
623
Copyright (c) Sebastian Pekarek under the [MIT license](LICENSE).