therefriedbean
therefriedbean

Reputation: 315

What are the options for 'Date.toLocaleString()'?

According to the MDN documentation for Date.toLocaleString(), the second parameter is an options parameter:

toLocaleString(locales, options)

Which they use in an example:

let date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0));

// Request a weekday along with a long date
let options = { weekday: 'long', year: 'numeric', month: 'long', day: 'numeric' };

console.log(date.toLocaleString('de-DE', options));

My question is, what are the possible properties for the options parameter?

Upvotes: 18

Views: 32739

Answers (2)

Spectric
Spectric

Reputation: 31992

It's the same as those for the Intl.DateTimeFormat() constructor, whose MDN documentation provides a list of each valid property and an explanation.

The possible properties are as follows:

  • dateStyle
  • timeStyle
  • calendar
  • dayPeriod
  • numberingSystem
  • localeMatcher
  • timeZone
  • hour12
  • hourCycle
  • formatMatcher
  • weekday
  • era
  • year
  • month
  • day
  • hour
  • minute
  • second
  • fractionalSecondDigits
  • timeZoneName

See the MDN documentation for the possible values of each property and the behavior.

Upvotes: 17

Gil Epshtain
Gil Epshtain

Reputation: 9801

interface DateTimeFormatOptions {
    formatMatcher?: "basic" | "best fit" | "best fit" | undefined;
    dateStyle?: "full" | "long" | "medium" | "short" | undefined;
    timeStyle?: "full" | "long" | "medium" | "short" | undefined;
    dayPeriod?: "narrow" | "short" | "long" | undefined;
    fractionalSecondDigits?: 1 | 2 | 3 | undefined;
}

Upvotes: 1

Related Questions