Class Repeat

A class that repeats a task at a given interval

Hierarchy

Repeat

Index

Constructors

Accessors

Methods

Constructors

constructor

new Repeat(task: RepeatTask, options?: RepeatOptions): Repeat
Create a new Repeat instance
Parameters
- task: RepeatTask
  
  The task function to repeat
- Optional options: RepeatOptions
  
  Options
Returns Repeat
- Defined in packages/repeat/src/repeat.ts:171
new Repeat(task: RepeatTask, timeout: number, options?: RepeatOptions): Repeat
Create a new Repeat instance
Parameters
- task: RepeatTask
  
  The task function to repeat
- timeout: number
  
  The number of milliseconds to wait between repeats
- Optional options: RepeatOptions
  
  Options
Returns Repeat
- Defined in packages/repeat/src/repeat.ts:179

Accessors

isRunning

get isRunning(): boolean
Determine whether the task is running or not

Returns boolean
- Defined in packages/repeat/src/repeat.ts:237

Methods

start

start(): Repeat
Start the task

Returns Repeat
- Defined in packages/repeat/src/repeat.ts:215

stop

stop(): Repeat
Stop the task

Returns Repeat
- Defined in packages/repeat/src/repeat.ts:228

Generated using TypeDoc