Function createFullDate

createFullDate<const SpecificTimezone extends string>(
    dateLike: Readonly<DateLike>,
    timezone: SpecificTimezone,
): {
    day: DayOfMonth;
    hour: Hour;
    millisecond: number;
    minute: Minute;
    month: MonthNumber;
    second: Minute;
    timezone: SpecificTimezone;
    year: number;
}
Parses the given DateLike and converts it into a FullDate instance with the given timezone.
Type Parameters
- const SpecificTimezone extends string
Parameters
- dateLike: Readonly<DateLike>
  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;
}
- 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;
Example
```
import {createFullDate, timezones, utcTimezone} from 'date-vir';

createFullDate('June 1, 2024', utcTimezone);
createFullDate(new Date(), timezones['Australia/Brisbane']);
createFullDate(112300120, timezones['Etc/GMT-11']);
```
Throws
Error: if a valid date cannot be created.
- Defined in date-vir/src/full-date/create-full-date.ts:71

Function createFullDate

Type Parameters

Parameters

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

day: DayOfMonth

hour: Hour

millisecond: number

minute: Minute

month: MonthNumber

second: Minute

timezone: SpecificTimezone

year: number

Example

Example

Throws

Settings

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