timer

Documentation

Overview

Package timer provides a simple timeout component.

Index

• Constants
• type Model
  • func New() Model
  • func (m Model) Active() bool
  • func (m Model) ID() int
  • func (m Model) Idle() bool
  • func (m Model) Remaining() time.Duration
  • func (m Model) Reset() tea.Cmd
  • func (m Model) Start(end time.Time) tea.Cmd
  • func (m Model) State() State
  • func (m Model) TimedOut() bool
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View() string
• type ResetMsg
• type StartMsg
• type State
• type TickMsg
• type TimeoutMsg

Constants

const (
	StateIdle = iota
	StateActive
	StateTimedOut
)

Types

type Model

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

func New

func New() Model

New creates a new timer with the given timeout and nextTick interval.

func (Model) Active

func (m Model) Active() bool

func (Model) ID

func (m Model) ID() int

func (Model) Idle

func (m Model) Idle() bool

func (Model) Remaining

func (m Model) Remaining() time.Duration

Remaining returns the amount of time remaining if the timer is active

func (Model) Reset

func (m Model) Reset() tea.Cmd

Reset resets the timer to idle

func (Model) Start

func (m Model) Start(end time.Time) tea.Cmd

Start starts the timer with the given end time.

func (Model) State

func (m Model) State() State

func (Model) TimedOut

func (m Model) TimedOut() bool

func (Model) Update

func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)

func (Model) View

func (m Model) View() string

View of the timer component.

type ResetMsg

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

type StartMsg

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

type State

type State int

type TickMsg

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

type TimeoutMsg

type TimeoutMsg struct {
	ID int
}