FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: linkify missing types · nodejs/node@ae372f0 · GitHub

/ node Public

Commit ae372f0

Browse files
vsemozhetbyt
authored and
MylesBorins
committed
doc: linkify missing types
Also, alphabetize all types in type-parser.js and fix some nits in type formats. PR-URL: #18444 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 0a47b98 commit ae372f0

10 files changed

Lines changed: 61 additions & 32 deletions

File tree

‎doc/api/async_hooks.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ added: v8.1.0
8686
* `before` {Function} The [`before` callback][].
8787
* `after` {Function} The [`after` callback][].
8888
* `destroy` {Function} The [`destroy` callback][].
89-
* Returns: `{AsyncHook}` Instance used for disabling and enabling hooks
89+
* Returns: {AsyncHook} Instance used for disabling and enabling hooks
9090

9191
Registers functions to be called for different lifetime events of each async
9292
operation.

‎doc/api/cluster.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ changes:
267267
description: This method now returns a reference to `worker`.
268268
-->
269269

270-
* Returns: {Worker} A reference to `worker`.
270+
* Returns: {cluster.Worker} A reference to `worker`.
271271

272272
In a worker, this function will close all servers, wait for the `'close'` event on
273273
those servers, and then disconnect the IPC channel.

‎doc/api/console.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ const { Console } = console;
7878
```
7979

8080
### new Console(stdout[, stderr])
81-
* `stdout` {Writable}
82-
* `stderr` {Writable}
81+
* `stdout` {stream.Writable}
82+
* `stderr` {stream.Writable}
8383

8484
Creates a new `Console` with one or two writable stream instances. `stdout` is a
8585
writable stream to print log or info output. `stderr` is used for warning or

‎doc/api/fs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -799,7 +799,7 @@ changes:
799799

800800
* `path` {string|Buffer|URL}
801801
* `mode` {integer} **Default:** `fs.constants.F_OK`
802-
* Returns: `undefined`
802+
* Returns: {undefined}
803803

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

‎doc/api/http2.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -770,7 +770,7 @@ they respectively default to:
770770
added: v8.4.0
771771
-->
772772

773-
* Extends: {Duplex}
773+
* Extends: {stream.Duplex}
774774

775775
Each instance of the `Http2Stream` class represents a bidirectional HTTP/2
776776
communications stream over an `Http2Session` instance. Any single `Http2Session`

‎doc/api/process.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -659,7 +659,7 @@ changes:
659659

660660
* `module` {Object}
661661
* `filename` {string}
662-
* `flags` {os.constants.dlopen}. Defaults to `os.constants.dlopen.RTLD_LAZY`.
662+
* `flags` {os.constants.dlopen} Defaults to `os.constants.dlopen.RTLD_LAZY`.
663663

664664
The `process.dlopen()` method allows to dynamically load shared
665665
objects. It is primarily used by `require()` to load

‎doc/api/readline.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ Interface's `input` *as if it were provided by the user*.
323323
added: v0.7.7
324324
-->
325325

326-
* `stream` {Writable}
326+
* `stream` {stream.Writable}
327327
* `dir` {number}
328328
* `-1` - to the left from cursor
329329
* `1` - to the right from cursor
@@ -338,7 +338,7 @@ in a specified direction identified by `dir`.
338338
added: v0.7.7
339339
-->
340340

341-
* `stream` {Writable}
341+
* `stream` {stream.Writable}
342342

343343
The `readline.clearScreenDown()` method clears the given [TTY][] stream from
344344
the current position of the cursor down.
@@ -362,9 +362,9 @@ changes:
362362
-->
363363

364364
* `options` {Object}
365-
* `input` {Readable} The [Readable][] stream to listen to. This option is
365+
* `input` {stream.Readable} The [Readable][] stream to listen to. This option is
366366
*required*.
367-
* `output` {Writable} The [Writable][] stream to write readline data to.
367+
* `output` {stream.Writable} The [Writable][] stream to write readline data to.
368368
* `completer` {Function} An optional function used for Tab autocompletion.
369369
* `terminal` {boolean} `true` if the `input` and `output` streams should be
370370
treated like a TTY, and have ANSI/VT100 escape codes written to it.
@@ -444,7 +444,7 @@ function completer(linePartial, callback) {
444444
added: v0.7.7
445445
-->
446446

447-
* `stream` {Writable}
447+
* `stream` {stream.Writable}
448448
* `x` {number}
449449
* `y` {number}
450450

@@ -456,7 +456,7 @@ given [TTY][] `stream`.
456456
added: v0.7.7
457457
-->
458458

459-
* `stream` {Readable}
459+
* `stream` {stream.Readable}
460460
* `interface` {readline.Interface}
461461

462462
The `readline.emitKeypressEvents()` method causes the given [Readable][]
@@ -482,7 +482,7 @@ if (process.stdin.isTTY)
482482
added: v0.7.7
483483
-->
484484

485-
* `stream` {Writable}
485+
* `stream` {stream.Writable}
486486
* `dx` {number}
487487
* `dy` {number}
488488

‎doc/api/repl.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -412,9 +412,9 @@ changes:
412412
* `options` {Object|string}
413413
* `prompt` {string} The input prompt to display. Defaults to `> `
414414
(with a trailing space).
415-
* `input` {Readable} The Readable stream from which REPL input will be read.
415+
* `input` {stream.Readable} The Readable stream from which REPL input will be read.
416416
Defaults to `process.stdin`.
417-
* `output` {Writable} The Writable stream to which REPL output will be
417+
* `output` {stream.Writable} The Writable stream to which REPL output will be
418418
written. Defaults to `process.stdout`.
419419
* `terminal` {boolean} If `true`, specifies that the `output` should be
420420
treated as a TTY terminal, and have ANSI/VT100 escape codes written to it.

‎doc/api/stream.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ changes:
394394
-->
395395

396396
* `encoding` {string} The new default encoding
397-
* Returns: `this`
397+
* Returns: {this}
398398

399399
The `writable.setDefaultEncoding()` method sets the default `encoding` for a
400400
[Writable][] stream.
@@ -533,7 +533,7 @@ A Writable stream in object mode will always ignore the `encoding` argument.
533533
added: v8.0.0
534534
-->
535535

536-
* Returns: `this`
536+
* Returns: {this}
537537

538538
Destroy the stream, and emit the passed error. After this call, the
539539
writable stream has ended. Implementors should not override this method,
@@ -818,7 +818,7 @@ readable.isPaused(); // === false
818818
added: v0.9.4
819819
-->
820820

821-
* Returns: `this`
821+
* Returns: {this}
822822

823823
The `readable.pause()` method will cause a stream in flowing mode to stop
824824
emitting [`'data'`][] events, switching out of flowing mode. Any data that
@@ -967,7 +967,7 @@ the status of the `highWaterMark`.
967967
added: v0.9.4
968968
-->
969969

970-
* Returns: `this`
970+
* Returns: {this}
971971

972972
The `readable.resume()` method causes an explicitly paused Readable stream to
973973
resume emitting [`'data'`][] events, switching the stream into flowing mode.
@@ -990,7 +990,7 @@ added: v0.9.4
990990
-->
991991

992992
* `encoding` {string} The encoding to use.
993-
* Returns: `this`
993+
* Returns: {this}
994994

995995
The `readable.setEncoding()` method sets the character encoding for
996996
data read from the Readable stream.

‎tools/doc/type-parser.js‎

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,53 +13,82 @@ const jsPrimitives = {
1313
'undefined': 'Undefined'
1414
};
1515
const jsGlobalTypes = [
16-
'Error', 'Object', 'Function', 'Array', 'TypedArray', 'Uint8Array',
17-
'Uint16Array', 'Uint32Array', 'Int8Array', 'Int16Array', 'Int32Array',
18-
'Uint8ClampedArray', 'Float32Array', 'Float64Array', 'Date', 'RegExp',
19-
'ArrayBuffer', 'DataView', 'Promise', 'EvalError', 'RangeError',
20-
'ReferenceError', 'SyntaxError', 'TypeError', 'URIError', 'Proxy', 'Map',
21-
'Set', 'WeakMap', 'WeakSet', 'Generator', 'GeneratorFunction',
22-
'AsyncFunction', 'SharedArrayBuffer'
16+
'Array', 'ArrayBuffer', 'AsyncFunction', 'DataView', 'Date', 'Error',
17+
'EvalError', 'Float32Array', 'Float64Array', 'Function', 'Generator',
18+
'GeneratorFunction', 'Int16Array', 'Int32Array', 'Int8Array', 'Map', 'Object',
19+
'Promise', 'Proxy', 'RangeError', 'ReferenceError', 'RegExp', 'Set',
20+
'SharedArrayBuffer', 'SyntaxError', 'TypeError', 'TypedArray', 'URIError',
21+
'Uint16Array', 'Uint32Array', 'Uint8Array', 'Uint8ClampedArray', 'WeakMap',
22+
'WeakSet'
2323
];
2424
const typeMap = {
2525
'Iterable':
2626
`${jsDocPrefix}Reference/Iteration_protocols#The_iterable_protocol`,
2727
'Iterator':
2828
`${jsDocPrefix}Reference/Iteration_protocols#The_iterator_protocol`,
2929

