name: duk_components_to_time

proto: |
  duk_double_t duk_components_to_time(duk_context *ctx, duk_time_components *comp);

summary: |
  <p>Convert components (year, month, day, etc), interpreted in UTC, into a
  time value.  The <code>comp-&gt;weekday</code> argument is ignored in the
  conversion.  If the component values are invalid, an error is thrown.</p>

  <p>There are some differences to the ECMAScript <code>Date.UTC()</code>
  built-in:</p>
  <ul>
  <li>There's no special handling of two-digit years.  For example,
      <code>Date.UTC(99, 0, 1)</code> gets interpreted as 1999-01-01.
      If <code>comp-&gt;time</code> is 99, it's interpreted as the year 99.</li>
  <li>The milliseconds component is allowed fractions (sub-millisecond
      resolution) so that the resulting time value may have fractions.</li>
  </ul>

  <p>Like the ECMAScript primitives, the components can exceed their natural
  range and are normalized.  For example, specifying <code>comp-&gt;minutes</code>
  as 120 is interpreted as adding 2 hours to the time value.  The components are
  expressed as IEEE doubles to allow large and negative values to be used.</p>

example: |
  duk_time_components comp;
  duk_double_t time;

  memset((void *) &comp, 0, sizeof(comp));  /* good practice even if fully initialized */
  comp.year = 2016;
  comp.month = 0;  /* 0-based, 1=January */
  comp.day = 2;    /* 1-based: second of January */
  comp.hours = 3;
  comp.minutes = 4;
  comp.seconds = 5;
  comp.milliseconds = 6.0;  /* allows sub-millisecond resolution */
  comp.weekday = 0;  /* ignored */

  time = duk_components_to_time(ctx, &comp);
  printf("2016-01-02 03:04:05.006Z -> %lf\n", (double) time);

tags:
  - time

seealso:
  - duk_time_to_components

introduced: 2.0.0