github/awesome-cordova-plugins
3
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2026-05-02 00:07:23 +08:00
Code Issues Projects Releases Wiki Activity

docs(all): standardizes and adds return types, also some param fixes

Browse Source
This commit is contained in:
Alex Muramoto
2016-11-29 16:40:50 -06:00
parent b7a562053a
commit 3da2831779
88 changed files with 635 additions and 347 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/plugins/calendar.ts
+11 -11
View File
@@ -99,7 +99,7 @@ export class Calendar {
* Create a calendar. (iOS only)
*
* @param {string | Object} nameOrOptions either a string name or a options object. If string, provide the calendar name. IF an object, provide a calendar name as a string and a calendar color in hex format as a string
* @return {Promise} Returns a Promise
* @returns {Promise<any>} Returns a Promise
*/
@Cordova()
static createCalendar(
@@ -109,7 +109,7 @@ export class Calendar {
/**
* Delete a calendar. (iOS only)
* @param {string} name Name of the calendar to delete.
* @return Returns a Promise
* @returns {Promise<any>} Returns a Promise
*/
@Cordova()
static deleteCalendar(name: string): Promise<any> { return; }
@@ -150,7 +150,7 @@ export class Calendar {
* @param {string} [notes] The event notes
* @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date
* @return Returns a Promise
* @returns {Promise<any>} Returns a Promise
*/
@Cordova()
static createEvent(
@@ -170,7 +170,7 @@ export class Calendar {
* @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date
* @param {CalendarOptions} [options] Additional options, see `getCalendarOptions`
* @return Returns a Promise
* @returns {Promise<any>} Returns a Promise
*/
@Cordova()
static createEventWithOptions(
@@ -190,7 +190,7 @@ export class Calendar {
* @param {string} [notes] The event notes
* @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date
* @return Returns a Promise
* @returns {Promise<any>} Returns a Promise
*/
@Cordova()
static createEventInteractively(
@@ -210,7 +210,7 @@ export class Calendar {
* @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date
* @param {CalendarOptions} [options] Additional options, see `getCalendarOptions`
* @return Returns a Promise
* @returns {Promise<any>}
*/
@Cordova()
static createEventInteractivelyWithOptions(
@@ -241,7 +241,7 @@ export class Calendar {
* @param {string} [notes] The event notes
* @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date
* @return Returns a Promise
* @returns {Promise<any>}
*/
@Cordova()
static findEvent(
@@ -260,7 +260,7 @@ export class Calendar {
* @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date
* @param {CalendarOptions} [options] Additional options, see `getCalendarOptions`
* @return Returns a Promise that resolves with the event, or rejects with an error.
* @returns {Promise<any>} Returns a Promise that resolves with the event, or rejects with an error.
*/
@Cordova()
static findEventWithOptions(
@@ -277,21 +277,21 @@ export class Calendar {
*
* @param {Date} [startDate] The start date
* @param {Date} [endDate] The end date
* @return Returns a Promise that resolves with the list of events, or rejects with an error.
* @returns {Promise<any>} Returns a Promise that resolves with the list of events, or rejects with an error.
*/
@Cordova()
static listEventsInRange(startDate: Date, endDate: Date): Promise<any> { return; }
/**
* Get a list of all calendars.
* @return A Promise that resolves with the list of calendars, or rejects with an error.
* @returns {Promise<any>} A Promise that resolves with the list of calendars, or rejects with an error.
*/
@Cordova()
static listCalendars(): Promise<any> { return; }
/**
* Get a list of all future events in the specified calendar. (iOS only)
* @return Returns a Promise that resolves with the list of events, or rejects with an error.
* @returns {Promise<any>} Returns a Promise that resolves with the list of events, or rejects with an error.
*/
@Cordova()
static findAllEventsInNamedCalendar(calendarName: string): Promise<any> { return; }