pomodoro

package
v1.23.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 26, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Kind

type Kind int
const (
	Work Kind = iota
	ShortBreak
	LongBreak
)

func (Kind) String

func (t Kind) String() string

type Params

type Params struct {
	WorkDuration       time.Duration
	ShortBreakDuration time.Duration
	LongBreakDuration  time.Duration
	WorkRounds         int
	// use for testing, do not set it yourself
	Clock clock.Clock
}

type Pomodoro added in v1.5.0

type Pomodoro struct {

	// External events
	OnTick func()
	OnEnd  func(kind Kind)
	// State
	Kind           Kind
	RemainingTime  time.Duration
	RemainingRound int
	Running        bool
	// contains filtered or unexported fields
}

func NewPomodoro

func NewPomodoro(params *Params) *Pomodoro

func (*Pomodoro) Next added in v1.5.0

func (p *Pomodoro) Next()

func (*Pomodoro) Pause added in v1.5.0

func (p *Pomodoro) Pause()

func (*Pomodoro) SetLongBreakDuration added in v1.6.0

func (p *Pomodoro) SetLongBreakDuration(duration time.Duration)

func (*Pomodoro) SetRemainingTime added in v1.7.0

func (p *Pomodoro) SetRemainingTime()

SetRemainingTime sets the remaining time depending on the pomodoro kind

func (*Pomodoro) SetShortBreakDuration added in v1.6.0

func (p *Pomodoro) SetShortBreakDuration(duration time.Duration)

func (*Pomodoro) SetWorkDuration added in v1.6.0

func (p *Pomodoro) SetWorkDuration(duration time.Duration)

func (*Pomodoro) SetWorkRounds added in v1.6.0

func (p *Pomodoro) SetWorkRounds(workRounds int)

func (*Pomodoro) Start added in v1.5.0

func (p *Pomodoro) Start()

func (*Pomodoro) Stop added in v1.5.0

func (p *Pomodoro) Stop()

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址