Loop | KofiLoop

The loop handler.

internal

Hierarchy

EventEmitter
- Loop

Index

Constructors

constructor

Properties

Constructors

constructor

new Loop(handler: Promise<any> | function, interval: number, ...args: any[]): Loop

- Defined in Loop.ts:41
Constructor of the Loop class.

internal

Parameters
- handler: Promise<any> | function
- interval: number
- Rest ...args: any[]
Returns Loop

Properties

args

args: any[]

finishEventCalled

finishEventCalled: boolean = false

interval

interval: number

loopReturn

loopReturn: LoopReturn

loopSelf

loopSelf: LoopSelf

status

status: LoopStatus

Methods

executeStep

executeStep(): undefined | this

- Defined in Loop.ts:121
Executes a step.

Returns undefined | this

finishStep

finishStep(): void

- Defined in Loop.ts:190
Finishs the current step and starts a new step.

Returns void

getReturnValue

getReturnValue(): LoopReturn

- Defined in Loop.ts:113
Gets the loop return value.

Returns LoopReturn

isStopped

isStopped(): boolean

- Defined in Loop.ts:99
Returns if loop is stopped.

Returns boolean

listenEvents

listenEvents(): void

- Defined in Loop.ts:206
Registers events.

Returns void

measureTime

measureTime(start?: [number, number]): number | Object

- Defined in Loop.ts:75
Parameters
- Optional start: [number, number]
Returns number | Object

run

run(): void

- Defined in Loop.ts:85
Runs the loop.

throws

{\Error} if loop is not stopped.

Returns void

Generated using TypeDoc