Skip to content
Permalink
Browse files

doc: delete "a number of" things in the docs

Delete "a number of" phrases in the docs. See what I did there? Ha ha.
Ha ha. Ha. ...heh.. <clears throat/>

PR-URL: #30103
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
Trott authored and targos committed Oct 23, 2019
1 parent ee954d5 commit a56e78c8c83f0490a5384c39a4394b9c74004858
Showing with 28 additions and 32 deletions.
  1. +13 −15 doc/api/addons.md
  2. +3 −4 doc/api/dgram.md
  3. +3 −3 doc/api/globals.md
  4. +3 −3 doc/api/modules.md
  5. +2 −2 doc/api/os.md
  6. +4 −5 doc/api/util.md
@@ -34,16 +34,14 @@ involving knowledge of several components and APIs:
off-loading work via libuv to non-blocking system operations, worker threads
or a custom use of libuv's threads.

* Internal Node.js libraries. Node.js itself exports a number of C++ APIs
that Addons can use &mdash; the most important of which is the
`node::ObjectWrap` class.
* Internal Node.js libraries. Node.js itself exports C++ APIs that Addons can
use, the most important of which is the `node::ObjectWrap` class.

* Node.js includes a number of other statically linked libraries including
OpenSSL. These other libraries are located in the `deps/` directory in the
Node.js source tree. Only the libuv, OpenSSL, V8 and zlib symbols are
purposefully re-exported by Node.js and may be used to various extents by
Addons.
See [Linking to Node.js' own dependencies][] for additional information.
* Node.js includes other statically linked libraries including OpenSSL. These
other libraries are located in the `deps/` directory in the Node.js source
tree. Only the libuv, OpenSSL, V8 and zlib symbols are purposefully
re-exported by Node.js and may be used to various extents by Addons. See
[Linking to Node.js' own dependencies][] for additional information.

All of the following examples are available for [download][] and may
be used as the starting-point for an Addon.
@@ -331,12 +329,12 @@ try {

### Linking to Node.js' own dependencies

Node.js uses a number of statically linked libraries such as V8, libuv and
OpenSSL. All Addons are required to link to V8 and may link to any of the
other dependencies as well. Typically, this is as simple as including
the appropriate `#include <...>` statements (e.g. `#include <v8.h>`) and
`node-gyp` will locate the appropriate headers automatically. However, there
are a few caveats to be aware of:
Node.js uses statically linked libraries such as V8, libuv and OpenSSL. All
Addons are required to link to V8 and may link to any of the other dependencies
as well. Typically, this is as simple as including the appropriate
`#include <...>` statements (e.g. `#include <v8.h>`) and `node-gyp` will locate
the appropriate headers automatically. However, there are a few caveats to be
aware of:

* When `node-gyp` runs, it will detect the specific release version of Node.js
and download either the full source tarball or just the headers. If the full
@@ -589,8 +589,7 @@ packet is allowed to travel through, specifically for multicast traffic. Each
router or gateway that forwards a packet decrements the TTL. If the TTL is
decremented to 0 by a router, it will not be forwarded.

The argument passed to `socket.setMulticastTTL()` is a number of hops
between 0 and 255. The default on most systems is `1` but can vary.
The `ttl` argument may be between 0 and 255. The default on most systems is `1`.

### socket.setRecvBufferSize(size)
<!-- YAML
@@ -625,8 +624,8 @@ travel through. Each router or gateway that forwards a packet decrements the
TTL. If the TTL is decremented to 0 by a router, it will not be forwarded.
Changing TTL values is typically done for network probes or when multicasting.

The argument to `socket.setTTL()` is a number of hops between 1 and 255.
The default on most systems is 64 but can vary.
The `ttl` argument may be between between 1 and 255. The default on most systems
is 64.

### socket.unref()
<!-- YAML
@@ -13,9 +13,9 @@ to be global but are not. They exist only in the scope of modules, see the
* [`module`][]
* [`require()`][]

The objects listed here are specific to Node.js. There are a number of
[built-in objects][] that are part of the JavaScript language itself, which are
also globally accessible.
The objects listed here are specific to Node.js. There are [built-in objects][]
that are part of the JavaScript language itself, which are also globally
accessible.

## Class: Buffer
<!-- YAML
@@ -83,9 +83,9 @@ by checking `require.main.filename`.
<!-- type=misc -->

The semantics of Node.js's `require()` function were designed to be general
enough to support a number of reasonable directory structures. Package manager
programs such as `dpkg`, `rpm`, and `npm` will hopefully find it possible to
build native packages from Node.js modules without modification.
enough to support reasonable directory structures. Package manager programs
such as `dpkg`, `rpm`, and `npm` will hopefully find it possible to build
native packages from Node.js modules without modification.

Below we give a suggested directory structure that could work:

@@ -4,8 +4,8 @@

> Stability: 2 - Stable
The `os` module provides a number of operating system-related utility methods.
It can be accessed using:
The `os` module provides operating system-related utility methods. It can be
accessed using:

```js
const os = require('os');
@@ -1107,11 +1107,10 @@ The encoding supported by the `TextEncoder` instance. Always set to `'utf-8'`.
added: v10.0.0
-->

`util.types` provides a number of type checks for different kinds of built-in
objects. Unlike `instanceof` or `Object.prototype.toString.call(value)`,
these checks do not inspect properties of the object that are accessible from
JavaScript (like their prototype), and usually have the overhead of
calling into C++.
`util.types` provides type checks for different kinds of built-in objects.
Unlike `instanceof` or `Object.prototype.toString.call(value)`, these checks do
not inspect properties of the object that are accessible from JavaScript (like
their prototype), and usually have the overhead of calling into C++.

The result generally does not make any guarantees about what kinds of
properties or behavior a value exposes in JavaScript. They are primarily

0 comments on commit a56e78c

Please sign in to comment.
You can’t perform that action at this time.