Skip to content

Commit

Permalink
doc: dedupe links
Browse files Browse the repository at this point in the history
Replace some repeated full links
with concise ones and bottom references.

PR-URL: #18213
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
vsemozhetbyt committed Jan 18, 2018
1 parent 82bdf8f commit f7c709f
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 42 deletions.
17 changes: 9 additions & 8 deletions doc/api/errors.md
Expand Up @@ -1193,8 +1193,8 @@ is not supported.
### ERR_INVALID_SYNC_FORK_INPUT ### ERR_INVALID_SYNC_FORK_INPUT


A `Buffer`, `Uint8Array` or `string` was provided as stdio input to a A `Buffer`, `Uint8Array` or `string` was provided as stdio input to a
synchronous fork. See the documentation for the synchronous fork. See the documentation for the [`child_process`][] module
[`child_process`](child_process.html) module for more information. for more information.


<a id="ERR_INVALID_THIS"></a> <a id="ERR_INVALID_THIS"></a>
### ERR_INVALID_THIS ### ERR_INVALID_THIS
Expand Down Expand Up @@ -1250,22 +1250,22 @@ An attempt was made to use an IPC communication channel that was already closed.
### ERR_IPC_DISCONNECTED ### ERR_IPC_DISCONNECTED


An attempt was made to disconnect an IPC communication channel that was already An attempt was made to disconnect an IPC communication channel that was already
disconnected. See the documentation for the disconnected. See the documentation for the [`child_process`][] module
[`child_process`](child_process.html) module for more information. for more information.


<a id="ERR_IPC_ONE_PIPE"></a> <a id="ERR_IPC_ONE_PIPE"></a>
### ERR_IPC_ONE_PIPE ### ERR_IPC_ONE_PIPE


An attempt was made to create a child Node.js process using more than one IPC An attempt was made to create a child Node.js process using more than one IPC
communication channel. See the documentation for the communication channel. See the documentation for the [`child_process`][] module
[`child_process`](child_process.html) module for more information. for more information.


<a id="ERR_IPC_SYNC_FORK"></a> <a id="ERR_IPC_SYNC_FORK"></a>
### ERR_IPC_SYNC_FORK ### ERR_IPC_SYNC_FORK


An attempt was made to open an IPC communication channel with a synchronously An attempt was made to open an IPC communication channel with a synchronously
forked Node.js process. See the documentation for the forked Node.js process. See the documentation for the [`child_process`][] module
[`child_process`](child_process.html) module for more information. for more information.


<a id="ERR_METHOD_NOT_IMPLEMENTED"></a> <a id="ERR_METHOD_NOT_IMPLEMENTED"></a>
### ERR_METHOD_NOT_IMPLEMENTED ### ERR_METHOD_NOT_IMPLEMENTED
Expand Down Expand Up @@ -1650,6 +1650,7 @@ An attempt was made to use a `zlib` object after it has already been closed.
Creation of a [`zlib`][] object failed due to incorrect configuration. Creation of a [`zlib`][] object failed due to incorrect configuration.


