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

    Function toHttpDateString

    • Convert a FullDate into an RFC 1123 / HTTP-date string in GMT (for example 'Fri, 05 Jan 2024 01:01:01 GMT'). This is the format used by HTTP headers (per RFC 9110), and is identical to what Date.prototype.toUTCString() produces for the same instant.

      This is distinct from toUtcIsoString, which produces the ISO 8601 format ('2024-01-05T01:01:01.001Z'). Both represent the same instant in UTC, but they are not interchangeable: use this RFC 1123 form wherever an HTTP date is expected (e.g. Date, Last-Modified, Expires, or Retry-After headers), and use toUtcIsoString where ISO 8601 is expected. The output is always rendered in GMT regardless of the input's timezone.

      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.

          2023;

      Returns
          | `Mon, ${number} Jan ${number} ${number}:${number}:${number} GMT`
          | `Mon, ${number} Feb ${number} ${number}:${number}:${number} GMT`
          | `Mon, ${number} Mar ${number} ${number}:${number}:${number} GMT`
          | `Mon, ${number} Apr ${number} ${number}:${number}:${number} GMT`
          | `Mon, ${number} May ${number} ${number}:${number}:${number} GMT`
          | `Mon, ${number} Jun ${number} ${number}:${number}:${number} GMT`
          | `Mon, ${number} Jul ${number} ${number}:${number}:${number} GMT`
          | `Mon, ${number} Aug ${number} ${number}:${number}:${number} GMT`
          | `Mon, ${number} Sep ${number} ${number}:${number}:${number} GMT`
          | `Mon, ${number} Oct ${number} ${number}:${number}:${number} GMT`
          | `Mon, ${number} Nov ${number} ${number}:${number}:${number} GMT`
          | `Mon, ${number} Dec ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} Jan ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} Feb ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} Mar ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} Apr ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} May ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} Jun ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} Jul ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} Aug ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} Sep ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} Oct ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} Nov ${number} ${number}:${number}:${number} GMT`
          | `Tue, ${number} Dec ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} Jan ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} Feb ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} Mar ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} Apr ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} May ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} Jun ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} Jul ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} Aug ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} Sep ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} Oct ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} Nov ${number} ${number}:${number}:${number} GMT`
          | `Wed, ${number} Dec ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} Jan ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} Feb ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} Mar ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} Apr ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} May ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} Jun ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} Jul ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} Aug ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} Sep ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} Oct ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} Nov ${number} ${number}:${number}:${number} GMT`
          | `Thu, ${number} Dec ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} Jan ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} Feb ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} Mar ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} Apr ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} May ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} Jun ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} Jul ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} Aug ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} Sep ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} Oct ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} Nov ${number} ${number}:${number}:${number} GMT`
          | `Fri, ${number} Dec ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} Jan ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} Feb ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} Mar ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} Apr ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} May ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} Jun ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} Jul ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} Aug ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} Sep ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} Oct ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} Nov ${number} ${number}:${number}:${number} GMT`
          | `Sat, ${number} Dec ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} Jan ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} Feb ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} Mar ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} Apr ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} May ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} Jun ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} Jul ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} Aug ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} Sep ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} Oct ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} Nov ${number} ${number}:${number}:${number} GMT`
          | `Sun, ${number} Dec ${number} ${number}:${number}:${number} GMT`

      import {toHttpDateString} from 'date-vir';

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

      toHttpDateString(exampleDate); // `'Fri, 05 Jan 2024 01:01:01 GMT'`

      toUtcIsoString for the ISO 8601 format.

    Settings

    Member Visibility