Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TaskLooper

Run a task in a fixed period loop.

Hierarchy

  • TaskLooper

Index

Constructors

Properties

Methods

Constructors

constructor

  • new TaskLooper(fn: () => Promise<void>): 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

Properties

_fn

_fn: () => Promise<void>

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

_isLooping

_isLooping: boolean

_isStarted

_isStarted: boolean

_timeout

_timeout: undefined | Timeout

Methods

_runLoop

  • _runLoop(periodInMs: number): Promise<void>

start

  • start(periodInMs: number): void

  • Start the task loop.

    Parameters

    • periodInMs: number

      the loop period in milliseconds

    Returns void

stop

  • stop(): void

Generated using TypeDoc