date

Pool

Zero-dependency date library - Tree-shakeable alternative to date-fns and moment.js

$ lpm install @lpm.dev/neo.date

README API Skills3 Dependencies Versions1

28 exportsTypeScript

dist

Functions

format

function format(date: Date, options?: FormatOptions): string

Format date using Intl.DateTimeFormat Leverages native Intl API for locale-aware formatting Zero dependencies, all formatting done natively

Parameter	Type	Description
`date`	`Date`	- Date to format
`options`optional	`FormatOptions`	- Formatting options

formatISO

function formatISO(date: Date, options?: ISOFormatOptions): string

Format date as ISO 8601 string

Parameter	Type	Description
`date`	`Date`	- Date to format
`options`optional	`ISOFormatOptions`	- ISO options

formatRelative

function formatRelative(date: Date, baseDate?: Date, options?: RelativeTimeOptions): string

Format date as relative time ("2 hours ago", "in 3 days") Uses Intl.RelativeTimeFormat for locale-aware relative formatting

Parameter	Type	Description
`date`	`Date`	- Date to format
`baseDate`optional	`Date`	- Base date to compare against (defaults to now)
`options`optional	`RelativeTimeOptions`	- Relative time options

parseISO

function parseISO(dateString: string): Date

Parse ISO 8601 date string Supports ISO 8601 and RFC 3339 formats

Parameter	Type	Description
`dateString`	`string`	- ISO 8601 or RFC 3339 string

add

function add(date: Date, duration: Duration): Date

Add duration to date (immutable)

Parameter	Type	Description
`date`	`Date`	- Date to add to
`duration`	`Duration`	- Duration to add

subtract

function subtract(date: Date, duration: Duration): Date

Subtract duration from date (immutable)

Parameter	Type	Description
`date`	`Date`	- Date to subtract from
`duration`	`Duration`	- Duration to subtract

startOf

