Skip to content
Luke-zhang-04 edited this page Jun 21, 2021 · 7 revisions

@luke-zhang-04/dateplus / Exports

Date Plus

build status bundle min gzip size license github version npm version all time npm downloads
maintainability coverage

A simple library to assist with date manipulation, comprising of a series of simple functions for convenience.

Difference from date-fns

I didn't know about date-fns when I wrote this. Honestly, go use date-fns instead.

Installation

Download from NPM

# Using NPM
npm i @luke-zhang-04/dateplus --save

#using Yarn
yarn add @luke-zhang-04/dateplus

Get bundles with curl

curl -L https://github.com/Luke-zhang-04/date-plus/releases/download/v<VERSION_NAME>/dateplus.bundle.min.js -O js/dateplus.bundle.min.js # Download minified file (recommended)

curl -L https://github.com/Luke-zhang-04/date-plus/releases/download/v<VERSION_NAME>/dateplus.bundle.js -O js/dateplus.bundle.js # Download not minfiied file (not recommended for production)

Usage

Run in a node environment with a require or import statement

const {default: DatePlus} = require("@luke-zhang-04/dateplus")
import DatePlus from "@luke-zhang-04/dateplus"

const myDate = new DatePlus()

Run in a browser environment by either using webpack or an alternative on the previous solution, or by adding the dateplus.min.js to your javascript within the HTML by downloading it or using a CDN

<script src="js/dateplus.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/@luke-zhang-04/dateplus@4.0.0-beta1/dist/esm/dateplus.min.js"></script>

<script>
    const {default: DatePlus} = DatePlus
    const myDate = new DatePlus()
</script>

Documentation

For documentation, visit the dateplus wiki

@luke-zhang-04/dateplus / Exports

@luke-zhang-04/dateplus

Table of contents

References

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

References

default

Renames and exports: DatePlus

Type aliases

DateFormat

Ƭ DateFormat: "y:m:d" | "y:d:m" | "m:d:y" | "m:y:d" | "d:m:y" | "d:y:m"

Defined in

src/utils.ts:13

Variables

daysReference

Const daysReference: Object

Reference to days of the week, zero indexed

Type declaration

Name Type
0 string
1 string
2 string
3 string
4 string
5 string
6 string

Defined in

src/values.ts:27


monthsReference

Const monthsReference: Object

Reference to months of a year, zero indexed

Type declaration

Name Type
0 string
1 string
10 string
11 string
2 string
3 string
4 string
5 string
6 string
7 string
8 string
9 string

Defined in

src/values.ts:40


oneDay

Const oneDay: number

One day in ms

Defined in

src/values.ts:68


oneHour

Const oneHour: number

One hour in ms

Defined in

src/values.ts:63


oneMinute

Const oneMinute: number

One minutes in ms

Defined in

src/values.ts:58


values

Const values: Object

Type declaration

Name Type
hrsPerDay number
minsPerHr number
msPerSec number
secsPerMin number

Defined in

src/values.ts:17

Functions

addZeros

Const addZeros(date, seperator?): string

Add's 0s to date (e.g 2020/4/3 => 2020/04/03)

Parameters

Name Type Default value Description
date string undefined String date to format
seperator string "/" Char the date is seperatred by

Returns

string

  • Date with zeros

Defined in

src/utils.ts:44


daysToHours

Const daysToHours(days): number

Parameters

Name Type
days number

Returns

number

Defined in

src/conversions.ts:342


daysToHrs

Const daysToHrs(days): number

Converts days to hours

Parameters

Name Type Description
days number Days to convert

Returns

number

Converted hours

Defined in

src/conversions.ts:341


daysToMins

Const daysToMins(days): number

Converts days to minutes

Parameters

Name Type Description
days number Days to convert

Returns

number

Converted minutes

Defined in

src/conversions.ts:332


daysToMinutes

Const daysToMinutes(days): number

Parameters

Name Type
days number

Returns

number

Defined in

src/conversions.ts:333


daysToMs

Const daysToMs(days): number

Converts days to milliseconds

Parameters

Name Type Description
days number Days to convert

Returns

number

Converted milliseconds

Defined in

src/conversions.ts:313


daysToSeconds

Const daysToSeconds(days): number

Parameters

Name Type
days number

Returns

number

Defined in

src/conversions.ts:324


daysToSecs

Const daysToSecs(days): number

Converts days to seconds

Parameters

Name Type Description
days number Days to convert

Returns

number

Converted seconds

Defined in

src/conversions.ts:322


formatDate

Const formatDate(date, format?, seperator?): string

Format date into a string in the form YYYY{seperator}MM{seperator}DD

Parameters

Name Type Default value Description
date Date undefined Date object to format
format DateFormat "y:m:d" Format of string date
seperator string "/" String to seperate date values with

Returns

string

Formatted date

