Skip to content

Latest commit

 

History

History
499 lines (434 loc) · 15.5 KB

README.md

File metadata and controls

499 lines (434 loc) · 15.5 KB
Raw

Chrono

ci GitHub release (latest by date including pre-releases) GitHub code size in bytes deno doc GitHub

nest badge

A date utility library that extends the native Date object.

Features

  • Date and time manipulation
  • Fully compatible with the native Date object

Getting started

Import the latest release.

// From Deno.land
import { Chrono } from "https://deno.land/x/chrono@v1.3.0/mod.ts";

// From Nest.land
import { Chrono } from "https://x.nest.land/chrono@v1.3.0/mod.ts";

// From Denopkg
import { Chrono } from "https://denopkg.com/ymonb1291/chrono@v1.3.0/mod.ts";

// From Github
import { Chrono } from "https://raw.githubusercontent.com/ymonb1291/chrono/v1.3.0/mod.ts";

Basic usage:

const chrono = new Chrono();
chrono.addDay(1);

Compatibility

The class Chrono extends the Date object with additional functionalities. All functionalities from Date are accounted for.

The following two lines of code return the timestamp of the current date and time:

Chrono.now();
Date.now();

And so are the following two:

new Chrono().toLocaleString();
new Date().toLocaleString();

A Chrono object fully complies with the Date interface. The following example is valid:

function useDate(date: Date) {}
useDate(new Chrono());

However, a Date type does not allow objects of type Chrono.

function useChrono(date: Chrono) {}
useChrono(new Date());

Methods

Chrono.prototype.addDay

Method signature

