date-equality
v0.3.2
Published
Broader date equality checking and mutating
Downloads
5
Maintainers
Readme
Date Equality
Broader date equality checking and mutating
Installation
npm install --save date-equality
Usage
In the browser:
<script src="date-equality.js"></script>
Node/RequireJS
// Typescript/ES6
import * as DE from 'date-equality';
// ES5
var DE = require('date-equality');
API
sameDate
Returns true if the two provided Date
objects are on the same date
function sameDate(left: Date, right: Date): boolean;
Returns true if the two provided Date
objects are in the same week
sameWeek
function sameWeek(left: Date, right: Date, startOfWeek?: number): boolean;
Returns true if the two provided Date
objects have the same time (second precision)
sameDateTime
function sameDateTime(left: Date, right: Date): boolean;
floorDay
Returns a new Date
object that is the start (00h00m00s000ms) of the provided Date
object
function floorDay(date: Date): Date;
ceilDay
Returns a new Date
object that is the end (23h59m59s999ms) of the provided Date
object
function ceilDay(date: Date): Date;
floorWeek
Returns a new Date
object that is the beginning of the week and floored (floorDay(Date)
)
function floorWeek(date: Date, startOfWeek?: number): Date;
ceilWeek
Returns a new Date
object that is the end of the week and ceiled (ceilDay(Date)
)
function ceilWeek(date: Date, startOfWeek?: number): Date;
dateRange
Returns the lower and upper bounds as a DateRange
object from an array of Date
objects
function dateRange(dates: Array<Date>): DateRange;
inRange
Returns true if the provided Date
object is in the DateRange
provided
function inRange(date: Date, range: DateRange): boolean;
DateRange
interface DateRange {
start: Date;
end: Date;
}