useDebounce

React API

Parametrit

• callback

  Pakollinen

  Suoritettava funktio.

  Tyyppi: (...args: unknown[]) => unknown

• delay

  Pakollinen

  Viive millisekunteina. Funktio suoritetaan korkeintaan kerran annetussa aikaikkunassa.

  Tyyppi: number

• options

  Lodashin debounce-funktion options-parametri. Kertoo suoritetaanko funktio aikaikkunan alussa vai lopussa. Sallii myös maksimiajan asettamisen funktion suorittamisen odottamiselle.

  Tyyppi: UseDebounceOptions

  Parametrit

  Nimi	Tyyppi	Oletusarvo
  leading	boolean	false
  trailing	boolean	true
  maxWait	boolean	-

Paluuarvot

• debounced

  Funktio, joka suoritetaan viivästytetysti.

  Tyyppi: () => void

• cancel

  Funktio, joka keskeyttää viivästytetyn suorituksen (kutsutaan automaattisesti komponentin unmount-vaiheessa).

  Tyyppi: () => void

• flush

  Funktio, joka suorittaa viivästytetyn funktion välittömästi.

  Tyyppi: () => void