date-vir - v8.5.0
    Preparing search index...

    Function toNewTimezone

    • Converts a FullDate instance into a new instance with the original's date and time represented in the new timezone.

      Type Parameters

      • const SpecificTimezone extends string

      Parameters

      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.

        2023;
        
      import {toNewTimezone} from 'date-vir';

      const exampleDate: FullDate = {
      year: 2024,
      month: 1,
      day: 5,
      hour: 1,
      minute: 1,
      second: 1,
      millisecond: 1,
      timezone: 'UTC',
      };

      let result = toNewTimezone(exampleDate, timezones['Australia/Brisbane']);
      // output:
      result = {
      year: 2024,
      month: 1,
      day: 5,
      hour: 11,
      minute: 1,
      second: 1,
      millisecond: 1,
      timezone: timezones['Australia/Brisbane'],
      };