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

Specify when input pointers can be NULL #252

Closed
RReverser opened this issue Jun 11, 2017 · 4 comments
Closed

Specify when input pointers can be NULL #252

RReverser opened this issue Jun 11, 2017 · 4 comments
Assignees
@sampsongao

Comments

@RReverser
Copy link
Member

For example, apparently (according to examples) it’s ok to pass NULL as thisArg and data to napi_get_cb_info if you don’t want to retrieve it, but this is not mentioned in the docs.

Some other places like napi_wrap mention “optional” explicitly for out params, might be a good idea to go through other functions too and explicitly specify when pointer is "optional" or when it must be non-NULL.
@sampsongao sampsongao self-assigned this Aug 17, 2017
@RReverser
Copy link
Member Author

@sampsongao Are you still planning to do this?

@sampsongao
Copy link
Collaborator

I am busy with my assignment for school now. I will continue on this maybe next week or so.

@mhdawson
Copy link
Member

Submitted - nodejs/node#40821 for reported instance.
Leaving open as we should look for other cases where we can add the optional info.

mhdawson added a commit to mhdawson/io.js that referenced this issue Nov 19, 2021
@mhdawson
doc: clarify more optional parameters in node-api
573c449 
Refs: nodejs/abi-stable-node#252

Signed-off-by: Michael Dawson <mdawson@devrus.com>
@mhdawson mhdawson mentioned this issue Nov 19, 2021
Closed
mhdawson added a commit to nodejs/node that referenced this issue Nov 22, 2021
@mhdawson
doc: clarify more optional parameters in node-api
0b4d066 
Refs: nodejs/abi-stable-node#252

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #40888
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
targos pushed a commit to nodejs/node that referenced this issue Nov 26, 2021
@mhdawson @targos
doc: clarify more optional parameters in node-api
cf495a6 
Refs: nodejs/abi-stable-node#252

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #40888
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
mhdawson added a commit to mhdawson/io.js that referenced this issue Nov 29, 2021
@mhdawson
node-api,doc: document parms which can be optional
4781570 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>
@mhdawson mhdawson mentioned this issue Nov 29, 2021
Closed
@mhdawson
Copy link
Member

Submitted nodejs/node#41021 to close out the remaining places that needed an update.

danielleadams pushed a commit to nodejs/node that referenced this issue Dec 13, 2021
@mhdawson @danielleadams
node-api,doc: document parms which can be optional
23b135d 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
danielleadams pushed a commit to nodejs/node that referenced this issue Dec 14, 2021
@mhdawson @danielleadams
node-api,doc: document parms which can be optional
6b6e1d0 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
danielleadams pushed a commit to nodejs/node that referenced this issue Jan 30, 2022
@mhdawson @danielleadams
doc: clarify more optional parameters in node-api
8d2fd07 
Refs: nodejs/abi-stable-node#252

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #40888
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
danielleadams pushed a commit to nodejs/node that referenced this issue Jan 31, 2022
@mhdawson @danielleadams
node-api,doc: document parms which can be optional
b86d54c 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
danielleadams pushed a commit to nodejs/node that referenced this issue Jan 31, 2022
@mhdawson @danielleadams
node-api,doc: document parms which can be optional
8ec81ea 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Linkgoron pushed a commit to Linkgoron/node that referenced this issue Jan 31, 2022
@mhdawson @Linkgoron
node-api,doc: document parms which can be optional
f407820 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: nodejs#41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
danielleadams pushed a commit to nodejs/node that referenced this issue Feb 1, 2022
@mhdawson @danielleadams
doc: clarify more optional parameters in node-api
d217809 
Refs: nodejs/abi-stable-node#252

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #40888
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
danielleadams pushed a commit to nodejs/node that referenced this issue Feb 1, 2022
@mhdawson @danielleadams
node-api,doc: document parms which can be optional
375d04a 
Fixes: nodejs/abi-stable-node#252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sampsongao sampsongao

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

node-api,doc: document parms which can be optional mhdawson/io.js
3 participants
@RReverser @sampsongao @mhdawson