Skip to content

A simple immutable date-time manipulation library in Typescript.

License

Notifications You must be signed in to change notification settings

yyankowski/simplydate

Repository files navigation

SimplyDate

This is a basic functional, non-mutating date-time manipulation library implemented in Typescript. It supports time zones and is suitable for simple and basic date formatting and manipulation. Please note that this library is a personal project and is not ready for production use. Use it at your own risk.

Installation:

NPM

npm install --save simplydate

Yarn

yarn add simplydate

Usage Examples:

import {Simply} from "simplydate"

Type definition

type SimplyDate = {
    year: number,
    month: number,
    day: number,
    hour: number,
    minute: number,
    second: number,
    millisecond: number
}

Ways to initialize:

const simpleDate = Simply.from.date(new Date(`2015-02-29T03:24:00`));
const simpleDateFromMs = Simply.from.msSinceEpoch(1515035460000);
const simpleDateFromString = Simply.from.string('12-25-1995', 'MM-DD-YYYY');
const nowDate = Simply.now();

Accessing properties:

console.log(nowDate.day);
console.log(simpleDate.month);

Addition:

const newSimpleDate1 = Simply.add(2).days.to(simpleDate);
const newSimpleDate2 = Simply.add(12).months.to(newSimpleDate1);

Subtraction:

const newSimpleDate1 = Simply.subtract(10).seconds.from(simpleDate);
const newSimpleDate2 = Simply.subtract(12).months.from(simpleDate);

Output to string

const simpleDate = Simply.from.date(new Date(`2017-03-01T03:24:00`));
Simply.format(simpleDate).as("YYYY-MM-DDTHH:mm:ss") === "2017-03-01T03:24:00"
Simply.format(simpleDate).as("YYYY-MM-DD") === "2017-03-01"

With timezones see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat

const options = {
                weekday: "long",
                year: "numeric",
                month: "long",
                day: "numeric",
            };
Simply.format(sDt).as({ locale: "de-DE", options })) === "Mittwoch, 29. März 2017"          

The following date formats are supported:

'YYYY-MM-DDTHH:mm:ss.SSS' => '2017-03-01T03:24:00.000'
'YYYY-MM-DDTHH:mm:ss' => '2017-03-01T03:24:00'
'YYYY-MM-DDTHH:mm' => '2017-03-01T03:24'

'YYYY-MM-DD' => '2017-03-01'
'HH:mm' => '03:24'
'HH:mm:ss' => '13:24:00'

'YY MMM DD h:mm A' => '17 Mar 29 3:24 AM'

Get milliseconds since Unix Epoch till now.

Simply.to.msSinceEpoch(Simply.now())