Class DebouncedJob<T, R>

An util for retaining an unique snapshot of data while the previous snapshot is being processed

Type Parameters

T = void
R = unknown

Hierarchy

DebouncedJob
- DebouncedJobRunner

Index

Constructors

Properties

callback lastRun pendingData pendingRun running throttle

Methods

_run _runLoop run

Constructors

constructor

new DebouncedJob<T, R>(callback: ((data: T) => Promise<R>), throttle?: number): DebouncedJob<T, R>
Type Parameters
- T = void
- R = unknown
Parameters
- callback: ((data: T) => Promise<R>)
  - - (data: T): Promise<R>
    - Parameters
      
      data: T
      
      Returns Promise<R>
- throttle: number = 0
Returns DebouncedJob<T, R>
- Defined in packages/core/src/utils/concurrence/common.ts:126

Properties

`Protected` callback

callback: ((data: T) => Promise<R>)

Type declaration

- (data: T): Promise<R>
- Parameters
  - data: T
  Returns Promise<R>

`Protected` lastRun

lastRun: number = 0

`Protected` pendingData

pendingData: undefined | T

`Protected` pendingRun

pendingRun: boolean = false

`Protected` running

running: boolean = false

`Protected` throttle

throttle: number = 0

Methods

`Protected` _run

_run(): Promise<void | R>
Returns Promise<void | R>
- Defined in packages/core/src/utils/concurrence/common.ts:137

`Protected` _runLoop

_runLoop(): Promise<void | R>
Returns Promise<void | R>
- Defined in packages/core/src/utils/concurrence/common.ts:148

run

run(data: T): Promise<void | R>
Parameters
- data: T
Returns Promise<void | R>
- Defined in packages/core/src/utils/concurrence/common.ts:131

Generated using TypeDoc