pomodo

Documentation

Overview

Package pomodo manages the pomodo timer.

Index

• type Step
  • func (s Step) GetStartingTime(ctx context.Context) int
  • func (s Step) String() string
• type Timer
  • func New(ctx context.Context) *Timer
  • func (t *Timer) Start(ctx context.Context)
  • func (t *Timer) Stop()

Types

type Step

type Step int

Step is a step in the pomodoro technique.

const (
	// Work is a work/pomodoro session.
	Work Step = iota
	// ShortBreak is a short break in the pomodoro session.
	ShortBreak
	// LongBreak is a long break in the pomodoro session.
	LongBreak
)

func (Step) GetStartingTime

func (s Step) GetStartingTime(ctx context.Context) int

GetStartingTime returns the number of minutes for the session timer.

func (Step) String

func (s Step) String() string

type Timer

type Timer struct {
	CurrentStep Step

	Duration timeRemaining
	Ticking  bool

	Time *timeRemaining
	// contains filtered or unexported fields
}

Timer contains the state of the pomodo timer.

func New

func New(ctx context.Context) *Timer

New returns a new instance of Timer.

func (*Timer) Start

func (t *Timer) Start(ctx context.Context)

Start starts a new timer that ticks once a second.

func (*Timer) Stop

func (t *Timer) Stop()

Stop signals the currently running timer to stop.