Defined in

src/utils.ts:62


getDateValues

Const getDateValues(date, format?, seperator?): YearObj

Gets date values and outputs an object

Parameters

Name Type Default value Description
date string undefined Date to extract values from, months zero indexed
format DateFormat "y:m:d" Format of string date
seperator string "auto" Seperator the date works with; leave auto for auto detection, limited to 1 char

Returns

YearObj

Object with all values

Defined in

src/utils.ts:84


getElapsedDays

Const getElapsedDays(date1, date2): number

Calculates number of elapsed days between date1 and date2

Parameters

Name Type Description
date1 Date Starting date object to calculate
date2 Date Ending date object to calculate

Returns

number

  • Number of elapsed days

Defined in

src/utils.ts:140


getElapsedHours

Const getElapsedHours(date1, date2): number

Calculates number of elapsed hours between date1 and date2

Parameters

Name Type Description
date1 Date Starting date object to calculate
date2 Date Ending date object to calculate

Returns

number

  • Number of elapsed hours

Defined in

src/utils.ts:150


getElapsedMinutes

Const getElapsedMinutes(date1, date2): number

Calculates number of elapsed minutes between date1 and date2

Parameters

Name Type Description
date1 Date Starting date object to calculate
date2 Date Ending date object to calculate

Returns

number

  • Number of elapsed minutes

Defined in

src/utils.ts:160


getElapsedMs

Const getElapsedMs(date1, date2): number

Calculates number of elapsed milliseconds between date1 and date2

Parameters

Name Type Description
date1 Date Starting date object to calculate
date2 Date Ending date object to calculate

Returns

number

  • Number of elapsed milliseconds

Defined in

src/utils.ts:180


getElapsedSeconds

Const getElapsedSeconds(date1, date2): number

Calculates number of elapsed seconds between date1 and date2

Parameters

Name Type Description
date1 Date Starting date object to calculate
date2 Date Ending date object to calculate

Returns

number

  • Number of elapsed seconds

Defined in

src/utils.ts:170


getElapsedString

Const getElapsedString(start, end, approx?): string

Calculates elapsed time between current and previous

Parameters

Name Type Default value Description
start Date undefined -
end Date undefined End date
approx string "about" Text to append to values from days and on, e.g about 1 day aga

Returns

string

Time difference in string form, e.g "3 seconds ago"

Defined in

src/utils.ts:191


getUtcTime

Const getUtcTime(): number

Get the current UTC Time

Returns

number

UTC Time

Defined in

src/utils.ts:249


getWordDay

Const getWordDay(numerical): string

Converts numerical day of week into word form (e.g 0 => "Sunday")

Parameters

Name Type Description
numerical 0 | 1 | 2 | 3 | 4 | 5 | 6 Numerical day of week, 0 indexed (0-6)

Returns

string

Stringed day of week

Defined in

src/utils.ts:121


getWordMonth

Const getWordMonth(numerical): string

Converts numerical month into word form (e.g 0 => "January")

Parameters

Name Type Description
numerical 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 Numerical day of week, 0 indexed (0-11)

Returns

string

Stringed worded month

Defined in

src/utils.ts:130


hoursToDays

Const hoursToDays(hrs): DaysObj

Parameters

Name Type
hrs number

Returns

DaysObj

Defined in

src/conversions.ts:305


hoursToMinutes

Const hoursToMinutes(hours): number

Parameters

Name Type
hours number

Returns

number

Defined in

src/conversions.ts:296


hoursToMs

Const hoursToMs(hours): number

Parameters

Name Type
hours number

Returns

number

Defined in

src/conversions.ts:278


hoursToSeconds

Const hoursToSeconds(hours): number

Parameters

Name Type
hours number

Returns

number

Defined in

src/conversions.ts:287


hrsToDays

Const hrsToDays(hrs): DaysObj

Converts hours to days with remainders

Parameters

Name Type Description
hrs number Hours to convert

Returns

DaysObj

Converted days

Defined in

src/conversions.ts:304


hrsToMins

Const hrsToMins(hours): number

Converts hours to minutes

Parameters

Name Type Description
hours number Hours to convert

Returns

number

Converted minutes

Defined in

src/conversions.ts:295


hrsToMs

Const hrsToMs(hours): number

Converts hours to milliseconds

Parameters

Name Type Description
hours number Hours to convert

Returns

number

Converted milliseconds

Defined in

src/conversions.ts:276


hrsToSecs

Const hrsToSecs(hours): number

Converts hours to seconds

Parameters

Name Type Description
hours number Hours to convert

Returns

number

Converted seconds

Defined in

src/conversions.ts:286


minsToDays

Const minsToDays(mins): DaysObj

Converts minutes to days with remainders

Parameters

Name Type Description
mins number Minutes to convert

Returns

DaysObj

Converted days

Defined in