30+
'this': `${jsDocPrefix}Reference/Operators/this`,
31+
32+
'AsyncHook': 'async_hooks.html#async_hooks_async_hooks_createhook_callbacks',
33+
3034
'Buffer': 'buffer.html#buffer_class_buffer',
3135

3236
'ChildProcess': 'child_process.html#child_process_class_childprocess',
3337

3438
'cluster.Worker': 'cluster.html#cluster_class_worker',
3539

40+
'crypto.constants': 'crypto.html#crypto_crypto_constants_1',
41+
3642
'dgram.Socket': 'dgram.html#dgram_class_dgram_socket',
3743

44+
'Domain': 'domain.html#domain_class_domain',
45+
3846
'EventEmitter': 'events.html#events_class_eventemitter',
3947

48+
'fs.Stats': 'fs.html#fs_class_fs_stats',
49+
4050
'http.Agent': 'http.html#http_class_http_agent',
4151
'http.ClientRequest': 'http.html#http_class_http_clientrequest',
4252
'http.IncomingMessage': 'http.html#http_class_http_incomingmessage',
4353
'http.Server': 'http.html#http_class_http_server',
4454
'http.ServerResponse': 'http.html#http_class_http_serverresponse',
4555

56+
'ClientHttp2Stream': 'http2.html#http2_class_clienthttp2stream',
4657
'HTTP2 Headers Object': 'http2.html#http2_headers_object',
4758
'HTTP2 Settings Object': 'http2.html#http2_settings_object',
59+
'http2.Http2ServerRequest': 'http2.html#http2_class_http2_http2serverrequest',
60+
'http2.Http2ServerResponse':
61+
'http2.html#http2_class_http2_http2serverresponse',
62+
'Http2Server': 'http2.html#http2_class_http2server',
63+
'Http2Session': 'http2.html#http2_class_http2session',
64+
'Http2Stream': 'http2.html#http2_class_http2stream',
65+
'ServerHttp2Stream': 'http2.html#http2_class_serverhttp2stream',
4866

