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.

Sign up for GitHub

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

Jump to bottom

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

Closed
wants to merge 5 commits into from
Closed

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

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.

@mhdawson
doc: recommend not using libuv node-api function
7520c08 
- 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>
@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
gabrielschulhof
gabrielschulhof approved these changes Jun 21, 2024
View reviewed changes
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 •
edited
Loading

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
@mhdawson @gabrielschulhof
Update doc/api/n-api.md
69234b8 
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
@mhdawson @gabrielschulhof
Update doc/api/n-api.md
51bc637 
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
@mhdawson
Update n-api.md
29e95f6
VoltrexKeyva
VoltrexKeyva reviewed Jun 23, 2024
View reviewed changes
doc/api/n-api.md Outdated Show resolved Hide resolved
@mhdawson @VoltrexKeyva
Update doc/api/n-api.md
b232a4c 
Co-authored-by: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
mhdawson added a commit that referenced this pull request Jun 24, 2024
@mhdawson
doc: recommend not using libuv node-api function
eb54c54 
- 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>
@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
@mhdawson @targos
doc: recommend not using libuv node-api function
e9e48b5 
- 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>
targos pushed a commit that referenced this pull request Jun 25, 2024
@mhdawson @targos
doc: recommend not using libuv node-api function
608cc05 
- 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>
@targos targos mentioned this pull request Jun 25, 2024
Merged
@Karliz24 Karliz24 mentioned this pull request Jul 9, 2024
Open
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
@mhdawson @marco-ippolito
doc: recommend not using libuv node-api function
0c05b0d 
- 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
@mhdawson @marco-ippolito
doc: recommend not using libuv node-api function
8537a2a 
- 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 marco-ippolito mentioned this pull request Jul 19, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@legendecas legendecas legendecas approved these changes

@VoltrexKeyva VoltrexKeyva VoltrexKeyva left review comments

@NickNaso NickNaso NickNaso approved these changes

@gabrielschulhof gabrielschulhof gabrielschulhof approved these changes

@lpinca lpinca lpinca approved these changes

@aymen94 aymen94 aymen94 approved these changes

@marco-ippolito marco-ippolito marco-ippolito approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@mhdawson @nodejs-github-bot @NickNaso @gabrielschulhof @lpinca @legendecas @aymen94 @marco-ippolito @VoltrexKeyva