Skip to content

Latest commit

 

History

History
117 lines (92 loc) · 5.75 KB

helpers_datetime.DateTime.md

File metadata and controls

117 lines (92 loc) · 5.75 KB

@square/site-theme-sdk / Modules / helpers/datetime / DateTime

Class: DateTime

helpers/datetime.DateTime

Table of contents

Constructors

Properties

Constructors

constructor

• new DateTime()

Properties

dateFormats

• dateFormats: Object = DateFormats

Type declaration

Name Type
weekdayShort { weekday: "short" = 'short' }
weekdayShort.weekday "short"
weekdayLong { weekday: "long" = 'long' }
weekdayLong.weekday "long"
hourNminuteN { hour: "numeric" = 'numeric'; minute: "numeric" = 'numeric' }
hourNminuteN.hour "numeric"
hourNminuteN.minute "numeric"
hourNminuteNsecondN { hour: "numeric" = 'numeric'; minute: "numeric" = 'numeric'; second: "numeric" = 'numeric' }
hourNminuteNsecondN.hour "numeric"
hourNminuteNsecondN.minute "numeric"
hourNminuteNsecondN.second "numeric"
yearNmonth2day2 { year: "numeric" = 'numeric'; month: "2-digit" = '2-digit'; day: "2-digit" = '2-digit' }
yearNmonth2day2.year "numeric"
yearNmonth2day2.month "2-digit"
yearNmonth2day2.day "2-digit"
yearNmonthNdayN { year: "numeric" = 'numeric'; month: "numeric" = 'numeric'; day: "numeric" = 'numeric' }
yearNmonthNdayN.year "numeric"
yearNmonthNdayN.month "numeric"
yearNmonthNdayN.day "numeric"
yearNmonthLdayN { year: "numeric" = 'numeric'; month: "long" = 'long'; day: "numeric" = 'numeric' }
yearNmonthLdayN.year "numeric"
yearNmonthLdayN.month "long"
yearNmonthLdayN.day "numeric"
yearNmonthSdayN { year: "numeric" = 'numeric'; month: "short" = 'short'; day: "numeric" = 'numeric' }
yearNmonthSdayN.year "numeric"
yearNmonthSdayN.month "short"
yearNmonthSdayN.day "numeric"
yearNmonthLdayNhourNminuteN { year: "numeric" = 'numeric'; month: "long" = 'long'; day: "numeric" = 'numeric'; hour: "numeric" = 'numeric'; minute: "numeric" = 'numeric' }
yearNmonthLdayNhourNminuteN.year "numeric"
yearNmonthLdayNhourNminuteN.month "long"
yearNmonthLdayNhourNminuteN.day "numeric"
yearNmonthLdayNhourNminuteN.hour "numeric"
yearNmonthLdayNhourNminuteN.minute "numeric"
yearNmonthSdayNhourNminuteN { year: "numeric" = 'numeric'; month: "short" = 'short'; day: "numeric" = 'numeric'; hour: "numeric" = 'numeric'; minute: "numeric" = 'numeric' }
yearNmonthSdayNhourNminuteN.year "numeric"
yearNmonthSdayNhourNminuteN.month "short"
yearNmonthSdayNhourNminuteN.day "numeric"
yearNmonthSdayNhourNminuteN.hour "numeric"
yearNmonthSdayNhourNminuteN.minute "numeric"
weekdayLyearNmonthLdayNhourNminuteN { weekday: "long" = 'long'; year: "numeric" = 'numeric'; month: "long" = 'long'; day: "numeric" = 'numeric'; hour: "numeric" = 'numeric'; minute: "numeric" = 'numeric' }
weekdayLyearNmonthLdayNhourNminuteN.weekday "long"
weekdayLyearNmonthLdayNhourNminuteN.year "numeric"
weekdayLyearNmonthLdayNhourNminuteN.month "long"
weekdayLyearNmonthLdayNhourNminuteN.day "numeric"
weekdayLyearNmonthLdayNhourNminuteN.hour "numeric"
weekdayLyearNmonthLdayNhourNminuteN.minute "numeric"
weekdaySyearNmonthSdayNhourNminuteN { weekday: "short" = 'short'; year: "numeric" = 'numeric'; month: "short" = 'short'; day: "numeric" = 'numeric'; hour: "numeric" = 'numeric'; minute: "numeric" = 'numeric' }
weekdaySyearNmonthSdayNhourNminuteN.weekday "short"
weekdaySyearNmonthSdayNhourNminuteN.year "numeric"
weekdaySyearNmonthSdayNhourNminuteN.month "short"
weekdaySyearNmonthSdayNhourNminuteN.day "numeric"
weekdaySyearNmonthSdayNhourNminuteN.hour "numeric"
weekdaySyearNmonthSdayNhourNminuteN.minute "numeric"
weekdayLhourNminuteN { weekday: "long" = 'long'; hour: "numeric" = 'numeric'; minute: "numeric" = 'numeric' }
weekdayLhourNminuteN.weekday "long"
weekdayLhourNminuteN.hour "numeric"
weekdayLhourNminuteN.minute "numeric"

localizeDate

• localizeDate: (dateObj: Date, locale: string, format: localizeDateFormats, timezone: string, hour12?: boolean) => string = localizeDate

Type declaration

▸ (dateObj, locale, format, timezone, hour12?): string

Transform native JS date objects into a localized string, based on the locale and the format specified.

Parameters
Name Type Description
dateObj Date Date object to be localized
locale string Hyphenized language/country locale combo, e.g. en-US (BCP 47).
format localizeDateFormats Options object specifying the date/time parts to be included in the formatted string
timezone string string specifying a timezone offset the time into
hour12? boolean boolean specifying whether to use 12-hour time format
Returns

string