Class TaskLooper

constructor

• new TaskLooper(fn): TaskLooper

• Build the looper with a function to invoke on a fixed period loop.

  Parameters

  • fn: (() => Promise<void>)

    the async function to invoke

    • • (): Promise<void>

      • Returns Promise<void>

  Returns TaskLooper

_fn

_isLooping

_isStarted

_periodInMs

_timeout

_runLoop

• _runLoop(targetFixedPeriod): Promise<void>

• Parameters

  • targetFixedPeriod: boolean

  Returns Promise<void>

getTask

• getTask(): (() => Promise<void>)

• Get the task function to invoke on a fixed period loop.

  Returns (() => Promise<void>)

  the task function

  • • (): Promise<void>

    • Returns Promise<void>

isStarted

• isStarted(): boolean

• Indicates if looping.

  Returns boolean

  true if looping, false otherwise

setPeriodInMs

• setPeriodInMs(periodInMs): void

• Set the loop period in milliseconds.

  Parameters

  • periodInMs: any

    the loop period in milliseconds

  Returns void

start

• start(periodInMs, targetFixedPeriod?): void

• Start the task loop.

  Parameters

  • periodInMs: number

    the loop period in milliseconds

  • Optional targetFixedPeriod: boolean

    specifies if the task should target a fixed period by accounting for run time (default false)

  Returns void

  this instance for chaining

stop

• stop(): void

• Stop the task loop.

  Returns void