useThrottle

React API

Parametrit

• callback

  Pakollinen

  Suoritettava funktio.

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

• delay

  Pakollinen

  Viive millisekunteina.

  Tyyppi: number

• options

  Lodashin throttle-funktion options-parametri. Kertoo suoritetaanko funktio aikaikkunan alussa vai lopussa.

  Tyyppi: UseThrottleOptions

  Parametrit

  Nimi	Tyyppi	Oletusarvo
  leading	boolean	false
  trailing	boolean	true

Paluuarvot

• throttled

  Funktio, joka suoritetaan rajoitetusti.

  Tyyppi: () => void

• cancel

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

  Tyyppi: () => void

• flush

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

  Tyyppi: () => void