Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 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 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 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 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 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 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 1x 1x 66x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 28x 4x 4x 28x 2x 2x 22x 22x 22x 22x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 57x 57x 57x 10x 10x 57x 6x 6x 41x 41x 57x 23x 23x 18x 3x 3x 15x 15x 15x 32x 32x 32x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11x 2x 2x 11x 2x 2x 2x 7x 11x 3x 3x 4x 4x 4x 4x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11x 3x 3x 8x 11x 11x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11x 3x 3x 8x 8x 8x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 16x 2x 2x 16x 1x 1x 1x 13x 16x 1x 1x 16x 4x 4x 16x 4x 4x 4x 4x 4x 4x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 16x 5x 5x 16x 3x 3x 3x 8x 8x 16x 3x 3x 3x 3x 3x 5x 4x 4x 4x 4x 4x 1x 1x 1x 1x 1x 1x 7x 16x 1x 1x 6x 6x 6x 6x 6x 6x 6x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11x 3x 3x 11x 3x 3x 3x 5x 5x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 9x 3x 3x 9x 3x 3x 3x 3x 3x 3x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 8x 1x 1x 1x 8x 2x 2x 6x 6x 6x 6x 6x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 9x 7x 7x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 4x 2x 2x 2x 4x 1x 1x 1x 1x 1x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 26x 26x 26x 26x 26x 26x 21x 1x 1x 20x 20x 20x 26x 5x 2x 2x 3x 3x 3x 26x 26x 26x 4x 4x 4x 4x 4x 4x 26x 26x 26x 1x 1x 25x 1x 1x 24x 1x 1x 26x 26x 26x 4x 4x 22x 19x 19x 26x 26x 26x 1x 1x 25x 2x 2x 26x 26x 26x 3x 1x 3x 3x 26x 26x 26x 26x 26x 26x 26x 1x | 'use strict';
import ICalEvent from './event.ts';
import {
addOrGetCustomAttributes,
formatDate,
escape,
generateCustomAttributes,
checkDate,
toDurationString,
toJSON,
checkNameAndMail
} from './tools.ts';
import {ICalDateTimeValue} from './types.ts';
import ICalAttendee, { ICalAttendeeData } from './attendee.ts';
export enum ICalAlarmType {
display = 'display',
audio = 'audio',
email = 'email'
}
export const ICalAlarmRelatesTo = {
end: 'END',
start: 'START'
} as const;
export type ICalAlarmRelatesTo = typeof ICalAlarmRelatesTo[keyof typeof ICalAlarmRelatesTo];
export type ICalAlarmTypeValue = keyof ICalAlarmType;
export interface ICalAttachment {
uri: string;
mime: string | null;
}
export type ICalAlarmData = ICalAlarmBaseData |
ICalAlarmTriggerData |
ICalAlarmTriggerAfterData |
ICalAlarmTriggerBeforeData;
export type ICalAlarmTriggerData = ICalAlarmBaseData & { trigger: number | ICalDateTimeValue };
export type ICalAlarmTriggerAfterData = ICalAlarmBaseData & { triggerAfter: number | ICalDateTimeValue };
export type ICalAlarmTriggerBeforeData = ICalAlarmBaseData & { triggerBefore: number | ICalDateTimeValue };
export interface ICalAlarmBaseData {
type?: ICalAlarmType;
relatesTo?: ICalAlarmRelatesTo | null;
repeat?: ICalAlarmRepeatData | null;
attach?: string | ICalAttachment | null;
description?: string | null;
summary?: string | null;
attendees?: ICalAttendee[] | ICalAttendeeData[];
x?: {key: string, value: string}[] | [string, string][] | Record<string, string>;
}
export interface ICalAlarmRepeatData {
times: number;
interval: number;
}
interface ICalInternalAlarmData {
type: ICalAlarmType;
trigger: ICalDateTimeValue | number;
relatesTo: ICalAlarmRelatesTo | null;
repeat: ICalAlarmRepeatData | null;
interval: number | null;
attach: ICalAttachment | null;
description: string | null;
summary: string | null;
attendees: ICalAttendee[];
x: [string, string][];
}
export interface ICalAlarmJSONData {
type: ICalAlarmType;
trigger: string | number;
relatesTo: ICalAlarmRelatesTo | null;
repeat: ICalAlarmRepeatData | null;
interval: number | null;
attach: ICalAttachment | null;
description: string | null;
summary: string | null;
attendees: ICalAttendee[];
x: {key: string, value: string}[];
}
/**
* Usually you get an {@link ICalAlarm} object like this:
*
* ```javascript
* import ical from 'ical-generator';
* const calendar = ical();
* const event = calendar.createEvent();
* const alarm = event.createAlarm();
* ```
*
* You can also use the {@link ICalAlarm} object directly:
*
* ```javascript
* import ical, {ICalAlarm} from 'ical-generator';
* const alarm = new ICalAlarm();
* event.alarms([alarm]);
* ```
*/
export default class ICalAlarm {
private readonly data: ICalInternalAlarmData;
private readonly event: ICalEvent;
/**
* Constructor of {@link ICalAttendee}. The event reference is required
* to query the calendar's timezone and summary when required.
*
* @param data Alarm Data
* @param event Reference to ICalEvent object
*/
constructor (data: ICalAlarmData, event: ICalEvent) {
this.data = {
type: ICalAlarmType.display,
trigger: -600,
relatesTo: null,
repeat: null,
interval: null,
attach: null,
description: null,
summary: null,
attendees: [],
x: []
};
this.event = event;
if (!event) {
throw new Error('`event` option required!');
}
data.type !== undefined && this.type(data.type);
'trigger' in data && data.trigger !== undefined && this.trigger(data.trigger);
'triggerBefore' in data && data.triggerBefore !== undefined && this.triggerBefore(data.triggerBefore);
'triggerAfter' in data && data.triggerAfter !== undefined && this.triggerAfter(data.triggerAfter);
data.repeat && this.repeat(data.repeat);
data.attach !== undefined && this.attach(data.attach);
data.description !== undefined && this.description(data.description);
data.summary !== undefined && this.summary(data.summary);
data.attendees !== undefined && this.attendees(data.attendees);
data.x !== undefined && this.x(data.x);
}
/**
* Get the alarm type
* @since 0.2.1
*/
type (type: ICalAlarmType): this;
/**
* Set the alarm type. See {@link ICalAlarmType}
* for available status options.
* @since 0.2.1
*/
type (): ICalAlarmType;
type (type?: ICalAlarmType): this | ICalAlarmType {
if (type === undefined) {
return this.data.type;
}
if (!type || !Object.keys(ICalAlarmType).includes(type)) {
throw new Error('`type` is not correct, must be either `display` or `audio`!');
}
this.data.type = type;
return this;
}
/**
* Get the trigger time for the alarm. Can either
* be a date and time value ({@link ICalDateTimeValue}) or
* a number, which will represent the seconds between
* alarm and event start. The number is negative, if the
* alarm is triggered after the event started.
*
* @since 0.2.1
*/
trigger (): number | ICalDateTimeValue;
/**
* Use this method to set the alarm time.
*
* ```javascript
* const cal = ical();
* const event = cal.createEvent();
* const alarm = cal.createAlarm();
*
* alarm.trigger(600); // -> 10 minutes before event starts
* alarm.trigger(new Date()); // -> now
* ```
*
* You can use any supported date object, see
* [readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
* for details about supported values and timezone handling.
*
* @since 0.2.1
*/
trigger (trigger: number | ICalDateTimeValue | Date): this;
trigger (trigger?: number | ICalDateTimeValue | Date): this | number | ICalDateTimeValue {
// Getter
if (trigger === undefined && typeof this.data.trigger === 'number') {
return -1 * this.data.trigger;
}
if (trigger === undefined) {
return this.data.trigger;
}
// Setter
if (typeof trigger === 'number' && isFinite(trigger)) {
this.data.trigger = -1 * trigger;
}
else if(!trigger || typeof trigger === 'number') {
throw new Error('`trigger` is not correct, must be a finite number or a supported date!');
}
else {
this.data.trigger = checkDate(trigger, 'trigger');
}
return this;
}
/**
* Get to which time alarm trigger relates to.
* Can be either `START` or `END`. If the value is
* `START` the alarm is triggerd relative to the event start time.
* If the value is `END` the alarm is triggerd relative to the event end time
*
* @since 4.0.1
*/
relatesTo(): ICalAlarmRelatesTo | null;
/**
* Use this method to set to which time alarm trigger relates to.
* Works only if trigger is a `number`
*
* ```javascript
* const cal = ical();
* const event = cal.createEvent();
* const alarm = cal.createAlarm();
*
* alarm.trigger(600); // -> 10 minutes before event starts
*
* alarm.relatesTo('START'); // -> 10 minutes before event starts
* alarm.relatesTo('END'); // -> 10 minutes before event ends
*
* alarm.trigger(-600); // -> 10 minutes after event starts
*
* alarm.relatesTo('START'); // -> 10 minutes after event starts
* alarm.relatesTo('END'); // -> 10 minutes after event ends
* ```
* @since 4.0.1
*/
relatesTo(relatesTo: ICalAlarmRelatesTo | null): this;
relatesTo(relatesTo?: ICalAlarmRelatesTo | null): this | ICalAlarmRelatesTo | null {
if (relatesTo === undefined) {
return this.data.relatesTo;
}
if (!relatesTo) {
this.data.relatesTo = null;
return this;
}
if (!Object.values(ICalAlarmRelatesTo).includes(relatesTo)) {
throw new Error('`relatesTo` is not correct, must be either `START` or `END`!');
}
this.data.relatesTo = relatesTo;
return this;
}
/**
* Get the trigger time for the alarm. Can either
* be a date and time value ({@link ICalDateTimeValue}) or
* a number, which will represent the seconds between
* alarm and event start. The number is negative, if the
* alarm is triggered before the event started.
*
* @since 0.2.1
*/
triggerAfter (): number | ICalDateTimeValue;
/**
* Use this method to set the alarm time. Unlike `trigger`, this time
* the alarm takes place after the event has started.
*
* ```javascript
* const cal = ical();
* const event = cal.createEvent();
* const alarm = cal.createAlarm();
*
* alarm.trigger(600); // -> 10 minutes after event starts
* ```
*
* You can use any supported date object, see
* [readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
* for details about supported values and timezone handling.
*
* @since 0.2.1
*/
triggerAfter (trigger: number | ICalDateTimeValue): this;
triggerAfter (trigger?: number | ICalDateTimeValue): this | number | ICalDateTimeValue {
if (trigger === undefined) {
return this.data.trigger;
}
return this.trigger(typeof trigger === 'number' ? -1 * trigger : trigger);
}
/**
* Get the trigger time for the alarm. Can either
* be a date and time value ({@link ICalDateTimeValue}) or
* a number, which will represent the seconds between
* alarm and event start. The number is negative, if the
* alarm is triggered after the event started.
*
* @since 0.2.1
* @alias trigger
*/
triggerBefore (trigger: number | ICalDateTimeValue): this;
/**
* Use this method to set the alarm time.
*
* ```javascript
* const cal = ical();
* const event = cal.createEvent();
* const alarm = cal.createAlarm();
*
* alarm.trigger(600); // -> 10 minutes before event starts
* alarm.trigger(new Date()); // -> now
* ```
*
* You can use any supported date object, see
* [readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
* for details about supported values and timezone handling.
*
* @since 0.2.1
* @alias trigger
*/
triggerBefore (): number | ICalDateTimeValue;
triggerBefore (trigger?: number | ICalDateTimeValue): this | number | ICalDateTimeValue {
if(trigger === undefined) {
return this.trigger();
}
return this.trigger(trigger);
}
/**
* Get Alarm Repetitions
* @since 0.2.1
*/
repeat(): ICalAlarmRepeatData | null;
/**
* Set Alarm Repetitions. Use this to repeat the alarm.
*
* ```javascript
* const cal = ical();
* const event = cal.createEvent();
*
* // repeat the alarm 4 times every 5 minutes…
* cal.createAlarm({
* repeat: {
* times: 4,
* interval: 300
* }
* });
* ```
*
* @since 0.2.1
*/
repeat(repeat: ICalAlarmRepeatData | null): this;
repeat (repeat?: ICalAlarmRepeatData | null): this | ICalAlarmRepeatData | null {
if (repeat === undefined) {
return this.data.repeat;
}
if (!repeat) {
this.data.repeat = null;
return this;
}
if (typeof repeat !== 'object') {
throw new Error('`repeat` is not correct, must be an object!');
}
if (typeof repeat.times !== 'number' || !isFinite(repeat.times)) {
throw new Error('`repeat.times` is not correct, must be numeric!');
}
if (typeof repeat.interval !== 'number' || !isFinite(repeat.interval)) {
throw new Error('`repeat.interval` is not correct, must be numeric!');
}
this.data.repeat = repeat;
return this;
}
/**
* Get Attachment
* @since 0.2.1
*/
attach (): {uri: string, mime: string | null} | null;
/**
* Set Alarm attachment. Used to set the alarm sound
* if alarm type is audio. Defaults to "Basso".
*
* ```javascript
* const cal = ical();
* const event = cal.createEvent();
*
* event.createAlarm({
* attach: 'https://example.com/notification.aud'
* });
*
* // OR
*
* event.createAlarm({
* attach: {
* uri: 'https://example.com/notification.aud',
* mime: 'audio/basic'
* }
* });
* ```
*
* @since 0.2.1
*/
attach (attachment: {uri: string, mime?: string | null} | string | null): this;
attach (attachment?: {uri: string, mime?: string | null} | string | null): this | {uri: string, mime: string | null} | null {
if (attachment === undefined) {
return this.data.attach;
}
if (!attachment) {
this.data.attach = null;
return this;
}
let _attach = null;
if (typeof attachment === 'string') {
_attach = {
uri: attachment,
mime: null
};
}
else if (typeof attachment === 'object') {
_attach = {
uri: attachment.uri,
mime: attachment.mime || null
};
}
else {
throw new Error(
'`attachment` needs to be a valid formed string or an object. See https://sebbo2002.github.io/' +
'ical-generator/develop/reference/classes/ICalAlarm.html#attach'
);
}
if (!_attach.uri) {
throw new Error('`attach.uri` is empty!');
}
this.data.attach = {
uri: _attach.uri,
mime: _attach.mime
};
return this;
}
/**
* Get the alarm description. Used to set the alarm message
* if alarm type is `display`. If the alarm type is `email`, it's
* used to set the email body. Defaults to the event's summary.
*
* @since 0.2.1
*/
description (): string | null;
/**
* Set the alarm description. Used to set the alarm message
* if alarm type is `display`. If the alarm type is `email`, it's
* used to set the email body. Defaults to the event's summary.
*
* @since 0.2.1
*/
description (description: string | null): this;
description (description?: string | null): this | string | null {
if (description === undefined) {
return this.data.description;
}
if (!description) {
this.data.description = null;
return this;
}
this.data.description = description;
return this;
}
/**
* Get the alarm summary. Used to set the email subject
* if alarm type is `email`. Defaults to the event's summary.
*
* @since 7.0.0
*/
summary (): string | null;
/**
* Set the alarm summary. Used to set the email subject
* if alarm type is display. Defaults to the event's summary.
*
* @since 0.2.1
*/
summary (summary: string | null): this;
summary (summary?: string | null): this | string | null {
if (summary === undefined) {
return this.data.summary;
}
if (!summary) {
this.data.summary = null;
return this;
}
this.data.summary = summary;
return this;
}
/**
* Creates a new {@link ICalAttendee} and returns it. Use options to prefill
* the attendee's attributes. Calling this method without options will create
* an empty attendee.
*
* @since 7.0.0
*/
createAttendee(data: ICalAttendee | ICalAttendeeData | string): ICalAttendee {
if (data instanceof ICalAttendee) {
this.data.attendees.push(data);
return data;
}
if (typeof data === 'string') {
data = { email: data, ...checkNameAndMail('data', data) };
}
const attendee = new ICalAttendee(data, this);
this.data.attendees.push(attendee);
return attendee;
}
/**
* Get all attendees
* @since 7.0.0
*/
attendees(): ICalAttendee[];
/**
* Add multiple attendees to your event
*
* @since 7.0.0
*/
attendees(attendees: (ICalAttendee | ICalAttendeeData | string)[]): this;
attendees(attendees?: (ICalAttendee | ICalAttendeeData | string)[]): this | ICalAttendee[] {
if (!attendees) {
return this.data.attendees;
}
attendees.forEach(attendee => this.createAttendee(attendee));
return this;
}
/**
* Set X-* attributes. Woun't filter double attributes,
* which are also added by another method (e.g. type),
* so these attributes may be inserted twice.
*
* ```javascript
* alarm.x([
* {
* key: "X-MY-CUSTOM-ATTR",
* value: "1337!"
* }
* ]);
*
* alarm.x([
* ["X-MY-CUSTOM-ATTR", "1337!"]
* ]);
*
* alarm.x({
* "X-MY-CUSTOM-ATTR": "1337!"
* });
* ```
*
* @since 1.9.0
*/
x (keyOrArray: {key: string, value: string}[] | [string, string][] | Record<string, string>): this;
/**
* Set a X-* attribute. Woun't filter double attributes,
* which are also added by another method (e.g. type),
* so these attributes may be inserted twice.
*
* ```javascript
* alarm.x("X-MY-CUSTOM-ATTR", "1337!");
* ```
*
* @since 1.9.0
*/
x (keyOrArray: string, value: string): this;
/**
* Get all custom X-* attributes.
* @since 1.9.0
*/
x (): {key: string, value: string}[];
x (keyOrArray?: ({key: string, value: string})[] | [string, string][] | Record<string, string> | string, value?: string): this | void | ({key: string, value: string})[] {
if(keyOrArray === undefined) {
return addOrGetCustomAttributes (this.data);
}
if(typeof keyOrArray === 'string' && typeof value === 'string') {
addOrGetCustomAttributes (this.data, keyOrArray, value);
}
else if(typeof keyOrArray === 'object') {
addOrGetCustomAttributes (this.data, keyOrArray);
}
else {
throw new Error('Either key or value is not a string!');
}
return this;
}
/**
* Return a shallow copy of the alarm's options for JSON stringification.
* Third party objects like moment.js values are stringified as well. Can
* be used for persistence.
*
* @since 0.2.4
*/
toJSON (): ICalAlarmJSONData {
const trigger = this.trigger();
return Object.assign({}, this.data, {
trigger: typeof trigger === 'number' ? trigger : toJSON(trigger),
x: this.x()
});
}
/**
* Return generated event as a string.
*
* ```javascript
* const alarm = event.createAlarm();
* console.log(alarm.toString()); // → BEGIN:VALARM…
* ```
*/
toString (): string {
let g = 'BEGIN:VALARM\r\n';
// ACTION
g += 'ACTION:' + this.data.type.toUpperCase() + '\r\n';
if (typeof this.data.trigger === 'number' && this.data.relatesTo === null) {
if (this.data.trigger > 0) {
g += 'TRIGGER;RELATED=END:' + toDurationString(this.data.trigger) + '\r\n';
}
else {
g += 'TRIGGER:' + toDurationString(this.data.trigger) + '\r\n';
}
}
else if (typeof this.data.trigger === 'number') {
g += 'TRIGGER;RELATED=' + this.data.relatesTo?.toUpperCase() + ':' + toDurationString(this.data.trigger) + '\r\n';
}
else {
g += 'TRIGGER;VALUE=DATE-TIME:' + formatDate(this.event.timezone(), this.data.trigger) + '\r\n';
}
// REPEAT
if (this.data.repeat) {
if (!this.data.repeat.times) {
throw new Error('No value for `repeat.times` in ICalAlarm given, but required for `interval`!');
}
if (!this.data.repeat.interval) {
throw new Error('No value for `repeat.interval` in ICalAlarm given, but required for `repeat`!');
}
g += 'REPEAT:' + this.data.repeat.times + '\r\n';
g += 'DURATION:' + toDurationString(this.data.repeat.interval) + '\r\n';
}
// ATTACH
if (this.data.type === 'audio' && this.data.attach && this.data.attach.mime) {
g += 'ATTACH;FMTTYPE=' + escape(this.data.attach.mime, false) + ':' + escape(this.data.attach.uri, false) + '\r\n';
}
else if (this.data.type === 'audio' && this.data.attach) {
g += 'ATTACH;VALUE=URI:' + escape(this.data.attach.uri, false) + '\r\n';
}
else if (this.data.type === 'audio') {
g += 'ATTACH;VALUE=URI:Basso\r\n';
}
// DESCRIPTION
if (this.data.type !== 'audio' && this.data.description) {
g += 'DESCRIPTION:' + escape(this.data.description, false) + '\r\n';
}
else if (this.data.type !== 'audio') {
g += 'DESCRIPTION:' + escape(this.event.summary(), false) + '\r\n';
}
// SUMMARY
if (this.data.type === 'email' && this.data.summary) {
g += 'SUMMARY:' + escape(this.data.summary, false) + '\r\n';
}
else if (this.data.type === 'email') {
g += 'SUMMARY:' + escape(this.event.summary(), false) + '\r\n';
}
// ATTENDEES
if (this.data.type === 'email') {
this.data.attendees.forEach(attendee => {
g += attendee.toString();
});
}
// CUSTOM X ATTRIBUTES
g += generateCustomAttributes(this.data);
g += 'END:VALARM\r\n';
return g;
}
}
|