pomodoro

package

v0.9.32 Latest Latest Go to latest Published: May 5, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package pomodoro Option

Package pomodoro technique

This section is empty.

This section is empty.

This section is empty.

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

IPomodoro implements Pomodoro interface.

func NewPomodoro(
	conf *config.Config,
	sc screen.Client,
	timer timer.Timer,
	tc task.Client,
	opts ...Option,
) *IPomodoro

NewPomodoro initilize Pomodoro.

func (p *IPomodoro) Finish()

Finish finishes Pomodoro.

func (p *IPomodoro) Start(ctx context.Context) error

Start starts pomodoro.

type Option func(*IPomodoro)

Option pomodoro option.

func WithLongBreakSec(s int) Option

WithLongBreakSec set LongBreakSec.

func WithNotify() Option

WithNotify notify and sound when time is finished.

func WithRecordPixela(client *pixela.Client, userName, graphID string) Option

WithRecordPixela record pomodoro count when work time is finished.

func WithRecordToggl(togglClient *toggl.Client) Option

WithRecordToggl record duration when work time is finished.

func WithShortBreakSec(s int) Option

WithShortBreakSec set ShortBreakSec.

func WithWorkSec(s int) Option

WithWorkSec set WorkSec.

type Pomodoro interface {
	Start(context.Context) error

	Finish()
}

Pomodoro interface.