naturaldate

README

Go Natural Date

Natural date time parsing for Go. This package was designed for parsing human-friendly relative date/time ranges in Apex Logs' command-line log search.

Examples

Here are some examples of the types of expressions currently supported:

• now
• today
• yesterday
• 5 minutes ago
• three days ago
• last month
• next month
• one year from now
• yesterday at 10am
• last sunday at 5:30pm
• sunday at 22:45
• next January
• last February
• December 25th at 7:30am
• 10am
• 10:05pm
• 10:05:22pm

Direction

A default direction can be applied using WithDirection() for ambiguous expressions such as sunday, or september. By default naturaldate.Past is used, so they will be equivalent to last sunday and last september.

Notes

This package is does not have the goal of parsing all possible date formats and timestamps, I recommend you attempt parsing those first and then falling back on this package to provide "natural language" support.

---

Sponsors

This project is sponsored by CTO.ai, making it easy for development teams to create and share workflow automations without leaving the command line.

Documentation

Overview

Package naturaldate provides natural date time parsing.

Index

• func Parse(s string, ref time.Time, options ...Option) (time.Time, error)
• func Pretty(pretty bool) func(*parser) error
• func Size(size int) func(*parser) error
• type Direction
• type Option
  • func WithDirection(d Direction) Option

Functions

func Parse

func Parse(s string, ref time.Time, options ...Option) (time.Time, error)

Parse query string.

func Pretty

func Pretty(pretty bool) func(*parser) error

func Size

func Size(size int) func(*parser) error

Types

type Direction

type Direction int

Direction is the direction used for ambiguous expressions.

const (
	Past Direction = iota
	Future
)

Directions available.

type Option

type Option func(*parser)

Option function.

func WithDirection

func WithDirection(d Direction) Option

WithDirection sets the direction used for ambiguous expressions. By default the Past direction is used, so "sunday" will be the previous Sunday, rather than the next Sunday.