From 90b5cdb9e4462fe7d826cc4804cd91431db1682e Mon Sep 17 00:00:00 2001 From: Levhita Date: Sun, 15 Sep 2019 13:19:07 -0500 Subject: [PATCH] doc: add leap second behavior notes for napi methods 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 Reviewed-By: Rich Trott --- doc/api/n-api.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 241c50fc4d6..f67825fe561 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -1775,6 +1775,9 @@ napi_status napi_create_date(napi_env env, 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. 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 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 in it returns `napi_date_expected`.