Skip to content

doc: clarify persistent ref behavior #42035

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

Closed
mhdawson wants to merge 4 commits into from
Closed

doc: clarify persistent ref behavior #42035

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7ab1196
doc: clarify persistent ref behavior
mhdawson Feb 17, 2022
de0a9e5
Update doc/api/n-api.md
mhdawson Feb 21, 2022
24c862b
squash: address comments
mhdawson Feb 21, 2022
5d744de
fixup
mhdawson Feb 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: clarify persistent ref behavior 
Add explanation of case to be careful of
in order to avoid native memory being kept
alive.

Signed-off-by: Michael Dawson <mdawson@devrus.com>
  • Loading branch information
@mhdawson
mhdawson committed Feb 17, 2022
commit 7ab1196cb67354eda832b4aae117e147ed191c06
9 changes: 8 additions & 1 deletion doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1649,7 +1649,14 @@ the corresponding object on the heap being retained forever.

There can be multiple persistent references created which refer to the same
object, each of which will either keep the object live or not based on its
individual count.
individual count. Multiple persistent references to the same object
can result in unexpectedly keeping alive native memory. The native structures
for a persistent reference must be kept alive until finalizers for the
referenced object are executed. If a new persistent reference to the
is created for the same object, the finalizers for that object will not be
run and the native memory from the earlier persistent reference will
Comment thread
mhdawson marked this conversation as resolved.
Resolved
not be freed. This can be avoided by calling `napi_delete_reference`
in addition to `napi_reference_unref` when possible.
Comment thread
mhdawson marked this conversation as resolved.
Resolved

#### `napi_create_reference`

Expand Down