Options
All
  • Public
  • Public/Protected
  • All
Menu

Options for debounce

Type parameters

Hierarchy

  • DebounceOptions

Index

Properties

Optional maxCalls

maxCalls: undefined | number

The maximum number of calls before the function will be executed

Optional maxDelay

maxDelay: undefined | number

The maximum number of milliseconds before the function will be executed. If execution has not happened as calls are still occuring then this the maximum number of milliseconds allowed to pass before the function will be executed.

Optional onCancel

onCancel: undefined | (() => any)

If supplied this function will be called if the debounced function is cancelled defaults

Optional reducer

reducer: Reducer

Used to create the arguments to fn when it is executed. It is run for every call of the debounced function. The default implementation is to execute func with the latest arguments.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc