## Scheduler Used to run functions at specified intervals or times of day. **Kind**: global class * [Scheduler](#Scheduler) * [new Scheduler(f)](#new_Scheduler_new) * [.onMarketOpen(offset)](#Scheduler+onMarketOpen) ⇒ Promise.<Date> * [.onMarketClose(offset)](#Scheduler+onMarketClose) ⇒ Promise.<schedule> * [.every(minutes, extended)](#Scheduler+every) * [.cancel()](#Scheduler+cancel) * [.getNext()](#Scheduler+getNext) ⇒ Date \| Error ### new Scheduler(f) Creates a new scheduled task | Param | Type | | --- | --- | | f | function | ### scheduler.onMarketOpen(offset) ⇒ Promise.<Date> Runs every day on market open. **Kind**: instance method of [Scheduler](#Scheduler) **Returns**: Promise.<Date> - - Date object of next invocation. | Param | Type | Description | | --- | --- | --- | | offset | Number | The offset, in milliseconds, from market open to run the algorithm. Negative is before, positive is after. | ### scheduler.onMarketClose(offset) ⇒ Promise.<schedule> Runs every day on market close. **Kind**: instance method of [Scheduler](#Scheduler) | Param | Type | Description | | --- | --- | --- | | offset | Number | The offset, in milliseconds, from market close to run the algorithm. Negative is before, positive is after. | ### scheduler.every(minutes, extended) Runs every 'x' minutes while the market is open. **Kind**: instance method of [Scheduler](#Scheduler) | Param | Type | Description | | --- | --- | --- | | minutes | Number | | | extended | Boolean | Whether to run during extended trading hours. | ### scheduler.cancel() Cancels a job. **Kind**: instance method of [Scheduler](#Scheduler) ### scheduler.getNext() ⇒ Date \| Error Returns the date of the next invocation of the given job. **Kind**: instance method of [Scheduler](#Scheduler)