Skip to content

doc: document common pattern for instanceof checks #16699

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

doc: document common pattern for instanceof checks #16699

wants to merge 3 commits into from

Conversation

mhdawson
Copy link
Member

@mhdawson mhdawson commented Nov 2, 2017

Fixes: #13824

  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. dont-land-on-v4.x node-api Issues and PRs related to the Node-API. labels Nov 2, 2017
@mhdawson mhdawson mentioned this pull request Nov 2, 2017
Closed
@devsnek
Copy link
Member

devsnek commented Nov 2, 2017

can you also document Napi::Object::InstanceOf usage

@mhdawson
Copy link
Member Author

mhdawson commented Nov 3, 2017

@devsnek I believe Napi::Object::InstanceOf is part of the wrapper not the core N-API. It should be documented here: https://github.com/nodejs/node-addon-api/blob/master/doc/object.md. It is currently empty but there is a push to add documentation there.

@devsnek
Copy link
Member

devsnek commented Nov 3, 2017

@mhdawson ok, sorry for the mixup 👍

cjihrig
cjihrig approved these changes Nov 3, 2017
View reviewed changes
doc/api/n-api.md Outdated
status = napi_instanceof(env, es_this, MyClass_constructor, &is_instance);
assert(napi_ok == status);
if (is_instance) {
// napi_unwrap() ...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should indentation be two spaces here and a couple lines down?

doc/api/n-api.md Outdated
}
```

Of course the reference must be freed once it is no longer needed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can drop "Of course"

@mhdawson
Copy link
Member Author

mhdawson commented Nov 8, 2017

@cjihrig thanks for the comments will update to fix and then land when I'm back from vacation in a week.

@mhdawson
Copy link
Member Author

Ci run: https://ci.nodejs.org/job/node-test-pull-request/11497/

@mhdawson
Copy link
Member Author

Failure on Fedora looks unrelated

Building addon /home/iojs/build/workspace/node-test-commit-linux/nodes/fedora24/test/addons-napi/7_factory_wrap/
env: ‘./node’: Permission denied
Makefile:338: recipe for target 'test/addons-napi/.buildstamp' failed
make[1]: *** [test/addons-napi/.buildstamp] Error 1
make[1]: *** Waiting for unfinished jobs....

Given that this is a doc change.

@mhdawson
Copy link
Member Author

Landed as 9b4ab14

@mhdawson mhdawson closed this Nov 17, 2017
mhdawson added a commit that referenced this pull request Nov 17, 2017
@mhdawson
doc: document common pattern for instanceof checks
9b4ab14 
PR-URL: #16699
Fixes: #13824
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
@mhdawson @MylesBorins
doc: document common pattern for instanceof checks
8dc05e4 
PR-URL: #16699
Fixes: #13824
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Dec 12, 2017
Merged
gibfahn pushed a commit that referenced this pull request Dec 19, 2017
@mhdawson @gibfahn
doc: document common pattern for instanceof checks
d738c6b 
PR-URL: #16699
Fixes: #13824
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@gibfahn gibfahn mentioned this pull request Dec 20, 2017
Closed
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
@mhdawson @gibfahn
doc: document common pattern for instanceof checks
010a330 
PR-URL: #16699
Fixes: #13824
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@gibfahn gibfahn mentioned this pull request Dec 20, 2017
Merged
gabrielschulhof pushed a commit to gabrielschulhof/node that referenced this pull request Apr 16, 2018
@mhdawson
doc: document common pattern for instanceof checks
f450931 
PR-URL: nodejs#16699
Fixes: nodejs#13824
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Apr 16, 2018
@mhdawson @MylesBorins
doc: document common pattern for instanceof checks
35dc8ba 
Backport-PR-URL: #19447
PR-URL: #16699
Fixes: #13824
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Apr 16, 2018
Merged
@mhdawson mhdawson deleted the napi-doc-ref branch September 30, 2019 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@lpinca lpinca lpinca approved these changes

@cjihrig cjihrig cjihrig approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@mhdawson @devsnek @jasnell @lpinca @cjihrig @gibfahn @nodejs-github-bot