moment-array-dates's Introduction

Moment Array Dates

A small utility function that returns an array of formatted date strings.

Installation

npm install --save moment-array-dates

Usage

Import package:

var dateArray = require('moment-array-dates');

Functions

.range(startDate, endDate, format, ascending)

Returns an array of formatted dates including the start and end dates. Format and the last boolean parameter is optional.

dateArray.range('09/01/2016', '09/05/2016', 'MMM DD', true)

Output: [ 'Sep 01', 'Sep 02', 'Sep 03', 'Sep 04', 'Sep 05' ]

.lastNDays(number of days, format, ascending)

Returns an array of formatted dates from the last n days excluding today. Format and the last boolean parameter is optional.

# today: October 25, 2016
dateArray.lastNDays(5, 'MMM DD', true)

Output: [ 'Oct 20', 'Oct 21', 'Oct 22', 'Oct 23', 'Oct 24' ]

.nextNDays(number of days, format, ascending)

Returns an array of formatted dates from the next n days excluding today. Format and the last boolean parameter is optional.

# today: October 25, 2016
dateArray.nextNDays(5, 'MMM DD', true)

Output: [ 'Oct 26', 'Oct 27', 'Oct 28', 'Oct 29', 'Oct 30' ]

Please refer to the Momentjs documentation for formatting options

Todos

Do method chaining / piping for advanced operations

License

MIT

moment-array-dates's People

Contributors

Stargazers

Watchers

moment-array-dates's Issues

.range() method excludes endDate in range if param is formatted as YYYY-MM-DD

The .range() method call does not produce the expected results per documentation when using `YYYY-MM-DD' format.

const dateRange = dateArray
    .range('2019-05-19', '2019-11-19', 'YYYY-MM-DD', true)

Expected Result: ["2019-05-19", ... , "2019-11-19"]

The expected result is an Array of date strings in ascending order, beginning with '2019-05-19' and ending with '2019-11-19'

Actual Result: ["2019-05-18", ... , "2019-11-18"]

The actual result, however, begins with 2019-05-18 and ends with 2019-11-18.
It begins a day before the provided startDate and ends a day before the provided endDate.

If the startDate and endDate are provided in MM/DD/YYYY format (as shown in readme examples), it works as documented. However, the readme documentation makes no mention that the above date formate is required, and the package appears able to understand the provided YYYY-MM-DD format, but doesn't return the expected range.

It seems either the readme documentation should make it clear if there is any constraint regarding the dateString format that can be provided to the range method. If there is no such constraint, then it appears there is a bug when passing in YYY-MM-DD formatted strings.

Recommend Projects

johncrisostomo / moment-array-dates Goto Github PK