Function toLocaleString

toLocaleString(
    fullDate: {
        day: DayOfMonth;
        hour: Hour;
        millisecond: number;
        minute: Minute;
        month: MonthNumber;
        second: Minute;
        timezone: string;
        year: number;
    },
    formatOptions?: DateTimeFormatOptions & PartialWithUndefined<
        { locale: string },
    >,
): string
Converts the given FullDate into a string based the user's locale, or the given locale options.
Parameters
- fullDate: {
      day: DayOfMonth;
      hour: Hour;
      millisecond: number;
      minute: Minute;
      month: MonthNumber;
      second: Minute;
      timezone: string;
      year: number;
  }
  - day: DayOfMonth
    A day of the month: 1-31 depending on the month
  - hour: Hour
    Hour of the day in 24 time: 0-23
  - millisecond: number
    Millisecond of the second: 0-999
  - minute: Minute
    Minute of the hour: 0-59
  - month: MonthNumber
    A month of the year: 1-12
  - second: Minute
  - timezone: string
  - year: number
    The full, four digit year.
    
    Example
    2023;
- OptionalformatOptions: DateTimeFormatOptions & PartialWithUndefined<{ locale: string }>
  Defaults to using the user's own locale.
Returns string
Example
```
import {toLocaleString} from 'date-vir';

ToLocaleString({
    year: 2024,
    month: 9,
    day: 25,
    hour: 0,
    minute: 0,
    second: 0,
    millisecond: 0,
});
// `'9/25/2024'` in my locale, yours may be different
```
- Defined in date-vir/src/formatting/formatted-string.ts:36

Function toLocaleString

Parameters

day: DayOfMonth

hour: Hour

millisecond: number

minute: Minute

month: MonthNumber

second: Minute

timezone: string

year: number

Example

Returns string

Example

Settings