debouncer

package

v0.0.3 Latest Latest Go to latest Published: Jun 11, 2022 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func SleepContext(ctx context.Context, dur time.Duration) error

SleepContext sleeps for the provided duration unless the context is cancelled first. An error is returned if the context is cancelled.

func SleepContextOrInterrupt[T any](ctx context.Context, dur time.Duration, ch <-chan T) (*T, error)

SleepContextOrInterrupt sleeps for a given duration unless interrupted by a message on the given channel.

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

Debouncer is a name taken from JavaScript Reactive programming. It allows firing many events in succession but only triggering one output event.

func NewDebouncer(delay time.Duration) *Debouncer

NewDebouncer creates a new debouncer that ensures at least [delay] time period has occurred before triggering an output event.

func (d *Debouncer) Listen(ctx context.Context, action func() error) error

Listen calls action based on the trigger events.

func (d *Debouncer) Trigger()

Trigger is the input event that causes a debounce action to occur (in wait).