debouncer

Documentation

Index

• func SleepContext(ctx context.Context, dur time.Duration) error
• func SleepContextOrInterrupt[T any](ctx context.Context, dur time.Duration, ch <-chan T) (*T, error)
• type Debouncer
  • func NewDebouncer(delay time.Duration) *Debouncer
  • func (d *Debouncer) Listen(ctx context.Context, action func() error) error
  • func (d *Debouncer) Trigger()

Functions

func SleepContext

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

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.

Types

type Debouncer

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

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 (*Debouncer) Listen

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

Listen calls action based on the trigger events.

func (*Debouncer) Trigger

func (d *Debouncer) Trigger()

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