debounce – github.com/bep/debounce Index | Examples | Files

package debounce

import "github.com/bep/debounce"

Package debounce provides a debouncer func. The most typical use case would be the user typing a text into a form; the UI needs an update, but let's wait for a break.

Index

Examples

Functions

func New

func New(d time.Duration) (func(f func()), chan struct{})

New returns a debounced function and a channel that can be closed to signal a stop of the goroutine. The function will, as long as it continues to be invoked, not be triggered. The function will be called after it stops being called for the given duration. The created debounced function can be invoked with different functions, if needed, the last one will win. Also note that a stop signal means a full stop of the debouncer; there is no concept of flushing future invocations.

Example

Code:play 

package main

import (
	"fmt"
	"sync/atomic"
	"time"

	"github.com/bep/debounce"
)

func main() {
	var counter uint64

	f := func() {
		atomic.AddUint64(&counter, 1)
	}

	debounced, finish := debounce.New(100 * time.Millisecond)

	for i := 0; i < 3; i++ {
		for j := 0; j < 10; j++ {
			debounced(f)
		}

		time.Sleep(200 * time.Millisecond)
	}

	close(finish)

	<-time.After(200 * time.Millisecond)

	c := int(atomic.LoadUint64(&counter))

	fmt.Println("Counter is", c)
}

Output:

Counter is 3

Source Files

debounce.go

Version
v1.0.0
Published
Apr 7, 2018
Platform
js/wasm
Imports
1 packages
Last checked
now

Tools for package owners.