Is documentation outdated?

[developer239]

Is the documentation outdated?

https://github.com/nodejs/node-addon-api/blob/main/doc/class_property_descriptor.md#class-property-and-descriptor

Instead of InstanceAccessor<&Example::GetValue>("readOnlyProp")

it should be: InstanceAccessor("getValue", &Point::getValue, nullptr)

What am I missing? 🙂

[developer239]

This one and pretty much everything as well?

https://github.com/nodejs/node-addon-api/blob/main/doc/object_wrap.md

[mhdawson]

We discussed in the Node-API team meeting today. @gabrielschulhof mentioned that they are both legal due to the overrides that are in place.

The are documented in the common base class in https://github.com/nodejs/node-addon-api/blob/main/doc/instance_wrap.md

What makes sense to open the section by saying that this is a helper class created with the InstanceWrap methods and point to the InstanceWrap and ObjectWrap sections.

@gabrielschulhof will submit a PR to update the docs.

[github-actions]

This issue is stale because it has been open many days with no activity. It will be closed soon unless the stale label is removed or a comment is made.

[mhdawson]

@NickNaso is going to take a look this week.

[mhdawson]

Since there is a PR for this taking off the stale review list.

[mhdawson]

The PR to address the issue was merged so closing.