search

nodejs / abi-stable-node

Repository used by the Node-API team to manage work related to Node-API and node-addon-api
240 stars 34 forks source link

Document how to check for memory leaks in addon/default leak. #440

Closed mhdawson closed 1 year ago

mhdawson commented 2 years ago

Add to Node.js api docs

1) info on checking addons for memory leaks 2) that by default you will see one leak as outlined in - https://github.com/nodejs/node/issues/44518

mhdawson commented 1 year ago

@KevinEady is going to take a look at this one.

Suggestion is to add to doc in node-addon-api repo

KevinEady commented 1 year ago

I've been working on this, but what I have runs more like a blog-post than a documentation guide. PTAL and add comments as necessary: Checking Node Add-ons for Memory Leaks using Valgrind.

Would this be okay as a format for the node-addon-api doc?

KevinEady commented 1 year ago

PR created https://github.com/nodejs/node/pull/47760

mhdawson commented 1 year ago

PR landed, done