timer

Documentation

Overview

Package timer provides setTimeout, setInterval, Sleep and Ticker helpers for wings.

Index

• func SetInterval(fn func(), interval int) (cancel func())
• func SetTimeout(fn func(), delay int) <-chan struct{}
• func Sleep(ms int)
• type Ticker
  • func NewTicker(ms int) *Ticker
  • func (tk *Ticker) Stop()

Functions

func SetInterval

func SetInterval(fn func(), interval int) (cancel func())

SetInterval schedules fn to run every interval milliseconds. Returns a cancel() function that stops the interval.

func SetTimeout

func SetTimeout(fn func(), delay int) <-chan struct{}

SetTimeout schedules fn to run after delay milliseconds. Returns a channel that closes when fn completes.

func Sleep

func Sleep(ms int)

Sleep blocks the current goroutine for ms milliseconds, yielding control to the JavaScript event loop while waiting.

Types

type Ticker

type Ticker struct {
	Tick chan struct{}
	// contains filtered or unexported fields
}

Ticker sends on Tick at the configured interval.

func NewTicker

func NewTicker(ms int) *Ticker

NewTicker returns a Ticker that sends on Tick every ms milliseconds. Call Stop() to release resources.

func (*Ticker) Stop

func (tk *Ticker) Stop()

Stop stops the ticker and releases resources.