calendar

package module

v0.0.0-...-fabf97e Latest Latest Go to latest Published: Nov 7, 2016 License: MIT Imports: 3 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

Repository

github.com/yamadayuki/go-calendar

Links

Open Source Insights

README ¶

Calendar

Provides calendar utilities for golang.

Usage

// importing
package main

import (
    "fmt"

    "github.com/yamadayuki/go-calendar"
)

func main() {
    month := calendar.CurrentMonth()
    fmt.Println(month) // Print current month of the calendar.
}

Documentation ¶

Index ¶

type Calendar
- func New(t time.Time) *Calendar
- func Now() *Calendar
type Month
type Week
- func (week Week) Next() (nextWeek Week)
- func (week Week) Previous() (previousWeek Week)
type Year
- func CurrentYear() Year

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Calendar ¶

type Calendar struct {
	Now *now.Now
}

Calendar have now.Now data.

func New ¶

func New(t time.Time) *Calendar

New returns new Calendar pointer.

func Now ¶

func Now() *Calendar

Now returns Calendar

func (*Calendar) Month ¶

func (calendar *Calendar) Month() (month Month)

Month returns Month regarding current date.

func (*Calendar) Next ¶

func (calendar *Calendar) Next()

Next sets new *now.Now for next month.

func (*Calendar) NextCalendar ¶

func (calendar *Calendar) NextCalendar() (nextCalendar *Calendar)

NextCalendar returns next Calendar.

func (*Calendar) NextMonth ¶

func (calendar *Calendar) NextMonth() (month Month)

NextMonth returns next Month regarding current date.

func (*Calendar) NextWeek ¶

func (calendar *Calendar) NextWeek() (week Week)

NextWeek returns next Week regarding current date. It doesn't have side effect.

func (*Calendar) Previous ¶

func (calendar *Calendar) Previous()

Previous sets new *now.Now for previous month.

func (*Calendar) PreviousCalendar ¶

func (calendar *Calendar) PreviousCalendar() (previousCalendar *Calendar)

PreviousCalendar returns previous Calendar.

func (*Calendar) PreviousMonth ¶

func (calendar *Calendar) PreviousMonth() (month Month)

PreviousMonth returns previous Month regarding current date.

func (*Calendar) PreviousWeek ¶

func (calendar *Calendar) PreviousWeek() (week Week)

PreviousWeek returns previous Week regarding current date. It doesn't have side effect.

func (*Calendar) Week ¶

func (calendar *Calendar) Week() (week Week)

Week returns Week regarding current date.

func (*Calendar) Year ¶

func (calendar *Calendar) Year() (year Year)

Year returns Year regarding current date.

type Month ¶

type Month []Week

Month have Week data to represent month.

func CurrentMonth ¶

func CurrentMonth() Month

CurrentMonth returns Now().Month()

func NextMonth ¶

func NextMonth() Month

NextMonth returns Now().NextMonth()

func PreviousMonth ¶

func PreviousMonth() Month

PreviousMonth returns Now().PreviousMonth()

type Week ¶

type Week []time.Time

Week have time.Time data to represent week.

func CurrentWeek ¶

func CurrentWeek() Week

CurrentWeek returns Now().Week()

func NextWeek ¶

func NextWeek() Week

NextWeek returns Now().NextWeek()

func PreviousWeek ¶

func PreviousWeek() Week

PreviousWeek returns Now().PreviousWeek()

func (Week) Next ¶

func (week Week) Next() (nextWeek Week)

Next returns time.Time collection to represent next week.

func (Week) Previous ¶

func (week Week) Previous() (previousWeek Week)

Previous returns time.Time collection to represent previous week.

type Year ¶

type Year [12]Month

Year have Month data to represent year.

func CurrentYear ¶

func CurrentYear() Year

CurrentYear returns Now().Year()

Source Files ¶

View all Source files

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