Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 2.22 KB

README.md

File metadata and controls

77 lines (55 loc) · 2.22 KB
Raw

A natural language parser for dates, times, and durations

time-speak

NPM Version Downloads Stats

A tiny utility library with no dependencies that parses natural language dates, times, and intervals to either a Date instance or a numerical value in milliseconds. Here are some examples of possible inputs:

  • 'two weeks ago'
  • '1 day ago'
  • 'in 2 hours and 5 minutes'
  • 'in a month'
  • '2018-01-01T00:00:00.000Z'

Installation

Install it with your package manager of choice; for example, with pnpm:

pnpm add time-speak

Usage

Tip

Inputs can be written in plain english! Examples of valid values are 'in twenty minutes', '2 days ago', and '1 hour and 23 minutes ago'.

Import the parse function call it with a string containing a natural language representation of either a time in the future, past, or a numeric duration. The return value is a timestamp in milliseconds if the input is a duration, otherwise it is a Date instance.

import { parse } from 'time-speak'

const pastDate = parse('2 days and 4 hours ago')
const pastDateWithNumberWords = parse('two days and four hours ago')
const futureDate = parse('in 4 hours')
const durationMS = parse('6 months')

console.log({
  pastDateWithNumberWords, // 2023-12-19T13:02:39.768Z
  pastDate, // 2023-12-19T13:02:39.768Z
  futureDate, // 2023-12-21T21:02:39.768Z
  durationMS // 15552000000
})

API Reference

The standalone JSDoc-generated documentation can be found in DOCUMENTATION.md.

Release History

See CHANGELOG.md for more information.

License

Distributed under the MIT license. See LICENSE.md for more information.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request