Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ThrottleQueue<TTaskResult>

ThrottleQueue ensures that in every time block separated by throttler will be runned only one task (function run)

Imagine timeline of task runs:

Input: __🥝🍓🍋_____🍏🍍🍇__🍉_🍌🍒___🥑🍎🍈

Output: _________🍋🍋🍋_________🍇🍇🍇_🍉_🍒🍒_🍈🍈🍈

TODO: Error handling TODO: Probably debouncing TODO: timeouts

collboard-modules-sdk

Type parameters

  • TTaskResult

Hierarchy

  • Destroyable
    • ThrottleQueue

Implements

  • ITaskRunner<TTaskResult>
  • IDestroyable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Type parameters

    • TTaskResult

    Parameters

    Returns ThrottleQueue<TTaskResult>

Properties

Private options

options: any

Private result

result: any

Private runner

runner: any

Private throttles

throttles: any

Accessors

isDestroyed

  • get isDestroyed(): boolean

  • Is this object destroyed?

    Returns boolean

Methods

addSubdestroyable

  • addSubdestroyable(...subdestroyable: ITeardownLogic[]): ThrottleQueue<TTaskResult>

  • Binds new registration with itself. This registration/destroyable will be destroyed with this.

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns ThrottleQueue<TTaskResult>

Protected checkWhetherNotDestroyed

  • checkWhetherNotDestroyed(errorMessage?: string, runBeforeError?: () => void): void

  • Checks, whether the object is not destroyed

    Parameters

    • Optional errorMessage: string

      Message that will replace default one before error

    • Optional runBeforeError: () => void

      Callback runed before error is thrown; typically this can be some logging

        • (): void

        • Returns void

    Returns void

destroy

  • destroy(): Promise<void>

  • Returns Promise<void>

task

  • task(runner: () => Promisable<TTaskResult>): Promise<TTaskResult>

  • Parameters

    • runner: () => Promisable<TTaskResult>
        • (): Promisable<TTaskResult>

        • Returns Promisable<TTaskResult>

    Returns Promise<TTaskResult>

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable