timers

Documentation

Overview

Package timers brings JavaScript's timing functions to Go, with the same names and argument order: SetTimeout and SetInterval (with ClearTimeout and ClearInterval to cancel), plus lodash's Debounce and Throttle.

// JS: const id = setTimeout(() => save(), 200); clearTimeout(id);
t := timers.SetTimeout(save, 200*time.Millisecond)
timers.ClearTimeout(t)

Like their JavaScript counterparts, these take no context: the returned handle (or the cancel function from Debounce/Throttle) is how you stop them.

Index

• func ClearInterval(iv *Interval)
• func ClearTimeout(t *Timeout)
• func Debounce(fn func(), d time.Duration) (debounced func(), cancel func())
• func Throttle(fn func(), d time.Duration) (throttled func(), cancel func())
• type Interval
  • func SetInterval(fn func(), d time.Duration) *Interval
• type Timeout
  • func SetTimeout(fn func(), d time.Duration) *Timeout

Functions

func ClearInterval

func ClearInterval(iv *Interval)

ClearInterval stops a running Interval, mirroring clearInterval(id). It is idempotent, and a nil handle is a no-op.

func ClearTimeout

func ClearTimeout(t *Timeout)

ClearTimeout cancels a pending Timeout if it has not fired yet, mirroring clearTimeout(id). A nil handle is a no-op.

func Debounce

func Debounce(fn func(), d time.Duration) (debounced func(), cancel func())

Debounce returns a debounced wrapper around fn: each call to debounced postpones fn until d has passed with no further calls, so a burst of calls runs fn once, at the end. It mirrors lodash's _.debounce. cancel discards any pending call.

func Throttle

func Throttle(fn func(), d time.Duration) (throttled func(), cancel func())

Throttle returns a throttled wrapper around fn that runs fn at most once per d on the leading edge: the first call runs immediately, and further calls within the same window are dropped. It mirrors lodash's _.throttle. cancel resets the window so the next call runs immediately.

Types

type Interval

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

Interval is the handle returned by SetInterval. Pass it to ClearInterval to stop the repeating calls.

func SetInterval

func SetInterval(fn func(), d time.Duration) *Interval

SetInterval calls fn every d, mirroring JavaScript's setInterval(fn, ms). The calls run on a dedicated goroutine, one after another; a slow fn delays the next tick rather than overlapping. Stop it with ClearInterval.

type Timeout

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

Timeout is the handle returned by SetTimeout, the analogue of the timer id setTimeout returns in JavaScript. Pass it to ClearTimeout to cancel.

func SetTimeout

func SetTimeout(fn func(), d time.Duration) *Timeout

SetTimeout runs fn once after d elapses, mirroring JavaScript's setTimeout(fn, ms). fn runs on its own goroutine. The returned Timeout can be passed to ClearTimeout to cancel before it fires.