import * as mod from "https://deno.land/x/complaindate@v1.0.1/mod.ts";

ComPlainDate

Date-time utilities that keep timezones on the surface.

Objects

The ComPlainDate interface describes plain-date objects that can be created with the PlainDate factory.

The ComPlainTime interface describes wall-time objects that can be created with the PlainTime factory.

Objects extended for convenience

Note: The extended objects are not tree-shakable, so using them will increase your bundle size... a lot. They are meant for use in backend code only — always use the main objects with utility functions in frontend code!

An extended type of plain-date object is described by the ExtendedPlainDate interface. Those objects are created with the ExPlainDate factory, which also implements the optional functions of the PlainDateFactory interface.

Utility functions

Parsing strings into objects

parsePlainDate (extract plain-date from string)
parsePlainTime (extract plain-time from string)

Splitting native JS `Date` objects into separate plain-date & plain-time objects

splitDateTime - requires a named timezone
splitLocalDateTime
splitUtcDateTime

Generating a new plain-date object from an existing one

Also see pipePlainDate and related type PlainDateMapFn that are useful when implementing your own plain-date mapper functions.

Making user interface strings

formatPlainDate
formatPlainTime
formatInstant
formatTimezone
formatDatetimeLocal (for HTML datetime-local inputs)

Getting information about a plain-date object

Comparing plain-date objects

Creating native JS `Date` objects from plain-date & plain-time objects

createInstant - requires a named timezone
createLocalInstant
createUtcInstant

Generating a new native JS `Date` object from an existing one

Comparing native JS `Date` objects

differenceInMilliseconds

Working with timezone names

safeTimezone - falls back to system timezone
localTimezone (operating system timezone)
supportedCanonicalTimezones
isTimezone
sanitizeTimezone (clean up timezone name)
parseTimezone (extract timezone name from string) - throws error on failure

Variables

v BUSINESS_DAYS_IN_WEEK	5
v DAYS_IN_COMMON_YEAR	365
v DAYS_IN_LEAP_YEAR	366
v DAYS_IN_WEEK	7
v HOURS_IN_DAY	24
v Month	Month (1-12)
v MS_IN_HOUR	Milliseconds in an hour
v MS_IN_MINUTE	Milliseconds in a minute
v MS_IN_SECOND	Milliseconds in a second
v Quarter	Quarter of year (1-4)
v WeekDay	ISO weekday number (1-7) starting with Monday

Functions

f addBusinessDays	Get a function curried with a number of business days to add to its plain-date arguments.
f addDays	Get a function curried with a number of days to add to its plain-date arguments.
f addMonths	Get a function curried with a number of months to add to its plain-date arguments.
f addQuarters	Get a function curried with a number of quarters to add to its plain-date arguments.
f addTime	Get a function curried with a time duration to add to its native JS `Date` arguments.
f addYears	Get a function curried with a number of years to add to its plain-date arguments.
f createInstant	Get a function curried with a timezone, to create native JS `Date` objects from date-time objects interpreted in the timezone.
f createLocalInstant	Create a native JS `Date` object from a date-time interpreted in the system's local timezone.
f createUtcInstant	Create a native JS `Date` object from a date-time interpreted in UTC.
f daysInMonth	Get the number of days in the month for a given date.
f daysInYear	Get the number of days in the year of a given date.
f differenceInBusinessDays	Get a function curried with a plain-date, from which to get the number of crossings into non-weekend days between it and other plain-dates.
f differenceInDays	Get a function curried with a plain-date, from which to get the number of crossings into days between it and other plain-dates.
f differenceInMilliseconds	Get a function curried with a native JS `Date`, from which to get the number of milliseconds between it and other JS `Date` objects.
f differenceInMonths	Get a function curried with a plain-date, from which to get the number of crossings over months between it and other plain-dates.
f differenceInQuarters	Get a function curried with a plain-date, from which to get the number of crossings over quarters between it and other plain-dates.
f differenceInYears	Get a function curried with a date, from which to get the number of crossings over years between it and other dates.
f ExPlainDate	Factory function for making extended plain-date objects with extra properties and convenience methods.
f firstWeekDay	Get a function curried with a weekday to jump to from its plain-date arguments.
f formatDatetimeLocal	Format a string suitable for HTML datetime-local inputs from a date-time object.
f formatInstant	Curry a function to get localized strings of its JS `Date` arguments.
f formatPlainDate	Curry a function to get localized strings of its plain-date arguments.
f formatPlainTime	Curry a function to get localized strings of its plain-time arguments.
f formatTimezone	Format a timezone for display to a user.
f isBusinessDay	Check if a plain-date is within Monday to Friday.
f isFirstDayOfMonth	Check if a date is the first day of its month.
f isFirstDayOfYear	Check if a date is the first day of its year.
f isLastDayOfMonth	Check if a date is the last day of its month.
f isLastDayOfYear	Check if a date is the last day of its year.
f isLeapYear	Check if a date is in a leap year.
f isTimezone	Check if a string is a valid timezone in the system.
f isWeekendDay	Check if a plain-date is a Saturday or Sunday.
f localTimezone	Get the name of the system timezone, and fallback to `"UTC"` if the system doesn't expose a named timezone.
f ordinal	Get the day of the year for a plain-date.
f parsePlainDate	Create a new plain-date object from an ISO date string.
f parsePlainTime	Create a new plain-time object from an ISO time string.
f parseTimezone	Extract a valid timezone name from a string.
f pipePlainDate	Get a function curried with a pipeline of functions to apply to its plain-date arguments, from left to right.
f PlainDate	Factory function for making basic plain-date objects with minimal properties.
f PlainTime	Factory function for making basic plain-time objects with minimal properties.
f quarter	Get the quarter of the year for a plain-date.
f safeTimezone	Get a valid timezone name, adapted for the current user.
f sanitizeTimezone	Clean up a timezone string, removing some common user typos and converting whitespace to underscore.
f splitDateTime	Get a function curried with a timezone, to split native JS `Date` objects into separate plain-date and plain-time parts.
f splitLocalDateTime	Split native JS `Date` objects into separate plain-date and plain-time parts in the system's local timezone.
f splitUtcDateTime	Split native JS `Date` objects into separate plain-date and plain-time parts in UTC.
f startOfBusinessWeek	Jump to the Monday of a plain-date's week.
f startOfMonth	Jump to the first day of a plain-date's month.
f startOfQuarter	Jump to the first day of a plain-date's quarter.
f startOfWeekend	Jump to the Saturday of a plain-date's week.
f startOfYear	Jump to January 1 of a plain-date's year.
f subtractTime	Get a function curried with a time duration to subtract from its native JS `Date` arguments.
f supportedCanonicalTimezones	Get all canonical timezones that are supported by the browser or runtime, or an empty array if the list is not available.
f weekDayNumber	Get the ISO weekday number (1-7) starting with Monday from a plain-date.

Interfaces

I ComPlainDate	Describes a basic plain-date object with minimal properties.
I ComPlainTime	Describes a basic time-of-day object with minimal properties.
I ExtendedPlainDate	Describes an extended plain-date object with extra properties and convenience methods for common operations, of which many are chainable.
I PlainDateFactory	Describes a factory function that creates plain-date objects.
I PlainTimeFactory	Describes a factory function that creates plain-time objects.

Type Aliases

T MonthNumber	Month (1-12)
T PlainDateMapFn	Describes a function taking a plain-date object and returning the same.
T QuarterNumber	Quarter of year (1-4)
T WeekDayNumber	ISO weekday number (1-7) starting with Monday