Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 5 commits into from

Conversation

mhdawson
Copy link
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 <[email protected]>
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/node-api

@nodejs-github-bot 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
doc/api/n-api.md Outdated Show resolved Hide resolved
doc/api/n-api.md Outdated Show resolved Hide resolved
@mhdawson
Copy link
Member Author

mhdawson commented Jun 21, 2024

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.

@mhdawson
Copy link
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 <[email protected]>
Co-authored-by: Gabriel Schulhof <[email protected]>
doc/api/n-api.md Outdated Show resolved Hide resolved
Co-authored-by: Mohammed Keyvanzadeh <[email protected]>
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 <[email protected]>
PR-URL: #53521
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Gabriel Schulhof <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
@mhdawson
Copy link
Member Author

Landed in eb54c54

@mhdawson 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 <[email protected]>
PR-URL: #53521
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Gabriel Schulhof <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
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 <[email protected]>
PR-URL: #53521
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Gabriel Schulhof <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
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 <[email protected]>
PR-URL: #53521
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Gabriel Schulhof <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
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 <[email protected]>
PR-URL: #53521
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Reviewed-By: Gabriel Schulhof <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
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