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

Jump to bottom

Updated docs with correct type for string dates #250

Merged
merged 1 commit into from
Oct 12, 2019
Merged

Updated docs with correct type for string dates #250

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,8 @@ RNCalendarEvents.fetchAllEvents(startDate, endDate, calendars)
```

Arguments:
- startDate: Date - The start date of the range of events fetched.
- endDate: Date - The end date of the range of events fetched.
- startDate: String - The start date of the range of events fetched.
- endDate: String - The end date of the range of events fetched.
- calendars: Array - List of calendar id strings to specify calendar events. Defaults to all calendars if empty.

Returns: **Promise**
Expand Down Expand Up @@ -215,12 +215,12 @@ Returns: **Promise**
| **id*** | String | Unique id for the calendar event. | ✓ | ✓ |
| **calendarId**** | String | Unique id for the calendar where the event will be saved. Defaults to the device's default calendar. | ✓ | ✓ |
| **title** | String | The title for the calendar event. | ✓ | ✓ |
| **startDate** | Date | The start date of the calendar event in ISO format. | ✓ | ✓ |
| **endDate** | Date | The end date of the calendar event in ISO format. | ✓ | ✓ |
| **startDate** | String | The start date of the calendar event in ISO format. | ✓ | ✓ |
| **endDate** | String | The end date of the calendar event in ISO format. | ✓ | ✓ |
| **allDay** | Bool | Indicates whether the event is an all-day event. | ✓ | ✓ |
| **recurrence** | String | The simple recurrence frequency of the calendar event `daily`, `weekly`, `monthly`, `yearly` or none. | ✓ | ✓ |
| [**recurrenceRule**](#recurrence-rule) ** | Object | The events recurrence settings. | ✓ | ✓ |
| **occurrenceDate*** | Date | The original occurrence date of an event if it is part of a recurring series. | ✓ | |
| **occurrenceDate*** | String | The original occurrence date of an event if it is part of a recurring series. | ✓ | |
| **isDetached** | Bool | Indicates whether an event is a detached instance of a repeating event. | ✓ | |
| **url** | String | The url associated with the calendar event. | ✓ | |
| **location** | String | The location associated with the calendar event. | ✓ | ✓ |
Expand Down Expand Up @@ -258,7 +258,7 @@ Returns: **Promise**
| Property | Type | Description | iOS | Android |
| :--------------- | :---------------- | :----------- | :-----------: | :-----------: |
| **frequency** | String | Event recurring frequency. Allowed values are `daily`, `weekly`, `monthly`, `yearly`. | ✓ | ✓ |
| **endDate** | Date | Event recurring end date. This overrides occurrence. | ✓ | ✓ |
| **endDate** | String | Event recurring end date. This overrides occurrence. | ✓ | ✓ |
| **occurrence** | Number | Number of event occurrences. | ✓ | ✓ |
| **interval** | Number | The interval between events of this recurrence. | ✓ | ✓ |

Expand All @@ -267,7 +267,7 @@ Returns: **Promise**

| Property | Type | Description | iOS | Android |
| :--------------- | :------------------| :----------- | :-----------: | :-----------: |
| **date** | Date or Number | If a Date is given, an alarm will be set with an absolute date. If a Number is given, an alarm will be set with a relative offset (in minutes) from the start date. | ✓ | ✓ |
| **date** | String or Number | If a String is given, an alarm will be set with an absolute date. If a Number is given, an alarm will be set with a relative offset (in minutes) from the start date. | ✓ | ✓ |
| [**structuredLocation**](#alarm-structuredlocation) | Object | The location to trigger an alarm. | ✓ | |


Expand All @@ -284,7 +284,7 @@ Returns: **Promise**
### Options
| Property | Type | Description | iOS | Android |
| :--------------- | :---------------- | :----------- | :-----------: | :-----------: |
| **exceptionDate** | Date | The start date of a recurring event's exception instance. Used for updating single event in a recurring series | ✓ | ✓ |
| **exceptionDate** | String | The start date of a recurring event's exception instance. Used for updating single event in a recurring series | ✓ | ✓ |
| **futureEvents** | Bool | If `true` the update will span all future events. If `false` it only update the single instance. | ✓ | |

### Calendar options
Expand Down