npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

luxon-parser

v0.9.4

Published

Add DateTime.fromHuman() and DateTime.fromAny() functions to Luxon that can parse a wide range of date formats including human-input dates

Downloads

882

Readme

luxon-parser

NPM Link Build Status Code Coverage ISC License

A comprehensive and extensible date parsing plugin for Luxon. It allows passing a wide variety of date formats to new functions DateTime.fromHuman() and DateTime.fromAny(). Most locales are supported automatically.

It uses any-date-parser for parsing date strings.

Table of Contents

Motivation

  1. The APIs I consume have a lot of different date formats
  2. I want to create REST APIs that accept all major formats
  3. I want to handle user-input dates
  4. I want to support dates in other languages according to JavaScript's new Intl global object

Installation

npm install luxon luxon-parser

Usage

const { DateTime } = require('luxon');
require('luxon-parser');

const date1 = DateTime.fromHuman('March 5th, 2016 at 7:05pm');
const date2 = DateTime.fromHuman('9 days ago');
const date3 = DateTime.fromHuman('2016-03-05 23:59:59 CST');

DateTime.fromHuman(string, options)

Create a DateTime from any given String. Equivalent to auto choosing the right from*() function:

  • DateTime.fromFormat()
  • DateTime.fromHTTP()
  • DateTime.fromISO()
  • DateTime.fromRFC2822()
  • DateTime.fromSQL()
  • DateTime.fromString()

DateTime.fromAny(any, options)

Create a DateTime from any given type. Equivalent to auto choosing the right from*() function:

  • DateTime.now()
  • DateTime.fromFormat()
  • DateTime.fromHTTP()
  • DateTime.fromISO()
  • DateTime.fromJSDate()
  • DateTime.fromMillis()
  • DateTime.fromObject()
  • DateTime.fromRFC2822()
  • DateTime.fromSQL()
  • DateTime.fromString()

Recognized Formats

  • 24 hour time
  • 12 hour time
  • timezone offsets
  • timezone abbreviations
  • year month day
  • year monthname day
  • month day year
  • monthname day year
  • day month year
  • day monthname year
  • +/-/ago periods
  • now/today/yesterday/tomorrow
  • Twitter

luxon-parser relies on any-date-parser which supports even more formats. See the exhaustive list.

Adding Custom Formats

See any-date-parser's instructions.

Example:

const parser = require('luxon-parser');

parser.addFormat(
	new parser.Format({
		matcher: /^Q([1-4]) (\d{4})$/,
		handler: function ([, quarter, year]) {
			const monthByQuarter = { 1: 1, 2: 4, 3: 7, 4: 10 };
			const month = monthByQuarter[quarter];
			return { year, month };
		},
	})
);

Locale Support

Locales are supported through a second argument:

const date = DateTime.fromAny('15 septembre 2015', { locale: 'fr' });

See the Luxon docs on locales

Sister Packages

Unit Testing

luxon-parser has 100% code coverage.

  • To run tests, run npm test
  • To check coverage, run npm run coverage

Unit tests require a global install of full-icu and luxon. The test runner will attempt to install these if absent.

Contributing

Contributions are welcome. Please open a GitHub ticket for bugs or feature requests. Please make a pull request for any fixes or new code you'd like to be incorporated.