timeout

Documentation

Index

• func Init(timeout time.Duration, data interface{}) tea.Cmd
• func Str(timeout time.Duration) string
• func Tick(timeoutValue time.Duration, data interface{}) tea.Cmd
• type TickTimeoutMsg

Functions

func Init

func Init(timeout time.Duration, data interface{}) tea.Cmd

Init Start Timeout ticker using with timeout in seconds and optional data.

func Str

func Str(timeout time.Duration) string

Str produce Timeout String to be rendered.

func Tick

func Tick(timeoutValue time.Duration, data interface{}) tea.Cmd

Start ticker.

Types

type TickTimeoutMsg

type TickTimeoutMsg struct {
	TimeoutValue time.Duration
	Data         interface{}
}

TickTimeoutMsg will be dispatched for every tick. Containing current timeout value and optional parameter to be used when handling the timeout msg.