Skip to content

doc: remove Returns: {undefined} #18951

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

Closed
shqld wants to merge 2 commits into from
Closed

doc: remove Returns: {undefined} #18951

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13d34dc
doc: remove `Returns: {undefined}`
Feb 21, 2018
741aede
doc: remove a missed `Returns {undefined}`
Feb 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions doc/api/async_hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,8 +692,6 @@ deprecated: REPLACEME
-->
> Stability: 0 - Deprecated: Use [`asyncResource.runInAsyncScope()`][] instead.

* Returns: {undefined}

Call all `before` callbacks to notify that a new asynchronous execution context
is being entered. If nested calls to `emitBefore()` are made, the stack of
`asyncId`s will be tracked and properly unwound.
Expand All @@ -710,8 +708,6 @@ deprecated: REPLACEME
-->
> Stability: 0 - Deprecated: Use [`asyncResource.runInAsyncScope()`][] instead.

* Returns: {undefined}

Call all `after` callbacks. If nested calls to `emitBefore()` were made, then
make sure the stack is unwound properly. Otherwise an error will be thrown.

Expand All @@ -727,8 +723,6 @@ alternative.

#### `asyncResource.emitDestroy()`

* Returns: {undefined}

Call all `destroy` hooks. This should only ever be called once. An error will
be thrown if it is called more than once. This **must** be manually called. If
the resource is left to be collected by the GC then the `destroy` hooks will
Expand Down
1 change: 0 additions & 1 deletion doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -796,7 +796,6 @@ changes:

* `path` {string|Buffer|URL}
* `mode` {integer} **Default:** `fs.constants.F_OK`
* Returns: {undefined}

Synchronously tests a user's permissions for the file or directory specified by
`path`. The `mode` argument is an optional integer that specifies the
Expand Down
8 changes: 0 additions & 8 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,6 @@ added: v8.4.0
* `code` {number} The HTTP/2 error code to send in the final `GOAWAY` frame.
If unspecified, and `error` is not undefined, the default is `INTERNAL_ERROR`,
otherwise defaults to `NO_ERROR`.
* Returns: {undefined}

Immediately terminates the `Http2Session` and the associated `net.Socket` or
`tls.TLSSocket`.
Expand Down Expand Up @@ -470,7 +469,6 @@ added: v8.4.0

* `msecs` {number}
* `callback` {Function}
* Returns: {undefined}

Used to set a callback function that is called when there is no activity on
the `Http2Session` after `msecs` milliseconds. The given `callback` is
Expand Down Expand Up @@ -882,7 +880,6 @@ added: v8.4.0
`http2.constants.NGHTTP2_NO_ERROR` (`0x00`)
* `callback` {Function} An optional function registered to listen for the
`'close'` event.
* Returns: {undefined}

Closes the `Http2Stream` instance by sending an `RST_STREAM` frame to the
connected HTTP/2 peer.
Expand Down Expand Up @@ -933,7 +930,6 @@ added: v8.4.0
and `256` (inclusive).
* `silent` {boolean} When `true`, changes the priority locally without
sending a `PRIORITY` frame to the connected peer.
* Returns: {undefined}

Updates the priority for this `Http2Stream` instance.

Expand Down Expand Up @@ -994,7 +990,6 @@ added: v8.4.0

* `msecs` {number}
* `callback` {Function}
* Returns: {undefined}

```js
const http2 = require('http2');
Expand Down Expand Up @@ -1119,7 +1114,6 @@ added: v8.4.0
-->

* `headers` {HTTP2 Headers Object}
* Returns: {undefined}

Sends an additional informational `HEADERS` frame to the connected HTTP/2 peer.

Expand Down Expand Up @@ -1163,7 +1157,6 @@ added: v8.4.0
* `pushStream` {ServerHttp2Stream} The returned pushStream object.
* `headers` {HTTP2 Headers Object} Headers object the pushStream was
initiated with.
* Returns: {undefined}

Initiates a push stream. The callback is invoked with the new `Http2Stream`
instance created for the push stream passed as the second argument, or an
Expand Down Expand Up @@ -1198,7 +1191,6 @@ added: v8.4.0
include payload data.
* `getTrailers` {Function} Callback function invoked to collect trailer
headers.
* Returns: {undefined}

```js
const http2 = require('http2');
Expand Down