Skip to content

Commit

Permalink
docs: Updated for v6.0.2-develop.8
Browse files Browse the repository at this point in the history
  • Loading branch information
@semantic-release-bot
semantic-release-bot committed Feb 16, 2024
1 parent 13ac5cd commit bc984bc
Show file tree
Hide file tree
Showing 72 changed files with 1,982 additions and 1,921 deletions.
26 changes: 13 additions & 13 deletions develop/coverage/alarm.ts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1388,11 +1388,11 @@ <h1><a href="index.html">All files</a> alarm.ts</h1>
ICalAlarmTriggerAfterData |
ICalAlarmTriggerBeforeData;
&nbsp;
type ICalAlarmTriggerData = ICalAlarmBaseData &amp; { trigger: number | ICalDateTimeValue };
type ICalAlarmTriggerAfterData = ICalAlarmBaseData &amp; { triggerAfter: number | ICalDateTimeValue };
type ICalAlarmTriggerBeforeData = ICalAlarmBaseData &amp; { triggerBefore: number | ICalDateTimeValue };
export type ICalAlarmTriggerData = ICalAlarmBaseData &amp; { trigger: number | ICalDateTimeValue };
export type ICalAlarmTriggerAfterData = ICalAlarmBaseData &amp; { triggerAfter: number | ICalDateTimeValue };
export type ICalAlarmTriggerBeforeData = ICalAlarmBaseData &amp; { triggerBefore: number | ICalDateTimeValue };
&nbsp;
interface ICalAlarmBaseData {
export interface ICalAlarmBaseData {
type?: ICalAlarmType;
relatesTo?: ICalAlarmRelatesTo | null;
repeat?: ICalAlarmRepeatData | null;
Expand Down Expand Up @@ -1430,7 +1430,7 @@ <h1><a href="index.html">All files</a> alarm.ts</h1>
&nbsp;
&nbsp;
/**
* Usually you get an `ICalAlarm` object like this:
* Usually you get an {@link ICalAlarm} object like this:
*
* ```javascript
* import ical from 'ical-generator';
Expand All @@ -1439,7 +1439,7 @@ <h1><a href="index.html">All files</a> alarm.ts</h1>
* const alarm = event.createAlarm();
* ```
*
* You can also use the [[`ICalAlarm`]] object directly:
* You can also use the {@link ICalAlarm} object directly:
*
* ```javascript
* import ical, {ICalAlarm} from 'ical-generator';
Expand All @@ -1452,11 +1452,11 @@ <h1><a href="index.html">All files</a> alarm.ts</h1>
private readonly event: ICalEvent;
&nbsp;
/**
* Constructor of [[`ICalAttendee`]]. The event reference is required
* Constructor of {@link ICalAttendee}. The event reference is required
* to query the calendar's timezone and summary when required.
*
* @param data Alarm Data
* @param calendar Reference to ICalEvent object
* @param event Reference to ICalEvent object
*/
constructor (data: ICalAlarmData, event: ICalEvent) {
this.data = {
Expand Down Expand Up @@ -1493,7 +1493,7 @@ <h1><a href="index.html">All files</a> alarm.ts</h1>
type (type: ICalAlarmType): this;
&nbsp;
/**
* Set the alarm type. See [[`ICalAlarmType`]]
* Set the alarm type. See {@link ICalAlarmType}
* for available status options.
* @since 0.2.1
*/
Expand All @@ -1513,7 +1513,7 @@ <h1><a href="index.html">All files</a> alarm.ts</h1>
&nbsp;
/**
* Get the trigger time for the alarm. Can either
* be a date and time value ([[`ICalDateTimeValue`]]) or
* 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.
Expand Down Expand Up @@ -1617,7 +1617,7 @@ <h1><a href="index.html">All files</a> alarm.ts</h1>
&nbsp;
/**
* Get the trigger time for the alarm. Can either
* be a date and time value ([[`ICalDateTimeValue`]]) or
* 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.
Expand Down Expand Up @@ -1656,7 +1656,7 @@ <h1><a href="index.html">All files</a> alarm.ts</h1>
&nbsp;
/**
* Get the trigger time for the alarm. Can either
* be a date and time value ([[`ICalDateTimeValue`]]) or
* 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.
Expand Down Expand Up @@ -1999,7 +1999,7 @@ <h1><a href="index.html">All files</a> alarm.ts</h1>
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2024-02-13T09:07:26.539Z
at 2024-02-16T18:34:31.922Z
</div>
<script src="prettify.js"></script>
<script>
Expand Down
24 changes: 12 additions & 12 deletions develop/coverage/attendee.ts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1374,7 +1374,7 @@ <h1><a href="index.html">All files</a> attendee.ts</h1>
&nbsp;
&nbsp;
/**
* Usually you get an `ICalAttendee` object like this:
* Usually you get an {@link ICalAttendee} object like this:
*
* ```javascript
* import ical from 'ical-generator';
Expand All @@ -1383,7 +1383,7 @@ <h1><a href="index.html">All files</a> attendee.ts</h1>
* const attendee = event.createAttendee({ email: '[email protected]' });
* ```
*
* You can also use the [[`ICalAttendee`]] object directly:
* You can also use the {@link ICalAttendee} object directly:
*
* ```javascript
* import ical, {ICalAttendee} from 'ical-generator';
Expand All @@ -1396,11 +1396,11 @@ <h1><a href="index.html">All files</a> attendee.ts</h1>
private readonly event: ICalEvent;
&nbsp;
/**
* Constructor of [[`ICalAttendee`]]. The event reference is
* Constructor of {@link ICalAttendee}. The event reference is
* required to query the calendar's timezone when required.
*
* @param data Attendee Data
* @param calendar Reference to ICalEvent object
* @param event Reference to ICalEvent object
*/
constructor(data: ICalAttendeeData, event: ICalEvent) {
this.data = {
Expand Down Expand Up @@ -1531,7 +1531,7 @@ <h1><a href="index.html">All files</a> attendee.ts</h1>
&nbsp;
/**
* Set the attendee's role, defaults to `REQ` / `REQ-PARTICIPANT`.
* Checkout [[`ICalAttendeeRole`]] for available roles.
* Checkout {@link ICalAttendeeRole} for available roles.
*
* @since 0.2.0
*/
Expand Down Expand Up @@ -1578,7 +1578,7 @@ <h1><a href="index.html">All files</a> attendee.ts</h1>
status(): ICalAttendeeStatus | null;
&nbsp;
/**
* Set the attendee's status. See [[`ICalAttendeeStatus`]]
* Set the attendee's status. See {@link ICalAttendeeStatus}
* for available status options.
*
* @since 0.2.0
Expand Down Expand Up @@ -1606,7 +1606,7 @@ <h1><a href="index.html">All files</a> attendee.ts</h1>
&nbsp;
/**
* Set attendee's type (a.k.a. CUTYPE).
* See [[`ICalAttendeeType`]] for available status options.
* See {@link ICalAttendeeType} for available status options.
*
* @since 0.2.3
*/
Expand Down Expand Up @@ -1635,7 +1635,7 @@ <h1><a href="index.html">All files</a> attendee.ts</h1>
* Set the attendee's delegated-to field.
*
* Creates a new Attendee if the passed object is not already a
* [[`ICalAttendee`]] object. Will set the `delegatedTo` and
* {@link ICalAttendee} object. Will set the `delegatedTo` and
* `delegatedFrom` attributes.
*
* Will also set the `status` to `DELEGATED`, if attribute is set.
Expand Down Expand Up @@ -1691,7 +1691,7 @@ <h1><a href="index.html">All files</a> attendee.ts</h1>
* Set the attendee's delegated-from field
*
* Creates a new Attendee if the passed object is not already a
* [[`ICalAttendee`]] object. Will set the `delegatedTo` and
* {@link ICalAttendee} object. Will set the `delegatedTo` and
* `delegatedFrom` attributes.
*
* @param delegatedFrom
Expand Down Expand Up @@ -1725,7 +1725,7 @@ <h1><a href="index.html">All files</a> attendee.ts</h1>
/**
* Create a new attendee this attendee delegates to and returns
* this new attendee. Creates a new attendee if the passed object
* is not already an [[`ICalAttendee`]].
* is not already an {@link ICalAttendee}.
*
* ```javascript
* const cal = ical();
Expand All @@ -1748,7 +1748,7 @@ <h1><a href="index.html">All files</a> attendee.ts</h1>
/**
* Create a new attendee this attendee delegates from and returns
* this new attendee. Creates a new attendee if the passed object
* is not already an [[`ICalAttendee`]].
* is not already an {@link ICalAttendee}.
*
* ```javascript
* const cal = ical();
Expand Down Expand Up @@ -1921,7 +1921,7 @@ <h1><a href="index.html">All files</a> attendee.ts</h1>
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2024-02-13T09:07:26.539Z
at 2024-02-16T18:34:31.922Z
</div>
<script src="prettify.js"></script>
<script>
Expand Down
14 changes: 7 additions & 7 deletions develop/coverage/calendar.ts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1772,7 +1772,7 @@ <h1><a href="index.html">All files</a> calendar.ts</h1>
&nbsp;
&nbsp;
/**
* Usually you get an `ICalCalendar` object like this:
* Usually you get an {@link ICalCalendar} object like this:
* ```javascript
* import ical from 'ical-generator';
* const calendar = ical();
Expand Down Expand Up @@ -1859,7 +1859,7 @@ <h1><a href="index.html">All files</a> calendar.ts</h1>
/**
* Set your feed's prodid. `prodid` can be either a
* string like `//sebbo.net//ical-generator//EN` or a
* valid [[`ICalCalendarProdIdData`]] object. `language`
* valid {@link ICalCalendarProdIdData} object. `language`
* is optional and defaults to `EN`.
*
* ```javascript
Expand Down Expand Up @@ -1907,15 +1907,15 @@ <h1><a href="index.html">All files</a> calendar.ts</h1>
&nbsp;
/**
* Get the feed method attribute.
* See [[`ICalCalendarMethod`]] for possible results.
* See {@link ICalCalendarMethod} for possible results.
*
* @since 0.2.8
*/
method(): ICalCalendarMethod | null;
&nbsp;
/**
* Set the feed method attribute.
* See [[`ICalCalendarMethod`]] for available options.
* See {@link ICalCalendarMethod} for available options.
*
* #### Typescript Example
* ```typescript
Expand Down Expand Up @@ -2014,7 +2014,7 @@ <h1><a href="index.html">All files</a> calendar.ts</h1>
* Use this method to set your feed's timezone. Is used
* to fill `TIMEZONE-ID` and `X-WR-TIMEZONE` in your iCal export.
* Please not that all date values are treaded differently, if
* a timezone was set. See [[`formatDate`]] for details. If no
* a timezone was set. See {@link formatDate} for details. If no
* time zone is specified, all information is output as UTC.
*
* ```javascript
Expand Down Expand Up @@ -2219,7 +2219,7 @@ <h1><a href="index.html">All files</a> calendar.ts</h1>
&nbsp;
&nbsp;
/**
* Creates a new [[`ICalEvent`]] and returns it. Use options to prefill the event's attributes.
* Creates a new {@link ICalEvent} and returns it. Use options to prefill the event's attributes.
* Calling this method without options will create an empty event.
*
* ```javascript
Expand Down Expand Up @@ -2521,7 +2521,7 @@ <h1><a href="index.html">All files</a> calendar.ts</h1>
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2024-02-13T09:07:26.539Z
at 2024-02-16T18:34:31.922Z
</div>
<script src="prettify.js"></script>
<script>
Expand Down
21 changes: 12 additions & 9 deletions develop/coverage/category.ts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h1><a href="index.html">All files</a> category.ts</h1>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Statements</span>
<span class='fraction'>100/100</span>
<span class='fraction'>101/101</span>
</div>


Expand All @@ -46,7 +46,7 @@ <h1><a href="index.html">All files</a> category.ts</h1>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Lines</span>
<span class='fraction'>100/100</span>
<span class='fraction'>101/101</span>
</div>


Expand Down Expand Up @@ -163,7 +163,9 @@ <h1><a href="index.html">All files</a> category.ts</h1>
<a name='L98'></a><a href='#L98'>98</a>
<a name='L99'></a><a href='#L99'>99</a>
<a name='L100'></a><a href='#L100'>100</a>
<a name='L101'></a><a href='#L101'>101</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
<a name='L101'></a><a href='#L101'>101</a>
<a name='L102'></a><a href='#L102'>102</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
Expand Down Expand Up @@ -273,15 +275,16 @@ <h1><a href="index.html">All files</a> category.ts</h1>
name: string;
}
&nbsp;
export interface ICalCategoryInternalData {
&nbsp;
export interface ICalCategoryJSONData {
name: string;
}
&nbsp;
export type ICalCategoryJSONData = ICalCategoryInternalData;
export type ICalCategoryInternalData = ICalCategoryJSONData;
&nbsp;
&nbsp;
/**
* Usually you get an `ICalCategory` object like this:
* Usually you get an {@link ICalCategory} object like this:
*
* ```javascript
* import ical from 'ical-generator';
Expand All @@ -290,7 +293,7 @@ <h1><a href="index.html">All files</a> category.ts</h1>
* const category = event.createCategory();
* ```
*
* You can also use the [[`ICalCategory`]] object directly:
* You can also use the {@link ICalCategory} object directly:
*
* ```javascript
* import ical, {ICalCategory} from 'ical-generator';
Expand All @@ -302,7 +305,7 @@ <h1><a href="index.html">All files</a> category.ts</h1>
private readonly data: ICalCategoryInternalData;
&nbsp;
/**
* Constructor of [[`ICalCategory`]].
* Constructor of {@link ICalCategory}.
* @param data Category Data
*/
constructor(data: ICalCategoryData) {
Expand Down Expand Up @@ -370,7 +373,7 @@ <h1><a href="index.html">All files</a> category.ts</h1>
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2024-02-13T09:07:26.539Z
at 2024-02-16T18:34:31.922Z
</div>
<script src="prettify.js"></script>
<script>
Expand Down
Loading

0 comments on commit bc984bc

Please sign in to comment.