ticker

Documentation

Overview

Package ticker contains the Model and Update function to work with a Go Ticker.

Index

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

Types

type Model

type Model struct {
	Ticker *time.Ticker
}

Model is the bubbletea model storing the data of the Ticker.

func (Model) Tick

func (m Model) Tick() tea.Msg

Tick passes the Msg when the ticker is triggered.

func (Model) Update

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

Update prepare the dispose method and emit a tick for listening the channel.

type Msg

type Msg time.Time

Msg is the ticking message that must be passed to the Init or Update function.