FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: recommend not using libuv node-api function by mhdawson · Pull Request #53521 · nodejs/node · GitHub

/ node Public

doc: recommend not using libuv node-api function - #53521

Closed
mhdawson wants to merge 5 commits into
nodejs:mainfrom
mhdawson:deprecate-get-libuv
Closed

doc: recommend not using libuv node-api function#53521
mhdawson wants to merge 5 commits into
nodejs:mainfrom
mhdawson:deprecate-get-libuv

Conversation

Copy link
Copy Markdown
Member
  • update documentation recommend not using the napi_get_uv_event_loop function. It should not be need for most if not all uses cases now that the API is more complete.

- update documentation recommend not using the
  napi_get_uv_event_loop  function. It should not be
  need for most if not all uses cases now that the
  API is more complete.

Signed-off-by: Michael Dawson <midawson@redhat.com>

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/node-api

nodejs-github-bot added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Jun 20, 2024
Comment thread doc/api/n-api.md
Comment thread doc/api/n-api.md Outdated
Comment thread doc/api/n-api.md Outdated

mhdawson commented Jun 21, 2024
edited
Loading

Copy link
Copy Markdown
Member Author

From discussion in Node-api team meeting today we should also add this to the function

#if defined(__cplusplus) && __cplusplus >= 201402L
[[deprecated]]
#endif

so that users will get deprecation warnings, and possibly create a re-usable definition.

Copy link
Copy Markdown
Member Author

After more discussion, will not include deprecation in c code. Starting with doc only deprecation, then at some later time drecating in the code.

mhdawson and others added 3 commits June 21, 2024 14:14
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
Comment thread doc/api/n-api.md Outdated
Co-authored-by: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
mhdawson added a commit that referenced this pull request Jun 24, 2024
- update documentation recommend not using the
  napi_get_uv_event_loop  function. It should not be
  need for most if not all uses cases now that the
  API is more complete.

Signed-off-by: Michael Dawson <midawson@redhat.com>
PR-URL: #53521
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>

Copy link
Copy Markdown
Member Author

Landed in eb54c54

mhdawson closed this Jun 24, 2024
targos pushed a commit that referenced this pull request Jun 25, 2024
- update documentation recommend not using the
  napi_get_uv_event_loop  function. It should not be
  need for most if not all uses cases now that the
  API is more complete.

Signed-off-by: Michael Dawson <midawson@redhat.com>
PR-URL: #53521
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
- update documentation recommend not using the
  napi_get_uv_event_loop  function. It should not be
  need for most if not all uses cases now that the
  API is more complete.

Signed-off-by: Michael Dawson <midawson@redhat.com>
PR-URL: #53521
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants


Back | FazBrowse Home | New Git URL