Members
isEnabled
- Source:
isEnabled
Properties:
| Name | Type | Description |
|---|---|---|
value |
boolean |
- Source:
Methods
(generator) preliminaryEvents(afteropt, beforeopt) → {IterableIterator.<PreliminaryScheduleEvent.<Schedule, undefined>>}
Returns the preliminary events for this Schedule in the interval as
delimitated by after and before. The preliminary events returned de-
pend on the Schedule's concrete implementation and some Schedule may
not return any preliminary events. Ultimately, the Scheduler will
schedule events, with no guarantee that these will coincide with the
Schedule's reported preliminary events.
Note that if either after or before (or both) are omitted and the
current Schedule does not support unbounded intervals, an Error must
thrown by it.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
after |
Date |
<optional> |
Optional. Defaults to undefined. An inclusive start date and time. |
before |
Date |
<optional> |
Optional. Defaults to undefined. An exclusive end date and time. |
- Source:
Throws:
-
If the schedule does not support unbounded intervals.
- Type
- Error
Returns:
- Type
- IterableIterator.<PreliminaryScheduleEvent.<Schedule, undefined>>
(async) teardown()
Override and use this function for teardown logic as required by the
specific sub-class. This method is useful e.g. clearing timeouts.
- Source: