Skip to content

doc: de-emphasize wrapping in napi_define_class #36159

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
gabrielschulhof wants to merge 2 commits into from
Closed

doc: de-emphasize wrapping in napi_define_class #36159

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d921bc
doc: de-emphasize wrapping in napi_define_class
Nov 18, 2020
9f2d92a
Apply suggestions from code review
Nov 19, 2020
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
Prev Previous commit
Apply suggestions from code review 
Co-authored-by: Rich Trott <rtrott@gmail.com>
  • Loading branch information
@Trott
Gabriel Schulhof and Trott authored Nov 19, 2020
commit 9f2d92ac1cff79a05da6ab80440a205b393b11f9
8 changes: 4 additions & 4 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4739,7 +4739,7 @@ napi_status napi_define_class(napi_env env,

* `[in] env`: The environment that the API is invoked under.
* `[in] utf8name`: Name of the JavaScript constructor function; When wrapping a
C++ class it is recommended for clarity that this name be the same as that of
C++ class, we recommend for clarity that this name be the same as that of
the C++ class.
* `[in] length`: The length of the `utf8name` in bytes, or `NAPI_AUTO_LENGTH`
if it is null-terminated.
Expand All @@ -4761,8 +4761,8 @@ Returns `napi_ok` if the API succeeded.
Defines a JavaScript class, including:

* A JavaScript constructor function that has the class name. When wrapping a
corresponding C++ class, the callback passed via `constructor` may be used to
instantiate a new C++ class instance, which can then be placed "inside" the
corresponding C++ class, the callback passed via `constructor` can be used to
instantiate a new C++ class instance, which can then be placed inside the
JavaScript object instance being constructed using [`napi_wrap`][].
* Properties on the constructor function whose implementation can call
corresponding _static_ data properties, accessors, and methods of the C++
Expand All @@ -4771,7 +4771,7 @@ Defines a JavaScript class, including:
C++ class, _non-static_ data properties, accessors, and methods of the C++
class can be called from the static functions given in the property
descriptors without the `napi_static` attribute after retrieving the C++ class
instance placed "inside" the JavaScript object instance by using
instance placed inside the JavaScript object instance by using
[`napi_unwrap`][].

When wrapping a C++ class, the C++ constructor callback passed via `constructor`
Expand Down