cal

Documentation

Index

• func DateAfter(date Date) validation.Rule
• func DateBefore(date Date) validation.Rule
• func DateNotZero() validation.Rule
• type Date
  • func MakeDate(year int, month time.Month, day int) Date
  • func NewDate(year int, month time.Month, day int) *Date
  • func (Date) JSONSchema() *jsonschema.Schema
• type Period
  • func (p *Period) Validate() error

Functions

func DateAfter

func DateAfter(date Date) validation.Rule

DateAfter returns a validation rule which checks to ensure the date is *after* the provided date.

func DateBefore

func DateBefore(date Date) validation.Rule

DateBefore is used during validation to ensure the date is before the value passed in.

func DateNotZero

func DateNotZero() validation.Rule

DateNotZero ensures the date is not a zero value.

Types

type Date

type Date struct {
	civil.Date
}

Date represents a simple date without time used most frequently with business documents.

func MakeDate

func MakeDate(year int, month time.Month, day int) Date

MakeDate provides a new date instance.

func NewDate

func NewDate(year int, month time.Month, day int) *Date

NewDate provides a pointer to a new date instance.

func (Date) JSONSchema

func (Date) JSONSchema() *jsonschema.Schema

JSONSchema returns a custom json schema for the date.

type Period

type Period struct {
	Start Date `json:"start"`
	End   Date `json:"end"`
}

Period represents two dates with a start and finish.

func (*Period) Validate

func (p *Period) Validate() error

Validate checks to ensure the period looks correct.