LoopReturn | KofiLoop

Class returned by loops.

use_reference: Never create the object yourself and always use reference.

Hierarchy

EventEmitter
- LoopReturn

Implements

PromiseLike<any>

Index

Properties

defaultMaxListeners

Accessors

Methods

Properties

Accessors

isPending

isPending:

Boolean indicating if the loop is pending.

readonly

isStopped

isStopped:

Boolean indicating if the loop is stopped.

readonly

Methods

catch

catch(callback: function): this

- Defined in Loop.ts:524
Alias for error: Called when an uncaught error is thrown.

Parameters
- callback: function
  - - (): any
    - Returns any
Returns this

end

end(callback: function, errorCallback?: undefined | function): this

- Defined in Loop.ts:495
Called when the loop is stopped.

Parameters
- callback: function
  - - (value: any): any
    - Parameters
      - value: any
      Returns any
- Optional errorCallback: undefined | function
Returns this

error

error(callback: function): this

- Defined in Loop.ts:515
Called when an uncaught error is thrown.

Parameters
- callback: function
  - - (err: any): any
    - Parameters
      - err: any
      Returns any
Returns this

parent

parent(loop: Loop): this

- Defined in Loop.ts:415
Sets a loop as parent, and set pending for the parent loop until the end of the loop.

throws

{\Error} if parent is already defined.

Parameters
- loop: Loop
  
  The parent loop
Returns this

run

run(): this

- Defined in Loop.ts:396
Starts or restarts the loop.

Returns this

start

start(callback: function): this

- Defined in Loop.ts:445
Called when a loop is started.

Parameters
- callback: function
  - - (loop: LoopSelf): void
    - Parameters
      - loop: LoopSelf
      Returns void
Returns this

startLoop

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

- Defined in Loop.ts:433
Starts a loop after the end of the current loop.

see

LoopSelf for handler scope ('this' reference).

Parameters
- handler: Promise<any> | function
  
  The function to loop
- interval: number
  
  The interval in milliseconds
- Rest ...args: any[]
  
  Some arguments to pass to function
Returns LoopReturn

step

step(callback: function, step?: undefined | number): this

- Defined in Loop.ts:470
Called when a loop step is finished.

Parameters
- callback: function
  - - (loop: LoopSelf, value: any): void
    - Parameters
      - loop: LoopSelf
      - value: any
      Returns void
- Optional step: undefined | number
Returns this

stepStart

stepStart(callback: function, step?: undefined | number): this

- Defined in Loop.ts:455
Called when a loop step is started.

Parameters
- callback: function
  - - (loop: LoopSelf): void
    - Parameters
      - loop: LoopSelf
      Returns void
- Optional step: undefined | number
Returns this

stop

stop(): void

- Defined in Loop.ts:405
Stops the loop.

Returns void

terminated

terminated(callback: function): this

- Defined in Loop.ts:485
Called when the loop is terminated, even if there is an error.

Parameters
- callback: function
  - - (loop: LoopSelf): any
    - Parameters
      - loop: LoopSelf
      Returns any
Returns this

then

then(callback: function, errorCallback: function): this

- Defined in Loop.ts:507
Alias for end: Called when the loop is stopped.

Parameters
- callback: function
  - - (value: any): any
    - Parameters
      - value: any
      Returns any
- errorCallback: function
  - - (err: any): any
    - Parameters
      - err: any
      Returns any
Returns this

Generated using TypeDoc