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: clarify persistent ref behavior #42035

Closed
wants to merge 4 commits into from
Closed

doc: clarify persistent ref behavior #42035

Changes from all commits
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 8 additions & 1 deletion doc/api/n-api.md
View file
Open in desktop
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 is created
for the same object, the finalizers for that object will not be
run and the native memory pointed by the earlier persistent reference
will not be freed. This can be avoided by calling
`napi_delete_reference` in addition to `napi_reference_unref` when possible.

#### `napi_create_reference`

Expand Down