1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: fix doc for napi_create_function

Browse Source 
Merge the two duplicate entries for `napi_create_function()`.

Fixes: https://github.com/nodejs/node/issues/21606
PR-URL: https://github.com/nodejs/node/pull/21627/
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This commit is contained in:
Gabriel Schulhof 2018-07-02 18:20:06 -04:00
parent 3314b3a2f5
commit e55bdde925
1 changed files with 8 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
doc/api/n-api.md
View File

@ -1485,40 +1485,6 @@ structure, in most cases using a `TypedArray` will suffice.
For Node.js >=4 `Buffers` are `Uint8Array`s. For Node.js >=4 `Buffers` are `Uint8Array`s.
#### napi_create_function
<!-- YAML
added: v8.0.0
napiVersion: 1
-->
```C
napi_status napi_create_function(napi_env env,
const char* utf8name,
size_t length,
napi_callback cb,
void* data,
napi_value* result)
```
- `[in] env`: The environment that the API is invoked under.
- `[in] utf8name`: A string representing the name of the function encoded as
UTF8.
- `[in] length`: The length of the `utf8name` in bytes, or
`NAPI_AUTO_LENGTH` if it is null-terminated.
- `[in] cb`: A function pointer to the native function to be invoked when the
created function is invoked from JavaScript.
- `[in] data`: Optional arbitrary context data to be passed into the native
function when it is invoked.
- `[out] result`: A `napi_value` representing a JavaScript function.
Returns `napi_ok` if the API succeeded.
This API returns an N-API value corresponding to a JavaScript `Function` object.
It's used to wrap native functions so that they can be invoked from JavaScript.
JavaScript `Function`s are described in
[Section 19.2](https://tc39.github.io/ecma262/#sec-function-objects)
of the ECMAScript Language Specification.
#### napi_create_object #### napi_create_object
<!-- YAML <!-- YAML
added: v8.0.0 added: v8.0.0
@ -3153,6 +3119,7 @@ napiVersion: 1
```C ```C
napi_status napi_create_function(napi_env env, napi_status napi_create_function(napi_env env,
const char* utf8name, const char* utf8name,
size_t length,
napi_callback cb, napi_callback cb,
void* data, void* data,
napi_value* result); napi_value* result);
@ -3161,6 +3128,8 @@ napi_status napi_create_function(napi_env env,
- `[in] env`: The environment that the API is invoked under. - `[in] env`: The environment that the API is invoked under.
- `[in] utf8Name`: The name of the function encoded as UTF8. This is visible - `[in] utf8Name`: The name of the function encoded as UTF8. This is visible
within JavaScript as the new function object's `name` property. within JavaScript as the new function object's `name` property.
- `[in] length`: The length of the `utf8name` in bytes, or
`NAPI_AUTO_LENGTH` if it is null-terminated.
- `[in] cb`: The native function which should be called when this function - `[in] cb`: The native function which should be called when this function
object is invoked. object is invoked.
- `[in] data`: User-provided data context. This will be passed back into the - `[in] data`: User-provided data context. This will be passed back into the
@ -3209,10 +3178,13 @@ const myaddon = require('./addon');
myaddon.sayHello(); myaddon.sayHello();
``` ```
The string passed to require is not necessarily the name passed into The string passed to `require()` is the name of the target in `binding.gyp`
`NAPI_MODULE` in the earlier snippet but the name of the target in `binding.gyp`
responsible for creating the `.node` file. responsible for creating the `.node` file.
JavaScript `Function`s are described in
[Section 19.2](https://tc39.github.io/ecma262/#sec-function-objects)
of the ECMAScript Language Specification.
### napi_get_cb_info ### napi_get_cb_info
<!-- YAML <!-- YAML
added: v8.0.0 added: v8.0.0