DebouncedDelegate | @mantlebee/ts-core

Prevents multiple and repetitive executions of a function, in a specific time range. Delays the execution of a _delegate, if the call method is called multiple times in a time range (_delay).

Hierarchy

DebouncedDelegate

Implements

IDebouncedDelegate

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DebouncedDelegate(delegate: (() => void), delay: number): DebouncedDelegate

- Defined in src/delegates/debounced-delegate/models.ts:23
Parameters
- delegate: (() => void)
  
  {@link delegate}
  - - (): void
    - Returns void
- delay: number
  
  {@link delay}
Returns DebouncedDelegate

Properties

Private Readonly _delay

_delay: number

Milliseconds after which the _delegate must be executed.

Private Readonly _delegate

_delegate: (() => void)

Type declaration

- (): void
- Function to execute.
  
  Returns void

Private _timeout

_timeout: Nullable<number> = null

Timeout that is set and reset every time the call method is called. After its expiring, the _delegate is executed.

Methods

call

call(): void

Implementation of IDebouncedDelegate.call
- Defined in src/delegates/debounced-delegate/models.ts:31
Reset the timeout any time the method is run. When the timeout expires the _delegate is executed.

Returns void

Private clearTimeout

clearTimeout(): void

- Defined in src/delegates/debounced-delegate/models.ts:41
Stops and clears the _timeout.

Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

delegate: (() => void)

Returns void

delay: number

Returns DebouncedDelegate

Properties

Private Readonly _delay

Private Readonly _delegate

Type declaration

Returns void

Private _timeout

Methods

call

Returns void

Private clearTimeout

Returns void