new ManualSchedule(enabledopt)
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
enabled |
Boolean |
<optional> |
true | Optional. Defaults to true. |
- Source:
Extends
Members
isEnabled :Boolean
Type:
- Boolean
- Overrides:
- Source:
observable :Observable.<T>
Type:
- Observable.<T>
- 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. |
- Overrides:
- 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.
- Overrides:
- Source:
trigger(item) → {this}
The main method to trigger an event on this schedule, that will be observed
by the scheduler.
Parameters:
| Name | Type | Description |
|---|---|---|
item |
T |
- Deprecated:
- Use triggerNext() instead. This method will be removed in v3.x!
- Source:
Returns:
- Type
- this
triggerComplete() → {this}
Will trigger this schedule's Observable's complete-function. Note that the
Observable will end then (i.e. no new items or complete will be emitted).
- Source:
Returns:
- Type
- this
triggerError(error) → {this}
Will emit an error on this schedule's Observable. Note that the Observable
will end then (i.e. no new items or complete will be emitted).
Parameters:
| Name | Type | Description |
|---|---|---|
error |
any |
- Source:
Returns:
- Type
- this
triggerNext(item) → {this}
Calls trigger() and has been added for compatibility reasons to Observable.
Parameters:
| Name | Type | Description |
|---|---|---|
item |
T |
- Source:
Returns:
- Type
- this