date-string-fns v1.0.1

date-string-fns

A library for manipulating ISO8601 date strings.

An ISO8601 date is a string in the format yyyy-mm-dd - 10 characters, consisting of a 4-digit year, 2-digit month and 2-digit day, separated by dashes. Examples of ISO8601 dates:

• '2013-06-30' - 30th June 2013
• '1900-01-01' - 1st January 1900
• '1776-07-04' - July 4th 1776
• '1066-10-14' - 14th October 1066
• '0815-06-28' - June 28th 815

Installation

npm install date-string-fns

yarn add date-string-fns

Usage

Conversion to ISO8601

From a Javascript Date object using the local time value:

import { fromLocalDate } from 'date-string-fns';

const iso = fromLocalDate(new Date()); // '2013-05-31'

From a Javascript Date object using UTC time value:

import { fromUTCDate } from 'date-string-fns';

const iso = fromUTCDate(new Date()); // '2013-05-31'

From raw day, month and year values:

import { fromDMY } from 'date-string-fns';

const iso = fromDMY({ day: 4, month: 7, year: 1776 }); // '1776-07-04'

Convenience functions

import { todaysDate, tomorrowsDate, yesterdaysDate } from 'date-string-fns';

const today = todaysDate(); // '2013-02-14'
const tomorrow = tomorrowsDate(); // '2013-02-15'
const yesterday = yesterdaysDate(); // '2013-02-13'

Conversion from ISO8601

To a local Javascript Date object

import { toLocalDate } from 'date-string-fns';

const date = toLocalDate('2013-02-14'); // 14th Feb 2013 at midnight (local time)

To a UTC Javascript Date object

import { toUTCDate } from 'date-string-fns';

const date = toUTCDate('2013-02-14', { h: 16, m: 31, s: 45, ms: 678 }); // 14th Feb 2013 at 16:31:45.678 (utc)

To day, month and year values

import { toDMY } from 'date-string-fns';

const { day, month, year } = toDMY('2013-04-26'); // { day: 26, month: 4, year: 2013 }

Adding / subtracting dates

import { addDate } from 'date-string-fns';

const oneMonthLater = addDate('2023-02-14', { months: 1 });
console.log(oneMonthLater); // '2023-03-14'

const eightySixDaysEarlier = addDate('2023-02-14', { days: -86 });
console.log(eightySixDaysEarlier); // '2022-11-20'

const oneDayTwoMonthsAndThreeYearsLater = addDate('2023-02-14', {
  days: 1,
  months: 2,
  years: 3,
});
console.log(oneDayTwoMonthsAndThreeYearsLater); // '2026-03-02'

const lastDayOf2023 = addDate('2023-01-01', { years: 1, days: -1 });
console.log(lastDayOf2023); // '2023-12-31'

// note that when incrementing by months, the day is altered to suit the resulting month:
// - if the date passed in is the last day of the month, the result will also have the last day of the month
// - otherwise the date is the closest valid date for the resulting month
const jan31stPlusOneMonth = addDate('2023-01-31', { months: 1 });
console.log(jan31stPlusOneMonth); // '2023-02-28'