[`--force-fips`]: cli.html#cli_force_fips [`--force-fips`]: cli.html#cli_force_fips
[`child_process`]: child_process.html
[`cipher.getAuthTag()`]: crypto.html#crypto_cipher_getauthtag [`cipher.getAuthTag()`]: crypto.html#crypto_cipher_getauthtag
[`crypto.timingSafeEqual()`]: crypto.html#crypto_crypto_timingsafeequal_a_b [`crypto.timingSafeEqual()`]: crypto.html#crypto_crypto_timingsafeequal_a_b
[`dgram.createSocket()`]: dgram.html#dgram_dgram_createsocket_options_callback [`dgram.createSocket()`]: dgram.html#dgram_dgram_createsocket_options_callback
Expand Down
59 changes: 25 additions & 34 deletions doc/api/n-api.md
Expand Up @@ -1016,8 +1016,7 @@ typedef enum {


This represents the underlying binary scalar datatype of the TypedArray. This represents the underlying binary scalar datatype of the TypedArray.
Elements of this enum correspond to Elements of this enum correspond to
[Section 22.2](https://tc39.github.io/ecma262/#sec-typedarray-objects) [Section 22.2][] of the [ECMAScript Language Specification][].
of the [ECMAScript Language Specification][].


### Object Creation Functions ### Object Creation Functions
#### napi_create_array #### napi_create_array
Expand All @@ -1035,8 +1034,7 @@ Returns `napi_ok` if the API succeeded.
This API returns an N-API value corresponding to a JavaScript Array type. This API returns an N-API value corresponding to a JavaScript Array type.
JavaScript arrays are described in JavaScript arrays are described in
[Section 22.1](https://tc39.github.io/ecma262/#sec-array-objects) of the [Section 22.1][] of the ECMAScript Language Specification.
ECMAScript Language Specification.
#### napi_create_array_with_length #### napi_create_array_with_length
<!-- YAML <!-- YAML
Expand Down Expand Up @@ -1064,8 +1062,7 @@ directly read and/or written via C, consider using
[`napi_create_external_arraybuffer`][]. [`napi_create_external_arraybuffer`][].


JavaScript arrays are described in JavaScript arrays are described in
[Section 22.1](https://tc39.github.io/ecma262/#sec-array-objects) of the [Section 22.1][] of the ECMAScript Language Specification.
ECMAScript Language Specification.


#### napi_create_arraybuffer #### napi_create_arraybuffer
<!-- YAML <!-- YAML
Expand Down Expand Up @@ -1096,8 +1093,7 @@ written to directly from native code. To write to this buffer from JavaScript,
a typed array or DataView object would need to be created. a typed array or DataView object would need to be created.
JavaScript ArrayBuffer objects are described in JavaScript ArrayBuffer objects are described in
[Section 24.1](https://tc39.github.io/ecma262/#sec-arraybuffer-objects) [Section 24.1][] of the ECMAScript Language Specification.
of the ECMAScript Language Specification.
#### napi_create_buffer #### napi_create_buffer
<!-- YAML <!-- YAML
Expand Down Expand Up @@ -1209,8 +1205,7 @@ managed. The caller must ensure that the byte buffer remains valid until the
finalize callback is called. finalize callback is called.
JavaScript ArrayBuffers are described in JavaScript ArrayBuffers are described in
[Section 24.1](https://tc39.github.io/ecma262/#sec-arraybuffer-objects) [Section 24.1][] of the ECMAScript Language Specification.
of the ECMAScript Language Specification.
#### napi_create_external_buffer #### napi_create_external_buffer
<!-- YAML <!-- YAML
Expand Down Expand Up @@ -1351,8 +1346,7 @@ be <= the size in bytes of the array passed in. If not, a RangeError exception i
raised. raised.


JavaScript TypedArray Objects are described in JavaScript TypedArray Objects are described in
[Section 22.2](https://tc39.github.io/ecma262/#sec-typedarray-objects) [Section 22.2][] of the ECMAScript Language Specification.
of the ECMAScript Language Specification.




#### napi_create_dataview #### napi_create_dataview
Expand Down Expand Up @@ -1407,8 +1401,7 @@ This API is used to convert from the C `int32_t` type to the JavaScript
Number type. Number type.


The JavaScript Number type is described in The JavaScript Number type is described in
[Section 6.1.6](https://tc39.github.io/ecma262/#sec-ecmascript-language-types-number-type) [Section 6.1.6][] of the ECMAScript Language Specification.
of the ECMAScript Language Specification.


#### napi_create_uint32 #### napi_create_uint32
<!-- YAML <!-- YAML
Expand All @@ -1428,8 +1421,7 @@ This API is used to convert from the C `uint32_t` type to the JavaScript
Number type. Number type.
The JavaScript Number type is described in The JavaScript Number type is described in
[Section 6.1.6](https://tc39.github.io/ecma262/#sec-ecmascript-language-types-number-type) [Section 6.1.6][] of the ECMAScript Language Specification.
of the ECMAScript Language Specification.
#### napi_create_int64 #### napi_create_int64
<!-- YAML <!-- YAML
Expand All @@ -1448,8 +1440,7 @@ Returns `napi_ok` if the API succeeded.
This API is used to convert from the C `int64_t` type to the JavaScript This API is used to convert from the C `int64_t` type to the JavaScript
Number type. Number type.


The JavaScript Number type is described in The JavaScript Number type is described in [Section 6.1.6][]
[Section 6.1.6](https://tc39.github.io/ecma262/#sec-ecmascript-language-types-number-type)
of the ECMAScript Language Specification. Note the complete range of `int64_t` of the ECMAScript Language Specification. Note the complete range of `int64_t`
cannot be represented with full precision in JavaScript. Integer values cannot be represented with full precision in JavaScript. Integer values
outside the range of outside the range of
Expand All @@ -1476,8 +1467,7 @@ This API is used to convert from the C `double` type to the JavaScript
Number type. Number type.
The JavaScript Number type is described in The JavaScript Number type is described in
[Section 6.1.6](https://tc39.github.io/ecma262/#sec-ecmascript-language-types-number-type) [Section 6.1.6][] of the ECMAScript Language Specification.
of the ECMAScript Language Specification.
#### napi_create_string_latin1 #### napi_create_string_latin1
<!-- YAML <!-- YAML
Expand All @@ -1501,8 +1491,7 @@ Returns `napi_ok` if the API succeeded.
This API creates a JavaScript String object from a ISO-8859-1-encoded C string. This API creates a JavaScript String object from a ISO-8859-1-encoded C string.


The JavaScript String type is described in The JavaScript String type is described in
[Section 6.1.4](https://tc39.github.io/ecma262/#sec-ecmascript-language-types-string-type) [Section 6.1.4][] of the ECMAScript Language Specification.
of the ECMAScript Language Specification.


#### napi_create_string_utf16 #### napi_create_string_utf16
<!-- YAML <!-- YAML
Expand All @@ -1526,8 +1515,7 @@ Returns `napi_ok` if the API succeeded.
This API creates a JavaScript String object from a UTF16-LE-encoded C string This API creates a JavaScript String object from a UTF16-LE-encoded C string
The JavaScript String type is described in The JavaScript String type is described in
[Section 6.1.4](https://tc39.github.io/ecma262/#sec-ecmascript-language-types-string-type) [Section 6.1.4][] of the ECMAScript Language Specification.
of the ECMAScript Language Specification.
#### napi_create_string_utf8 #### napi_create_string_utf8
<!-- YAML <!-- YAML
Expand All @@ -1551,8 +1539,7 @@ Returns `napi_ok` if the API succeeded.
This API creates a JavaScript String object from a UTF8-encoded C string This API creates a JavaScript String object from a UTF8-encoded C string


The JavaScript String type is described in The JavaScript String type is described in
[Section 6.1.4](https://tc39.github.io/ecma262/#sec-ecmascript-language-types-string-type) [Section 6.1.4][] of the ECMAScript Language Specification.
of the ECMAScript Language Specification.


### Functions to convert from N-API to C types ### Functions to convert from N-API to C types
#### napi_get_array_length #### napi_get_array_length
Expand Down Expand Up @@ -1981,7 +1968,7 @@ This API returns the Undefined object.
N-API exposes a set of APIs to perform some abstract operations on JavaScript N-API exposes a set of APIs to perform some abstract operations on JavaScript
values. Some of these operations are documented under values. Some of these operations are documented under
[Section 7](https://tc39.github.io/ecma262/#sec-abstract-operations) [Section 7](https://tc39.github.io/ecma262/#sec-abstract-operations)
of the [ECMAScript Language Specification](https://tc39.github.io/ecma262/). of the [ECMAScript Language Specification][].
These APIs support doing one of the following: These APIs support doing one of the following:
1. Coerce JavaScript values to specific JavaScript types (such as Number or 1. Coerce JavaScript values to specific JavaScript types (such as Number or
Expand Down Expand Up @@ -2249,7 +2236,7 @@ of the ECMAScript Language Specification.
N-API exposes a set of APIs to get and set properties on JavaScript N-API exposes a set of APIs to get and set properties on JavaScript
objects. Some of these types are documented under objects. Some of these types are documented under
[Section 7](https://tc39.github.io/ecma262/#sec-operations-on-objects) of the [Section 7](https://tc39.github.io/ecma262/#sec-operations-on-objects) of the
[ECMAScript Language Specification](https://tc39.github.io/ecma262/). [ECMAScript Language Specification][].


Properties in JavaScript are represented as a tuple of a key and a value. Properties in JavaScript are represented as a tuple of a key and a value.
Fundamentally, all property keys in N-API can be represented in one of the Fundamentally, all property keys in N-API can be represented in one of the
Expand Down Expand Up @@ -2391,19 +2378,17 @@ typedef enum {


`napi_property_attributes` are flags used to control the behavior of properties `napi_property_attributes` are flags used to control the behavior of properties
set on a JavaScript object. Other than `napi_static` they correspond to the set on a JavaScript object. Other than `napi_static` they correspond to the
attributes listed in [Section 6.1.7.1](https://tc39.github.io/ecma262/#table-2) attributes listed in [Section 6.1.7.1][]
of the [ECMAScript Language Specification](https://tc39.github.io/ecma262/). of the [ECMAScript Language Specification][].
They can be one or more of the following bitflags: They can be one or more of the following bitflags:


- `napi_default` - Used to indicate that no explicit attributes are set on the - `napi_default` - Used to indicate that no explicit attributes are set on the
given property. By default, a property is read only, not enumerable and not given property. By default, a property is read only, not enumerable and not
configurable. configurable.
- `napi_writable` - Used to indicate that a given property is writable. - `napi_writable` - Used to indicate that a given property is writable.
- `napi_enumerable` - Used to indicate that a given property is enumerable. - `napi_enumerable` - Used to indicate that a given property is enumerable.
- `napi_configurable` - Used to indicate that a given property is - `napi_configurable` - Used to indicate that a given property is configurable,
configurable, as defined in as defined in [Section 6.1.7.1][] of the [ECMAScript Language Specification][].
[Section 6.1.7.1](https://tc39.github.io/ecma262/#table-2) of the
[ECMAScript Language Specification](https://tc39.github.io/ecma262/).
- `napi_static` - Used to indicate that the property will be defined as - `napi_static` - Used to indicate that the property will be defined as
a static property on a class as opposed to an instance property, which is the a static property on a class as opposed to an instance property, which is the
default. This is used only by [`napi_define_class`][]. It is ignored by default. This is used only by [`napi_define_class`][]. It is ignored by
Expand Down Expand Up @@ -3716,8 +3701,14 @@ NAPI_EXTERN napi_status napi_get_uv_event_loop(napi_env env,
[Object Lifetime Management]: #n_api_object_lifetime_management [Object Lifetime Management]: #n_api_object_lifetime_management
[Object Wrap]: #n_api_object_wrap [Object Wrap]: #n_api_object_wrap
[Script Execution]: #n_api_script_execution [Script Execution]: #n_api_script_execution
[Section 6.1.4]: https://tc39.github.io/ecma262/#sec-ecmascript-language-types-string-type
[Section 6.1.6]: https://tc39.github.io/ecma262/#sec-ecmascript-language-types-number-type
[Section 6.1.7.1]: https://tc39.github.io/ecma262/#table-2
[Section 9.1.6]: https://tc39.github.io/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots-defineownproperty-p-desc [Section 9.1.6]: https://tc39.github.io/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots-defineownproperty-p-desc
[Section 12.5.5]: https://tc39.github.io/ecma262/#sec-typeof-operator [Section 12.5.5]: https://tc39.github.io/ecma262/#sec-typeof-operator
[Section 22.1]: https://tc39.github.io/ecma262/#sec-array-objects
[Section 22.2]: https://tc39.github.io/ecma262/#sec-typedarray-objects
[Section 24.1]: https://tc39.github.io/ecma262/#sec-arraybuffer-objects
[Section 24.3]: https://tc39.github.io/ecma262/#sec-dataview-objects [Section 24.3]: https://tc39.github.io/ecma262/#sec-dataview-objects
[Section 25.4]: https://tc39.github.io/ecma262/#sec-promise-objects [Section 25.4]: https://tc39.github.io/ecma262/#sec-promise-objects
[Working with JavaScript Functions]: #n_api_working_with_javascript_functions [Working with JavaScript Functions]: #n_api_working_with_javascript_functions
Expand Down

0 comments on commit f7c709f

Please sign in to comment.