function startOf(date: Date, unit: 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second'): Date

Get start of time unit (immutable)

Parameter	Type	Description
`date`	`Date`	- Date to operate on
`unit`	`'year' \| 'month' \| 'day' \| 'hour' \| 'minute' \| 'second'`	- Time unit ('year', 'month', 'day', 'hour', 'minute', 'second')

endOf

function endOf(date: Date, unit: 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second'): Date

Get end of time unit (immutable)

Parameter	Type	Description
`date`	`Date`	- Date to operate on
`unit`	`'year' \| 'month' \| 'day' \| 'hour' \| 'minute' \| 'second'`	- Time unit

isValid

function isValid(date: Date): boolean

Check if date is valid

Parameter	Type	Description
`date`	`Date`	- Date to validate

diff

function diff(dateLeft: Date, dateRight: Date, unit: 'years' | 'months' | 'days' | 'hours' | 'minutes' | 'seconds' | 'milliseconds'): number

Calculate difference between dates

Parameter	Type	Description
`dateLeft`	`Date`	- Later date
`dateRight`	`Date`	- Earlier date
`unit`	`'years' \| 'months' \| 'days' \| 'hours' \| 'minutes' \| 'seconds' \| 'milliseconds'`	- Unit to return difference in

compare

function compare(dateLeft: Date, dateRight: Date): number

Compare two dates

Parameter	Type	Description
`dateLeft`	`Date`	- First date
`dateRight`	`Date`	- Second date

isEqual

function isEqual(dateLeft: Date, dateRight: Date): boolean

Check if dates are equal

Parameter	Type	Description
`dateLeft`	`Date`	- First date
`dateRight`	`Date`	- Second date

isBefore

function isBefore(date: Date, dateToCompare: Date): boolean

Check if date is before another

Parameter	Type	Description
`date`	`Date`	- Date to check
`dateToCompare`	`Date`	- Date to compare against

isAfter

function isAfter(date: Date, dateToCompare: Date): boolean

Check if date is after another

Parameter	Type	Description
`date`	`Date`	- Date to check
`dateToCompare`	`Date`	- Date to compare against

dist

Functions

format

function format(date: Date, options?: FormatOptions): string

Format date using Intl.DateTimeFormat Leverages native Intl API for locale-aware formatting Zero dependencies, all formatting done natively

Parameter	Type	Description
`date`	`Date`	- Date to format
`options`optional	`FormatOptions`	- Formatting options

formatISO

function formatISO(date: Date, options?: ISOFormatOptions): string

Format date as ISO 8601 string

Parameter	Type	Description
`date`	`Date`	- Date to format
`options`optional	`ISOFormatOptions`	- ISO options

formatRelative

function formatRelative(date: Date, baseDate?: Date, options?: RelativeTimeOptions): string

Format date as relative time ("2 hours ago", "in 3 days") Uses Intl.RelativeTimeFormat for locale-aware relative formatting

Parameter	Type	Description
`date`	`Date`	- Date to format
`baseDate`optional	`Date`	- Base date to compare against (defaults to now)
`options`optional	`RelativeTimeOptions`	- Relative time options

parseISO

function parseISO(dateString: string): Date

Parse ISO 8601 date string Supports ISO 8601 and RFC 3339 formats

Parameter	Type	Description
`dateString`	`string`	- ISO 8601 or RFC 3339 string

add

function add(date: Date, duration: Duration): Date

Add duration to date (immutable)

Parameter	Type	Description
`date`	`Date`	- Date to add to
`duration`	`Duration`	- Duration to add

subtract

function subtract(date: Date, duration: Duration): Date

Subtract duration from date (immutable)

Parameter	Type	Description
`date`	`Date`	- Date to subtract from
`duration`	`Duration`	- Duration to subtract

startOf

function startOf(date: Date, unit: 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second'): Date

Get start of time unit (immutable)

Parameter	Type	Description
`date`	`Date`	- Date to operate on
`unit`	`'year' \| 'month' \| 'day' \| 'hour' \| 'minute' \| 'second'`	- Time unit ('year', 'month', 'day', 'hour', 'minute', 'second')

endOf

function endOf(date: Date, unit: 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second'): Date

Get end of time unit (immutable)

Parameter	Type	Description
`date`	`Date`	- Date to operate on
`unit`	`'year' \| 'month' \| 'day' \| 'hour' \| 'minute' \| 'second'`	- Time unit

isValid

function isValid(date: Date): boolean

Check if date is valid

Parameter	Type	Description
`date`	`Date`	- Date to validate

diff

function diff(dateLeft: Date, dateRight: Date, unit: 'years' | 'months' | 'days' | 'hours' | 'minutes' | 'seconds' | 'milliseconds'): number

Calculate difference between dates

Parameter	Type	Description
`dateLeft`	`Date`	- Later date
`dateRight`	`Date`	- Earlier date
`unit`	`'years' \| 'months' \| 'days' \| 'hours' \| 'minutes' \| 'seconds' \| 'milliseconds'`	- Unit to return difference in

compare

function compare(dateLeft: Date, dateRight: Date): number

Compare two dates

Parameter	Type	Description
`dateLeft`	`Date`	- First date
`dateRight`	`Date`	- Second date

isEqual

function isEqual(dateLeft: Date, dateRight: Date): boolean

Check if dates are equal

Parameter	Type	Description
`dateLeft`	`Date`	- First date
`dateRight`	`Date`	- Second date

isBefore

function isBefore(date: Date, dateToCompare: Date): boolean

Check if date is before another

Parameter	Type	Description
`date`	`Date`	- Date to check
`dateToCompare`	`Date`	- Date to compare against

isAfter

function isAfter(date: Date, dateToCompare: Date): boolean

Check if date is after another

Parameter	Type	Description
`date`	`Date`	- Date to check
`dateToCompare`	`Date`	- Date to compare against

Unlimited AccessInstall as many Pool packages as you need.

Fund Real WorkEvery install you run sends revenue directly to the developer who built it.

Taxes calculated at checkout based on your location.

Insights

92/100Excellent

Weekly Installs

Version

1.0.0

Published

Repository

github.com(opens in new tab)

Website

neo-demos.vercel.app(opens in new tab)

LicenseMIT

Size61.38 KB

Files10

Node version>= 18

TypeScriptYes