natural

package

v0.1.0 Latest Latest Go to latest Published: Feb 7, 2021 License: MIT Imports: 9 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 natural helps parsing durations

This section is empty.

View Source

var ErrLangNotSupported = errors.New("lang not supported")

ErrLangNotSupported is returned when the language is not supported

func Duration(symbols []interface{}) (duration *durations.Duration, err error)

Duration translates a list of symbols into a duration

type Corpus interface {
	Symbols(string) ([]interface{}, error)
}

Corpus holds data about translating text to string

func PrefixedEn() Corpus

PrefixedEn returns a Prefixed corpus for the english language

func PrefixedFr() Corpus

PrefixedFr returns a Prefixed corpus for the french language

type Modifier int

Modifier is a length of time that applies to the last unit

const (
	Half Modifier = iota
	Quarter
	Plus
	Minus
)

All possible modifiers

type Number float32

Number is the symbol for numbers

type Parser map[string]Corpus

Parser has the functions

func (p Parser) Duration(lang, raw string) (*durations.Duration, error)

Duration parses a duration from natural text

type PrefixedCorpus []prefix

PrefixedCorpus tries to use the beginning of words to match them

func (c PrefixedCorpus) Symbols(str string) ([]interface{}, error)

Symbols implements the corpus interface

type Unit int

Unit represents a unit of time

const (
	Year Unit = iota
	Month
	Week
	Day
	Hour
	Minute
	Second
)

All possible units