Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 287946d

Browse filesBrowse files
Sho Miyamotoaddaleax
authored andcommitted
doc: remove Returns: {undefined}
Removed * Returns: {undefined} in doc/ to prevent confusing users PR-URL: #18951 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
1 parent 4f454bd commit 287946d
Copy full SHA for 287946d

File tree

Expand file treeCollapse file tree

3 files changed

+0
-16
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

3 files changed

+0
-16
lines changed
Open diff view settings
Collapse file

‎doc/api/async_hooks.md‎

Copy file name to clipboardExpand all lines: doc/api/async_hooks.md
-6Lines changed: 0 additions & 6 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -686,8 +686,6 @@ deprecated: v9.6.0
686686
-->
687687
> Stability: 0 - Deprecated: Use [`asyncResource.runInAsyncScope()`][] instead.
688688
689-
* Returns: {undefined}
690-
691689
Call all `before` callbacks to notify that a new asynchronous execution context
692690
is being entered. If nested calls to `emitBefore()` are made, the stack of
693691
`asyncId`s will be tracked and properly unwound.
@@ -704,8 +702,6 @@ deprecated: v9.6.0
704702
-->
705703
> Stability: 0 - Deprecated: Use [`asyncResource.runInAsyncScope()`][] instead.
706704
707-
* Returns: {undefined}
708-
709705
Call all `after` callbacks. If nested calls to `emitBefore()` were made, then
710706
make sure the stack is unwound properly. Otherwise an error will be thrown.
711707

@@ -721,8 +717,6 @@ alternative.
721717

722718
#### `asyncResource.emitDestroy()`
723719

724-
* Returns: {undefined}
725-
726720
Call all `destroy` hooks. This should only ever be called once. An error will
727721
be thrown if it is called more than once. This **must** be manually called. If
728722
the resource is left to be collected by the GC then the `destroy` hooks will
Collapse file

‎doc/api/fs.md‎

Copy file name to clipboardExpand all lines: doc/api/fs.md
-1Lines changed: 0 additions & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -788,7 +788,6 @@ changes:
788788

789789
* `path` {string|Buffer|URL}
790790
* `mode` {integer} **Default:** `fs.constants.F_OK`
791-
* Returns: {undefined}
792791

793792
Synchronously tests a user's permissions for the file or directory specified by
794793
`path`. The `mode` argument is an optional integer that specifies the
Collapse file

‎doc/api/http2.md‎

Copy file name to clipboardExpand all lines: doc/api/http2.md
-9Lines changed: 0 additions & 9 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,6 @@ added: v8.4.0
328328
* `code` {number} The HTTP/2 error code to send in the final `GOAWAY` frame.
329329
If unspecified, and `error` is not undefined, the default is `INTERNAL_ERROR`,
330330
otherwise defaults to `NO_ERROR`.
331-
* Returns: {undefined}
332331

333332
Immediately terminates the `Http2Session` and the associated `net.Socket` or
334333
`tls.TLSSocket`.
@@ -471,7 +470,6 @@ added: v8.4.0
471470

472471
* `msecs` {number}
473472
* `callback` {Function}
474-
* Returns: {undefined}
475473

476474
Used to set a callback function that is called when there is no activity on
477475
the `Http2Session` after `msecs` milliseconds. The given `callback` is
@@ -531,7 +529,6 @@ added: v8.4.0
531529
-->
532530

533531
* `settings` {HTTP2 Settings Object}
534-
* Returns {undefined}
535532

536533
Updates the current local settings for this `Http2Session` and sends a new
537534
`SETTINGS` frame to the connected HTTP/2 peer.
@@ -886,7 +883,6 @@ added: v8.4.0
886883
`http2.constants.NGHTTP2_NO_ERROR` (`0x00`)
887884
* `callback` {Function} An optional function registered to listen for the
888885
`'close'` event.
889-
* Returns: {undefined}
890886

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

942937
Updates the priority for this `Http2Stream` instance.
943938

@@ -998,7 +993,6 @@ added: v8.4.0
998993

999994
* `msecs` {number}
1000995
* `callback` {Function}
1001-
* Returns: {undefined}
1002996

1003997
```js
1004998
const http2 = require('http2');
@@ -1121,7 +1115,6 @@ added: v8.4.0
11211115
-->
11221116

11231117
* `headers` {HTTP2 Headers Object}
1124-
* Returns: {undefined}
11251118

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

@@ -1165,7 +1158,6 @@ added: v8.4.0
11651158
* `pushStream` {ServerHttp2Stream} The returned pushStream object.
11661159
* `headers` {HTTP2 Headers Object} Headers object the pushStream was
11671160
initiated with.
1168-
* Returns: {undefined}
11691161

11701162
Initiates a push stream. The callback is invoked with the new `Http2Stream`
11711163
instance created for the push stream passed as the second argument, or an
@@ -1200,7 +1192,6 @@ added: v8.4.0
12001192
include payload data.
12011193
* `getTrailers` {Function} Callback function invoked to collect trailer
12021194
headers.
1203-
* Returns: {undefined}
12041195

12051196
```js
12061197
const http2 = require('http2');

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.