close
Skip to main content

@std/datetime@0.225.7
Built and signed on GitHub Actions

Works with
This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score100%
Downloads569/wk
Published3 months ago (0.225.7)

UNSTABLE: Utilities for dealing with Date objects

Functions

f
dayOfYear(date: Date): number

Returns the number of the day in the year in the local time zone.

f
dayOfYearUtc(date: Date): number

Returns the number of the day in the year in UTC time.

f
difference(
from: Date,
to: Date,
options?: DifferenceOptions
): DifferenceFormat

Calculates the difference of the 2 given dates in various units. If the units are omitted, it returns the difference in the all available units.

f
format(
date: Date,
formatString: string,
options?: FormatOptions
): string

Formats a date to a string with the specified format.

f
isLeap(year: Date | number): boolean

Returns whether the given year is a leap year. Passing in a Date object will return the leap year status of the year of that object and take the current timezone into account. Passing in a number will return the leap year status of that number.

f
isUtcLeap(year: Date | number): boolean

Returns whether the given year is a leap year in UTC time. This always returns the same value regardless of the local timezone.

f
parse(
dateString: string,
formatString: string
): Date

Parses a date string using the specified format string.

f
weekOfYear(date: Date): number

Returns the ISO week number of the provided date (1-53).

Interfaces

I

Options for format.

  • timeZone: "UTC"

    The timezone the formatted date should be in.

Type Aliases

T
DifferenceFormat = Partial<Record<Unit, number>>

Return type for difference.

T
DifferenceOptions = { units?: Unit[]; }

Options for difference.

  • units: Unit[]

    Units to calculate difference in. Defaults to all units.

T
Unit =
"milliseconds"
| "seconds"
| "minutes"
| "hours"
| "days"
| "weeks"
| "months"
| "quarters"
| "years"

Duration units for DifferenceFormat and DifferenceOptions.

Variables

v

The month index for April.

v

The month index for August.

v
DAY: number

The number of milliseconds in a day.

v

The month index for December.

v

The month index for February.

v

The day of week index for Friday.

v
HOUR: number

The number of milliseconds in an hour.

v

The month index for January.

v
JULY: 6

The month index for July.

v
JUNE: 5

The month index for June.

v

The month index for March.

v
MAY: 4

The month index for May.

v
MINUTE: number

The number of milliseconds in a minute.

v

The day of week index for Monday.

v

The month index for November.

v

The month index for October.

v

The day of week index for Saturday.

v
SECOND: 1000

The number of milliseconds in a second.

v

The month index for September.

v

The day of week index for Sunday.

v

The day of week index for Thursday.

v

The day of week index for Tuesday.

v

The day of week index for Wednesday.

v
WEEK: number

The number of milliseconds in a week.

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@std/datetime

Import symbol

import * as mod from "@std/datetime";
or

Import directly with a jsr specifier

import * as mod from "jsr:@std/datetime";