4967
'Handle': 'net.html#net_server_listen_handle_backlog_callback',
68+
'net.Server': 'net.html#net_class_net_server',
5069
'net.Socket': 'net.html#net_class_net_socket',
5170

52-
'ServerHttp2Stream': 'http2.html#http2_class_serverhttp2stream',
71+
'os.constants.dlopen': 'os.html#os_dlopen_constants',
72+
73+
'PerformanceObserver':
74+
'perf_hooks.html#perf_hooks_class_performanceobserver_callback',
75+
'PerformanceObserverEntryList':
76+
'perf_hooks.html#perf_hooks_class_performanceobserverentrylist',
77+
78+
'readline.Interface': 'readline.html#readline_class_interface',
5379

5480
'Stream': 'stream.html#stream_stream',
81+
'stream.Duplex': 'stream.html#stream_class_stream_duplex',
5582
'stream.Readable': 'stream.html#stream_class_stream_readable',
5683
'stream.Writable': 'stream.html#stream_class_stream_writable',
57-
'stream.Duplex': 'stream.html#stream_class_stream_duplex',
58-
59-
'tls.TLSSocket': 'tls.html#tls_class_tls_tlssocket',
6084

85+
'Immediate': 'timers.html#timers_class_immediate',
86+
'Timeout': 'timers.html#timers_class_timeout',
6187
'Timer': 'timers.html#timers_timers',
6288

89+
'tls.Server': 'tls.html#tls_class_tls_server',
90+
'tls.TLSSocket': 'tls.html#tls_class_tls_tlssocket',
91+
6392
'URL': 'url.html#url_the_whatwg_url_api',
6493
'URLSearchParams': 'url.html#url_class_urlsearchparams'
6594
};

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL