Date Utilities

The @utilify/date package offers essential utilities for working with dates and times in JavaScript and TypeScript. These functions are designed to be intuitive, efficient, and type-safe.

Installation

To install the Date package, use one of the following commands:

npm install @utilify/date

yarn add @utilify/date

pnpm add @utilify/date

Import the functions into your project:

import { formatDate, isLeapYear } from '@utilify/date';

const formatted = formatDate(new Date(), 'YYYY-MM-DD');
const leapYear = isLeapYear(2024);
console.log(formatted, leapYear);

const { formatDate, isLeapYear } = require('@utilify/date');

const formatted = formatDate(new Date(), 'YYYY-MM-DD');
const leapYear = isLeapYear(2024);
console.log(formatted, leapYear);

Overview

adjustDate

Signature:

function adjustDate(date: Date, amount: number, unit: TimeUnit): Date

Adjusts a date by adding or subtracting a time interval.

adjustTimezone

Signature:

function adjustTimezone(date: Date, timezoneOffset: number): Date

Converts a date to a different timezone.

convertTimeUnit

Signature:

function convertTimeUnit(time: number, from: TimeUnit, to: TimeUnit): number

Converts time units, such as milliseconds to minutes.

convertDateTo

Signature:

function convertDateTo(date: Date, format: DateFormat): string | undefined

Converts a date to another format or representation.

formatDate

Signature:

function formatDate(date: Date, format: DateFormat = "DMY", separator: string = "/"): string | undefined

Formats a date into a user-friendly string.

formatDuration

Signature:

function formatDuration(ms: number, format: string = "hh:mm:ss", autoHour: boolean = true): string

Formats a duration of time into a readable string.

formatTime

Signature:

function formatTime(date: Date, format: string = "hh:mm:ss"): string | undefined

Formats the time component of a date.

isLeapYear

Signature:

function isLeapYear(year: number): boolean

Checks if a year is a leap year.

isValidDate

Signature:

function isValidDate(date: Date): boolean

Validates whether an object or string represents a valid date.

isValidDateString

Signature:

function isValidDateString(date: string): boolean

Validates whether a string follows a recognized date format.

isWeekday

Signature:

function isWeekday(date: Date): boolean | undefined

Checks if a date is a weekday (Monday to Friday).

isWeekend

Signature:

function isWeekend(date: Date): boolean | undefined

Checks if a date is a weekend (Saturday or Sunday).

parseDate

Signature:

function parseDate(date: string): Date | undefined

Converts a string or number to a Date object.