debouncer

README

New() creates a debouncer that runs any function it is given to in some delay.
Every time .Call() is called that countdown is reset (or started) and the function to be run is overwritten.
Calling .Flush() fires the last called function immediately.
.IsRunning() can be called to check if there is any countdown happening.

Documentation

Index

• type Debouncer
  • func New(delay time.Duration) *Debouncer
  • func (d *Debouncer) Call(f func())
  • func (d *Debouncer) Flush()
  • func (d *Debouncer) IsRunning() bool
  • func (d *Debouncer) Stop()

Types

type Debouncer

type Debouncer struct {
	// contains filtered or unexported fields
}

func New

func New(delay time.Duration) *Debouncer

func (*Debouncer) Call

func (d *Debouncer) Call(f func())

Call schedules a new call, overwrites the previous

func (*Debouncer) Flush

func (d *Debouncer) Flush()

Flush calls the last debounced function immediately

func (*Debouncer) IsRunning

func (d *Debouncer) IsRunning() bool

IsRunning returns true if there is a timer running already, false if not

func (*Debouncer) Stop

func (d *Debouncer) Stop()

Stop cancels everything that might be running