Date parsing plugin for momentjs
npm install moment-parseplus
A comprehensive and extensible date parsing plugin for
Moment.js. It allows passing a wide variety of date
formats to the moment constructor. Most locales are supported automatically.
_Note: The only breaking change from moment-parseplus 1.x to 2.x is the way
you add custom formats._
- Motivation
- Installation
- Usage
- Recognized Formats
- Adding Custom Formats
- Locale Support
- What is this sorcery?
- Sister Packages
- Unit Testing
- Contributing
1. The APIs I consume have a lot of different date formats
1. I want to create REST APIs that accept all major formats
1. I want to handle user-input dates
1. I want to support dates in other languages according to JavaScript's new
Intl global object
``bash`
npm install moment-parseplus
`js
import { moment } from 'moment-parseplus';
const date1 = moment('March 5th, 2016 at 7:05pm');
const date2 = moment('9 days ago');
const date3 = moment('2016-03-05 23:59:59 CST');
`
Or you can explicitly import moment separately from moment-parseplus:
`js
import moment from 'moment';
import 'moment-parseplus';
const date1 = moment('March 5th, 2016 at 7:05pm');
`
- 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
moment-parseplus relies on
any-date-parser which supports
even more formats. See the
exhaustive list.
See
any-date-format's instructions.
Example:
`js
const parser = require('moment-parseplus');
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 };
},
})
);
console.log(moment('Q4 2020'));
`
The built-in parsers containing month and day names are automatically updated
when locale is changed using moment.locale(name).
For example, setting locale to French (by including the locale file or calling
moment.locale('fr')), will allow parsing dates such as "15 septembre 2015".
Moment.js provides a moment.createFromInputFallback method you can define tomoment-parseplus
create additional parsing rules. implements that function and
gets invoked when Moment.js fails to parse the given string.
- Standalone Parser:
any-date-parser
- DayJS: dayjs-parser
- Luxon: luxon-parser
moment-parseplus has 100% code coverage.
- To run tests, run npm test
- To check coverage, run
Unit tests require a global install of full-icu and moment`. The test runner
will attempt to install these if absent.
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.