Chrono.addDay(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of days to add to the current date.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.addDay(2);
console.log(chrono.toLocaleString()); // Mon Feb 03 2020 12:00:00 GMT+0100 (CET)
console.log(res);                     // 1580727600000

Chrono.prototype.addHour

Method signature

Chrono.addHour(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of hours to add to the current time.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.addHour(2);
console.log(chrono.toLocaleString()); // Sat Feb 01 2020 14:00:00 GMT+0100 (CET)
console.log(res);                     // 1580562000000

Chrono.prototype.addMinute

Method signature

Chrono.addMinute(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of minutes to add to the current time.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.addMinute(2);
console.log(chrono.toLocaleString()); // Sat Feb 01 2020 12:02:00 GMT+0100 (CET)
console.log(res);                     // 1580554920000

Chrono.prototype.addMonth

Method signature

Chrono.addMonth(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of months to add to the current date.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.addMonth(2);
console.log(chrono.toLocaleString()); // Wed Apr 01 2020 12:00:00 GMT+0200 (CEST)
console.log(res);                     // 1585735200000

Chrono.prototype.addSecond

Method signature

Chrono.addSecond(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of seconds to add to the current time.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.addSecond(2);
console.log(chrono.toLocaleString()); // Sat Feb 01 2020 12:00:02 GMT+0100 (CET)
console.log(res);                     // 1580554802000

Chrono.prototype.addWeek

Method signature

Chrono.addWeek(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of weeks to add to the current date.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.addWeek(2);
console.log(chrono.toLocaleString()); // Sat Feb 15 2020 12:00:00 GMT+0100 (CET)
console.log(res);                     // 1581764400000

Chrono.prototype.addYear

Method signature

Chrono.addYear(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of years to add to the current date.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.addYear(2);
console.log(chrono.toLocaleString()); // Tue Feb 01 2022 12:00:00 GMT+0100 (CET)
console.log(res);                     // 1643713200000

Chrono.prototype.isLeapYear

Method signature

Chrono.isLeapYear(): boolean
  • Returns: a value of type boolean which is true when the year is a leap year

Example

const chrono = new Chrono("Jan 01 2020 00:00:00");
console.log(chrono.isLeapYear());    // true

Chrono.prototype.isUTCLeapYear

Method signature

Chrono.isUTCLeapYear(): boolean
  • Returns: a value of type boolean which is true when the UTC year is a leap year

Example

const chrono = new Chrono("Jan 01 2020 00:00:00");
console.log(chrono.isUTCLeapYear());    // false

Chrono.prototype.set

Method signature

Chrono.set(time: number | Date | Chrono): number
  • Parameter:
    • time: parameter of type number | Date | Chrono representing a valid date
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.set(new Date(946681200000));
console.log(chrono.toLocaleString()); // Sat Jan 01 2000 00:00:00 GMT+0100 (CET)
console.log(res);                     // 946681200000

Chrono.prototype.substractDay

Method signature

Chrono.substractDay(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of days to substract to the current date.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.substractDay(2);
console.log(chrono.toLocaleString()); // Thu Jan 30 2020 12:00:00 GMT+0100 (CET)
console.log(res);                     // 1580382000000

Chrono.prototype.substractHour

Method signature

Chrono.substractHour(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of hours to substract to the current time.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.substractHour(2);
console.log(chrono.toLocaleString()); // Sat Feb 01 2020 10:00:00 GMT+0100 (CET)
console.log(res);                     // 1580547600000

Chrono.prototype.substractMinute

Method signature

Chrono.substractMinute(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of minutes to substract to the current time.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.substractMinute(2);
console.log(chrono.toLocaleString()); // Sat Feb 01 2020 11:58:00 GMT+0100 (CET)
console.log(res);                     // 1580554680000

Chrono.prototype.substractMonth

Method signature

Chrono.substractMonth(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of months to substract to the current date.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.substractMonth(2);
console.log(chrono.toLocaleString()); // Sun Dec 01 2019 12:00:00 GMT+0100 (CET)
console.log(res);                     // 1575198000000

Chrono.prototype.substractSecond

Method signature

Chrono.substractSecond(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of seconds to substract to the current time.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.substractSecond(2);
console.log(chrono.toLocaleString()); // Sat Feb 01 2020 11:59:58 GMT+0100 (CET)
console.log(res);                     // 1580554798000

Chrono.prototype.substractWeek

Method signature

Chrono.substractWeek(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of weeks to substract to the current date.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.substractWeek(2);
console.log(chrono.toLocaleString()); // Sat Jan 18 2020 12:00:00 GMT+0100 (CET)
console.log(res);                     // 1579345200000

Chrono.prototype.substractYear

Method signature

Chrono.substractYear(n?: number): number
  • Parameter:
    • n: (optional) parameter of type number which defaults to 1 and defines the number of years to substract to the current date.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 01 2020 12:00:00.000");
const res = chrono.substractYear(2);
console.log(chrono.toLocaleString()); // Thu Feb 01 2018 12:00:00 GMT+0100 (CET)
console.log(res);                     // 1517482800000

Chrono.prototype.toArray

Method signature

Chrono.toArray(): [number, number, number, number, number, number, number]
  • Returns: an array of 7 values of type number representing [year, month, date, hours, minutes, seconds, milliseconds]

Example

const chrono = new Chrono("Feb 01 2020 00:00:00");
console.log(chrono.toUTCArray());   // [2020, 1, 1, 0, 0, 0, 0]

Chrono.prototype.toEndOfMonth

Method signature

Chrono.toEndOfMonth(offset: number): number
  • Parameter:
    • offset: (optional) parameter of type number which defaults to 0 and defines that the date should be set to n days prior to the end of the month.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 10 2000 00:00:00");
const timestamp = chrono.toEndOfMonth();
console.log(chrono.toLocaleString());
// -> Tue Feb 29 2000 00:00:00 GMT+0100 (CET)
console.log(timestamp); 
// -> 951778800000

Chrono.prototype.toEndOfNextMonth

Method signature

Chrono.toEndOfNextMonth(): number
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 10 2000 00:00:00");
const timestamp = chrono.toEndOfNextMonth();
console.log(chrono.toLocaleString());
// -> Fri Mar 31 2000 00:00:00 GMT+0200 (CEST)
console.log(timestamp); 
// -> 954453600000

Chrono.prototype.toEndOfPreviousMonth

Method signature

Chrono.toEndOfPreviousMonth(): number
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 10 2000 00:00:00");
const timestamp = chrono.toEndOfPreviousMonth();
console.log(chrono.toLocaleString());
// -> Mon Jan 31 2000 00:00:00 GMT+0100 (CET)
console.log(timestamp); 
// -> 949273200000

Chrono.prototype.toNearestWeekday

Method signature

Chrono.toNearestWeekday(bound: boolean): number
  • Parameter:
    • offset: (optional) parameter of type boolean which defaults to true. When true, Chrono will look for the nearest weekday within the boudaries of the current month. The nearest weekday of a Sunday can therefore be a Friday if the Sunday is the last day of the month.
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Jan 9 2000 00:00:00");
const timestamp = chrono.toEndOfPreviousMonth();
console.log(chrono.toLocaleString());
// -> Mon Jan 10 2000 00:00:00 GMT+0100 (CET)
console.log(timestamp); 
// -> 947458800000

Chrono.prototype.toNthDayOfMonth

Method signature

Chrono.toNthDayOfMonth(day: number, occurence: number): number
  • Parameters:
    • day: parameter of type number which represent the day of interest. Accepts values between 0 and 6, where 0 is Sunday and 6 is Saturday.
    • occurence: parameter of type number which represents nth occurence of the day. Accepts values between 1 and 5.
  • Returns: a value of type number representing the timestamp after execution, or undefined if the nth of the given day doesn't exist in this month

Example

const chrono = new Chrono("Jan 21 2000 00:00:00");
const timestamp = chrono.toNthDayOfMonth(3,2);
console.log(chrono.toLocaleString());
// -> Wed Jan 12 2000 00:00:00 GMT+0100 (CET)
console.log(timestamp); 
// -> 947631600000

Chrono.prototype.toStartOfNextMonth

Method signature

Chrono.toStartOfNextMonth(): number
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 10 2000 00:00:00");
const timestamp = chrono.toStartOfNextMonth();
console.log(chrono.toLocaleString());
// -> Wed Mar 01 2000 00:00:00 GMT+0100 (CET)
console.log(timestamp); 
// -> 951865200000

Chrono.prototype.toStartOfPreviousMonth

Method signature

Chrono.toStartOfPreviousMonth(): number
  • Returns: a value of type number representing the timestamp after execution

Example

const chrono = new Chrono("Feb 10 2000 00:00:00");
const timestamp = chrono.toStartOfPreviousMonth();
console.log(chrono.toLocaleString());
// -> Sat Jan 01 2000 00:00:00 GMT+0100 (CET)
console.log(timestamp); 
// -> 946681200000

Chrono.prototype.toUTCArray

Method signature

Chrono.toUTCArray(): [number, number, number, number, number, number, number]
  • Returns: an array of 7 values of type number representing [UTCYear, UTCMonth, UTCDate, UTCHours, UTCMinutes, UTCSeconds, UTCMilliseconds]

Example

const chrono = new Chrono("Feb 01 2020 00:00:00");
console.log(chrono.toUTCArray());   // [2020, 0, 31, 23, 0, 0, 0]

Contributions

PRs are welcome!