W3cubDocs

/date-fns

Locale

A locale object. Default locale is `en-US`.

Description

A locale object. Default locale is en-US.

If you're using any of these date-fns, consider specifying a locale in options:

differenceInCalendarWeeks
eachWeekOfInterval
endOfWeek
format
formatDistance
formatDistanceStrict
formatRelative
getWeek
getWeekOfMonth
getWeeksInMonth
getWeekYear
isMatch
isSameWeek
isThisWeek
lastDayOfWeek
parse
setDay
setWeek
setWeekYear
startOfWeek
startOfWeekYear

Read the Properties section below for more details.

Properties

Name	Type	Description
`code`	`string`	the locale code (ISO 639-1 + optional country code)
`formatDistance`	`function`	the function that takes a token passed by `formatDistance` or `formatDistanceStrict` and payload, and returns localized distance in words. Required by `formatDistance` and `formatDistanceStrict`
`formatRelative`	`function`	the function that takes a token passed by `formatRelative` and two dates and returns the localized relative date format. Required by `formatRelative`
`localize`	`Object`	the object with functions used to localize various values. Required by `format` and `formatRelative`
`localize.ordinalNumber`	`function`	the function that localizes an ordinal number
`localize.era`	`function`	the function that takes 0 or 1 and returns localized era
`localize.quarter`	`function`	the function that localizes a quarter
`localize.month`	`function`	the function that localizes a month
`localize.day`	`function`	the function that localizes a day of the week
`localize.dayPeriod`	`function`	the function that takes one of the strings 'am', 'pm', 'midnight', 'noon', 'morning', 'afternoon', 'evening' or 'night' and returns localized time of the day
`formatLong`	`Object`	the object with functions that return localized formats
`formatLong.date`	`function`	the function that returns a localized long date format
`formatLong.time`	`function`	the function that returns a localized long time format
`formatLong.dateTime`	`function`	the function that returns a localized format of date and time combined
`match`	`Object`	— the object with functions used to match and parse various localized values. Required by `parse`
`match.ordinalNumber`	`function`	the function that parses a localized ordinal number
`match.era`	`function`	the function that parses a localized era
`match.quarter`	`function`	the function that parses a localized quarter
`match.month`	`function`	the function that parses a localized month
`match.day`	`function`	the function that parses a localized day of the week
`match.dayPeriod`	`function`	the function that parses a localized time of the day
`options`	`Object`	an object with locale options.
`options.weekStartsOn`	`0 1 2 3 4 5 6`	the index of the first day of the week (0 - Sunday). Used by `differenceInCalendarWeeks`, `eachWeekOfInterval`, `endOfWeek`, `format`, `formatRelative`, `getWeek`, `getWeekOfMonth`, `getWeeksInMonth`, `getWeekYear`, `isMatch`, `isSameWeek`, `isThisWeek`, `lastDayOfWeek`, `parse`, `setDay`, `setWeek`, `setWeekYear`, `startOfWeek` and `startOfWeekYear`
`options.firstWeekContainsDate`	`1 2 3 4 5 6 7`	the day of January, which is always in the first week of the year. Used by `format`, `getWeek`, `getWeekYear`, `isMatch`, `parse`, `setWeek`, `setWeekYear` and `startOfWeekYear`.

Exceptions

Type	Description
`RangeError`	`locale` must contain `localize` property. Thrown by `format` and `formatRelative`
`RangeError`	`locale` must contain `formatLong` property. Thrown by `format` and `formatRelative`
`RangeError`	`locale` must contain `formatRelative` property. Thrown by `formatRelative`
`RangeError`	`locale` must contain `formatDistance` property. Thrown by `formatDistance` and `formatDistanceStrict`
`RangeError`	`locale` must contain `match` property. Thrown by `parse`