Function maybeCreateFullDate

maybeCreateFullDate<const SpecificTimezone extends string>(
    dateLike: Readonly<DateLike> | null | undefined,
    timezone: SpecificTimezone,
):
    | {
        day: DayOfMonth;
        hour: Hour;
        millisecond: number;
        minute: Minute;
        month: MonthNumber;
        second: Minute;
        timezone: SpecificTimezone;
        year: number;
    }
    | undefined
Parses the given DateLike and converts it into a FullDate instance with the given timezone. If the conversion fails or the input DateLike is empty, undefined is returned.
Type Parameters
- const SpecificTimezone extends string
Parameters
- dateLike: Readonly<DateLike> | null | undefined
  The original date representation to be converted into a FullDate.
- timezone: SpecificTimezone
  The timezone that this date/time is meant for / originated from.
Returns
    | {
        day: DayOfMonth;
        hour: Hour;
        millisecond: number;
        minute: Minute;
        month: MonthNumber;
        second: Minute;
        timezone: SpecificTimezone;
        year: number;
    }
    | undefined
- {
      day: DayOfMonth;
      hour: Hour;
      millisecond: number;
      minute: Minute;
      month: MonthNumber;
      second: Minute;
      timezone: SpecificTimezone;
      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: SpecificTimezone
  - year: number
    The full, four digit year.
    Example
    2023;
- undefined
- Defined in date-vir/src/full-date/maybe-create-date.ts:10

Function maybeCreateFullDate

Type Parameters

Parameters

Returns | { day: DayOfMonth; hour: Hour; millisecond: number; minute: Minute; month: MonthNumber; second: Minute; timezone: SpecificTimezone; year: number; } | undefined

day: DayOfMonth

hour: Hour

millisecond: number

minute: Minute

month: MonthNumber

second: Minute

timezone: SpecificTimezone

year: number

Example

Settings

Returns
| {
day: DayOfMonth;
hour: Hour;
millisecond: number;
minute: Minute;
month: MonthNumber;
second: Minute;
timezone: SpecificTimezone;
year: number;
}
| undefined