1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add leap second behavior notes for napi methods

Browse Source 
napi_create_date and napi_get_date_value ignore leap seconds as per
ECMAScript spec that follows POSIX spec for time, comments added to the
documentation where added fo clarify it.

PR-URL: https://github.com/nodejs/node/pull/29569
Fixes: https://github.com/nodejs/node/issues/29439
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
Levhita 2019-09-15 13:19:07 -05:00 committed by Rich Trott
parent 80cc6f52f5
commit 90b5cdb9e4
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/n-api.md
View File

@ -1775,6 +1775,9 @@ napi_status napi_create_date(napi_env env,
Returns `napi_ok` if the API succeeded. Returns `napi_ok` if the API succeeded.
This API does not observe leap seconds; they are ignored, as
ECMAScript aligns with POSIX time specification.
This API allocates a JavaScript `Date` object. This API allocates a JavaScript `Date` object.
JavaScript `Date` objects are described in JavaScript `Date` objects are described in
@ -2434,6 +2437,9 @@ napi_status napi_get_date_value(napi_env env,
* `[out] result`: Time value as a `double` represented as milliseconds * `[out] result`: Time value as a `double` represented as milliseconds
since midnight at the beginning of 01 January, 1970 UTC. since midnight at the beginning of 01 January, 1970 UTC.
This API does not observe leap seconds; they are ignored, as
ECMAScript aligns with POSIX time specification.
Returns `napi_ok` if the API succeeded. If a non-date `napi_value` is passed Returns `napi_ok` if the API succeeded. If a non-date `napi_value` is passed
in it returns `napi_date_expected`. in it returns `napi_date_expected`.