src/conversions.ts:267


minsToHrs

Const minsToHrs(mins): HoursObj

Converts minutes to hours with remainders

Parameters

Name Type Description
mins number Minutes to convert

Returns

HoursObj

Converted hours

Defined in

src/conversions.ts:258


minsToMs

Const minsToMs(mins): number

Converts hours to milliseconds

Parameters

Name Type Description
mins number Minutes to convert

Returns

number

Converted milliseconds

Defined in

src/conversions.ts:240


minsToSecs

Const minsToSecs(mins): number

Converts hours to seconds

Parameters

Name Type Description
mins number Minutes to convert

Returns

number

Converted seconds

Defined in

src/conversions.ts:249


minutesToDays

Const minutesToDays(mins): DaysObj

Parameters

Name Type
mins number

Returns

DaysObj

Defined in

src/conversions.ts:268


minutesToHours

Const minutesToHours(mins): HoursObj

Parameters

Name Type
mins number

Returns

HoursObj

Defined in

src/conversions.ts:259


minutesToMs

Const minutesToMs(secs): DaysObj

Parameters

Name Type
secs number

Returns

DaysObj

Defined in

src/conversions.ts:241


minutesToSeconds

Const minutesToSeconds(mins): number

Parameters

Name Type
mins number

Returns

number

Defined in

src/conversions.ts:250


msToDays

Const msToDays(ms): DaysObj

Converts milliseconds to days with remainders

Parameters

Name Type Description
ms number Milliseconds to convert

Returns

DaysObj

Object with days, hours, minutes, seconds, and milliseconds

Defined in

src/conversions.ts:167


msToHours

Const msToHours(ms): HoursObj

Parameters

Name Type
ms number

Returns

HoursObj

Defined in

src/conversions.ts:159


msToHrs

Const msToHrs(ms): HoursObj

Converts milliseconds to hours with remainders

Parameters

Name Type Description
ms number Milliseconds to convert

Returns

HoursObj

Object with hours, minutes, seconds, and milliseconds

Defined in

src/conversions.ts:139


msToMins

Const msToMins(ms): MinutesObj

Converts milliseconds to minutes with remainders

Parameters

Name Type Description
ms number Milliseconds to convert

Returns

MinutesObj

Object with minutes, seconds, and milliseconds

Defined in

src/conversions.ts:119


msToMinutes

Const msToMinutes(ms): MinutesObj

Parameters

Name Type
ms number

Returns

MinutesObj

Defined in

src/conversions.ts:131


msToSeconds

Const msToSeconds(ms): SecondsObj

Parameters

Name Type
ms number

Returns

SecondsObj

Defined in

src/conversions.ts:111


msToSecs

Const msToSecs(ms): SecondsObj

Converts milliseconds to seconds with remainders

Parameters

Name Type Description
ms number Milliseconds to convert

Returns

SecondsObj

Object with seconds and milliseconds

Defined in

src/conversions.ts:107


secondsToDays

Const secondsToDays(secs): DaysObj

Parameters

Name Type
secs number

Returns

DaysObj

Defined in

src/conversions.ts:232


secondsToHours

Const secondsToHours(secs): HoursObj

Parameters

Name Type
secs number

Returns

HoursObj

Defined in

src/conversions.ts:223


secondsToMinutes

Const secondsToMinutes(secs): MinutesObj

Parameters

Name Type
secs number

Returns

MinutesObj

Defined in

src/conversions.ts:214


secondsToMs

Const secondsToMs(secs): number

Parameters

Name Type
secs number

Returns

number

Defined in

src/conversions.ts:205


secsToDays

Const secsToDays(secs): DaysObj

Converts seconds to days with remainders

Parameters

Name Type Description
secs number Seconds to convert

Returns

DaysObj

Converted days

Defined in

src/conversions.ts:231


secsToHrs

Const secsToHrs(secs): HoursObj

Converts seconds to hours with remainders

Parameters

Name Type Description
secs number Seconds to convert

Returns

HoursObj

Converted hours

Defined in

src/conversions.ts:222


secsToMins

Const secsToMins(secs): MinutesObj

Converts seconds to minutes with remainders

Parameters

Name Type Description
secs number Seconds to convert

Returns

MinutesObj

Converted minutes

Defined in

src/conversions.ts:213


secsToMs

Const secsToMs(secs): number

Converts seconds to milliseconds

Parameters

Name Type Description
secs number Seconds to convert

Returns

number

Converted milliseconds

Defined in

src/conversions.ts:204


utcToLocal

Const utcToLocal<T>(date): T

Convert a utc date to local

Type parameters

Name Type
T T: Date

Parameters

Name Type Description
date T Date to use. Note that the parameter will never be mutated.

Returns

T

A new date object with the time converted form UTC

Defined in

src/utils.ts:235

Clone this wiki locally