Interface RepeatOptions

The options to use when creating a Repeat instance

Hierarchy

  • RepeatOptions

Properties

maxFailures? maxRuns? onComplete? onError? onFail? onStart? runOnStart? startOnInit? timeout?

Properties

Optional maxFailures

maxFailures?: number

The maximum number of consecutive failures to allow before terminating the operation

Remarks

If set, onFail will be called once after the last failed repetition

Default

Infinity

Optional maxRuns

maxRuns?: number

The maximum number of repetitions to perform before terminating

Remarks

If set, onComplete will be called once after the last repetition

Default

Infinity

Optional onComplete

onComplete?: OnComplete

Called once after maxRuns is reached

Optional onError

onError?: OnError

Called whenever RepeatTask throws an error

Optional onFail

onFail?: OnFail

Called once after maxFailures is reached

Optional onStart

onStart?: OnStart

Called once at the start of the operation

Optional runOnStart

runOnStart?: boolean

Run task immediately after start is called, otherwise wait until the first timeout is reached

Default

true

Optional startOnInit

startOnInit?: boolean

Start the repeat operation immediately after Repeat is created, otherwise wait until start is called

Default

true

Optional timeout

timeout?: number

The number of milliseconds to wait between each repetition

Settings

Member Visibility

Theme

Generated using TypeDoc