Categorygithub.com/ijt/go-anytime
modulepackage
1.9.2
Repository: https://github.com/ijt/go-anytime.git
Documentation: pkg.go.dev
Overview
Versions
3
Dependencies
6
Dependents
5
Files
1k SLOC

# README

Go Anytime

Go Report Card codecov GoDoc Awesome

Natural date time parsing for Go. This package was originally forked from github.com/tj/go-naturaldate but has diverged so much that it needed a new name to avoid confusion. Here are the largest differences:

  1. The go-anytime module is written in terms of the github.com/ijt/goparsify parser combinator module, rather than the github.com/pointlander/peg parsing module. That made its development and debugging easier, and also means that its parsers can be use within other parsers that use ijt/goparsify.
  2. Ranges can be parsed using ParseRange or RangeParser, for example "from 3 feb 2022 until 6 oct 2022".
  3. Dates/times and ranges can be replaced in strings using the funcs ReplaceTimesByFunc, ReplaceRangesByFunc, and ReplaceDateRangesByFunc.
  4. Strings can be partitioned into time and non-time parts using the funcs PartitionTimes and PartitionTimesByFuncs.

Examples

Here are some examples of expressions that can be parsed by anytime.Parse() or anytime.Parser:

  • 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
  • next sunday at 22:45
  • next January
  • last February
  • next December 25th at 7:30am
  • next December 25th at 7:30am UTC-7
  • November 3rd, 1986 at 4:30pm
  • january 2017
  • january, 2017
  • oct 7, 1970
  • oct 7 1970
  • 7 oct 1970
  • 7 oct, 1970
  • September 17, 2012 UTC+7
  • September 17, 2012
  • 03 February 2013
  • 2 July 2013
  • 2014/3/31
  • 2014/3/31 UTC
  • 2014/3/31 UTC+1
  • 2014/03/31
  • 2014/03/31 UTC-1
  • 2014-04-26
  • 2014-4-26
  • 2014-4-6
  • 31/3/2014 UTC-8
  • 31-3-2014 UTC-8
  • 31/3/2014
  • 31-3-2014
  • January
  • december 20
  • thursday at 23:59
  • See the tests for more examples

Range examples

Here are some examples of expressions that can be parsed by anytime.ParseRange() or anytime.RangeParser:

  • from 3 feb 2022 to 6 oct 2022
  • 3 feb 2022 to 6 oct 2022
  • from 3 feb 2022 until 6 oct 2022
  • from tuesday at 5pm -12:00 until thursday 23:52 +14:00
  • last year
  • today
  • next week

# Functions

DefaultToFuture sets the option to default to the future in case of ambiguous dates.
DefaultToPast sets the option to default to the past in case of ambiguous dates.
I makes a gp.Insensitive parser from its string argument.
Parse parses a string assumed to contain a date, a time, or a datetime in one of various formats.
Parser returns a parser of dates with a given reference time called ref.
ParseRange parses a string such as "from april 20 at 5pm to may 5 at 9pm" and returns a Range.
PartitionTimes returns a slice whose pieces are non-time pieces of s and time pieces of s, in order.
PartitionTimesByFuncs partitions the given string s into time and non-time parts, calling ntf on the non-time parts and tf on the time parts in succession.
RangeFromTimes returns a range given the start and end times.
RangeParser takes a reference time ref and returns a parser for date ranges.
ReplaceDateRangesByFunc replaces all ranges with duration over one day in the given string s by running func f on each found range and the source string that defines it.
ReplaceRangesByFunc replaces all ranges found in the given string s by calling the func f.
ReplaceTimesByFunc replaces all dates, times and datetimes found in the given string s by calling the func f.

# Structs

Range is a time range.