Skip to content

Commit 02ecf45

Browse files
Jokerolpinca
Jokero
authored and
lpinca
committed
[minor] Specify optional parameters in JSDoc (#1799)
1 parent 69172fc commit 02ecf45

8 files changed

+125
-104
lines changed

‎lib/event-target.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,11 @@ const EventTarget = {
111111
*
112112
* @param {String} type A string representing the event type to listen for
113113
* @param {Function} listener The listener to add
114-
* @param {Object} options An options object specifies characteristics about
114+
* @param {Object} [options] An options object specifies characteristics about
115115
* the event listener
116-
* @param {Boolean} options.once A `Boolean`` indicating that the listener
117-
* should be invoked at most once after being added. If `true`, the
118-
* listener would be automatically removed when invoked.
116+
* @param {Boolean} [options.once=false] A `Boolean`` indicating that the
117+
* listener should be invoked at most once after being added. If `true`,
118+
* the listener would be automatically removed when invoked.
119119
* @public
120120
*/
121121
addEventListener(type, listener, options) {

‎lib/limiter.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ class Limiter {
1111
/**
1212
* Creates a new `Limiter`.
1313
*
14-
* @param {Number} concurrency The maximum number of jobs allowed to run
15-
* concurrently
14+
* @param {Number} [concurrency=Infinity] The maximum number of jobs allowed
15+
* to run concurrently
1616
*/
1717
constructor(concurrency) {
1818
this[kDone] = () => {

‎lib/permessage-deflate.js

+18-16
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,26 @@ class PerMessageDeflate {
2929
/**
3030
* Creates a PerMessageDeflate instance.
3131
*
32-
* @param {Object} options Configuration options
33-
* @param {Boolean} options.serverNoContextTakeover Request/accept disabling
34-
* of server context takeover
35-
* @param {Boolean} options.clientNoContextTakeover Advertise/acknowledge
36-
* disabling of client context takeover
37-
* @param {(Boolean|Number)} options.serverMaxWindowBits Request/confirm the
32+
* @param {Object} [options] Configuration options
33+
* @param {Boolean} [options.serverNoContextTakeover=false] Request/accept
34+
* disabling of server context takeover
35+
* @param {Boolean} [options.clientNoContextTakeover=false] Advertise/
36+
* acknowledge disabling of client context takeover
37+
* @param {(Boolean|Number)} [options.serverMaxWindowBits] Request/confirm the
3838
* use of a custom server window size
39-
* @param {(Boolean|Number)} options.clientMaxWindowBits Advertise support
39+
* @param {(Boolean|Number)} [options.clientMaxWindowBits] Advertise support
4040
* for, or request, a custom client window size
41-
* @param {Object} options.zlibDeflateOptions Options to pass to zlib on deflate
42-
* @param {Object} options.zlibInflateOptions Options to pass to zlib on inflate
43-
* @param {Number} options.threshold Size (in bytes) below which messages
44-
* should not be compressed
45-
* @param {Number} options.concurrencyLimit The number of concurrent calls to
46-
* zlib
47-
* @param {Boolean} isServer Create the instance in either server or client
48-
* mode
49-
* @param {Number} maxPayload The maximum allowed message length
41+
* @param {Object} [options.zlibDeflateOptions] Options to pass to zlib on
42+
* deflate
43+
* @param {Object} [options.zlibInflateOptions] Options to pass to zlib on
44+
* inflate
45+
* @param {Number} [options.threshold=1024] Size (in bytes) below which
46+
* messages should not be compressed
47+
* @param {Number} [options.concurrencyLimit=10] The number of concurrent
48+
* calls to zlib
49+
* @param {Boolean} [isServer=false] Create the instance in either server or
50+
* client mode
51+
* @param {Number} [maxPayload=0] The maximum allowed message length
5052
*/
5153
constructor(options, isServer, maxPayload) {
5254
this._maxPayload = maxPayload | 0;

‎lib/receiver.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ class Receiver extends Writable {
2828
/**
2929
* Creates a Receiver instance.
3030
*
31-
* @param {String} binaryType The type for binary data
32-
* @param {Object} extensions An object containing the negotiated extensions
33-
* @param {Boolean} isServer Specifies whether to operate in client or server
31+
* @param {String} [binaryType=nodebuffer] The type for binary data
32+
* @param {Object} [extensions] An object containing the negotiated extensions
33+
* @param {Boolean} [isServer=false] Specifies whether to operate in client or server
3434
* mode
35-
* @param {Number} maxPayload The maximum allowed message length
35+
* @param {Number} [maxPayload=0] The maximum allowed message length
3636
*/
3737
constructor(binaryType, extensions, isServer, maxPayload) {
3838
super();

‎lib/sender.js

+46-33
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class Sender {
1717
* Creates a Sender instance.
1818
*
1919
* @param {net.Socket} socket The connection socket
20-
* @param {Object} extensions An object containing the negotiated extensions
20+
* @param {Object} [extensions] An object containing the negotiated extensions
2121
*/
2222
constructor(socket, extensions) {
2323
this._extensions = extensions || {};
@@ -37,10 +37,14 @@ class Sender {
3737
* @param {Buffer} data The data to frame
3838
* @param {Object} options Options object
3939
* @param {Number} options.opcode The opcode
40-
* @param {Boolean} options.readOnly Specifies whether `data` can be modified
41-
* @param {Boolean} options.fin Specifies whether or not to set the FIN bit
42-
* @param {Boolean} options.mask Specifies whether or not to mask `data`
43-
* @param {Boolean} options.rsv1 Specifies whether or not to set the RSV1 bit
40+
* @param {Boolean} [options.readOnly=false] Specifies whether `data` can be
41+
* modified
42+
* @param {Boolean} [options.fin=false] Specifies whether or not to set the
43+
* FIN bit
44+
* @param {Boolean} [options.mask=false] Specifies whether or not to mask
45+
* `data`
46+
* @param {Boolean} [options.rsv1=false] Specifies whether or not to set the
47+
* RSV1 bit
4448
* @return {Buffer[]} The framed data as a list of `Buffer` instances
4549
* @public
4650
*/
@@ -93,10 +97,10 @@ class Sender {
9397
/**
9498
* Sends a close message to the other peer.
9599
*
96-
* @param {(Number|undefined)} code The status code component of the body
97-
* @param {String} data The message component of the body
98-
* @param {Boolean} mask Specifies whether or not to mask the message
99-
* @param {Function} cb Callback
100+
* @param {Number} [code] The status code component of the body
101+
* @param {String} [data] The message component of the body
102+
* @param {Boolean} [mask=false] Specifies whether or not to mask the message
103+
* @param {Function} [cb] Callback
100104
* @public
101105
*/
102106
close(code, data, mask, cb) {
@@ -132,8 +136,8 @@ class Sender {
132136
* Frames and sends a close message.
133137
*
134138
* @param {Buffer} data The message to send
135-
* @param {Boolean} mask Specifies whether or not to mask `data`
136-
* @param {Function} cb Callback
139+
* @param {Boolean} [mask=false] Specifies whether or not to mask `data`
140+
* @param {Function} [cb] Callback
137141
* @private
138142
*/
139143
doClose(data, mask, cb) {
@@ -153,8 +157,8 @@ class Sender {
153157
* Sends a ping message to the other peer.
154158
*
155159
* @param {*} data The message to send
156-
* @param {Boolean} mask Specifies whether or not to mask `data`
157-
* @param {Function} cb Callback
160+
* @param {Boolean} [mask=false] Specifies whether or not to mask `data`
161+
* @param {Function} [cb] Callback
158162
* @public
159163
*/
160164
ping(data, mask, cb) {
@@ -175,9 +179,9 @@ class Sender {
175179
* Frames and sends a ping message.
176180
*
177181
* @param {Buffer} data The message to send
178-
* @param {Boolean} mask Specifies whether or not to mask `data`
179-
* @param {Boolean} readOnly Specifies whether `data` can be modified
180-
* @param {Function} cb Callback
182+
* @param {Boolean} [mask=false] Specifies whether or not to mask `data`
183+
* @param {Boolean} [readOnly=false] Specifies whether `data` can be modified
184+
* @param {Function} [cb] Callback
181185
* @private
182186
*/
183187
doPing(data, mask, readOnly, cb) {
@@ -197,8 +201,8 @@ class Sender {
197201
* Sends a pong message to the other peer.
198202
*
199203
* @param {*} data The message to send
200-
* @param {Boolean} mask Specifies whether or not to mask `data`
201-
* @param {Function} cb Callback
204+
* @param {Boolean} [mask=false] Specifies whether or not to mask `data`
205+
* @param {Function} [cb] Callback
202206
* @public
203207
*/
204208
pong(data, mask, cb) {
@@ -219,9 +223,9 @@ class Sender {
219223
* Frames and sends a pong message.
220224
*
221225
* @param {Buffer} data The message to send
222-
* @param {Boolean} mask Specifies whether or not to mask `data`
223-
* @param {Boolean} readOnly Specifies whether `data` can be modified
224-
* @param {Function} cb Callback
226+
* @param {Boolean} [mask=false] Specifies whether or not to mask `data`
227+
* @param {Boolean} [readOnly=false] Specifies whether `data` can be modified
228+
* @param {Function} [cb] Callback
225229
* @private
226230
*/
227231
doPong(data, mask, readOnly, cb) {
@@ -242,11 +246,15 @@ class Sender {
242246
*
243247
* @param {*} data The message to send
244248
* @param {Object} options Options object
245-
* @param {Boolean} options.compress Specifies whether or not to compress `data`
246-
* @param {Boolean} options.binary Specifies whether `data` is binary or text
247-
* @param {Boolean} options.fin Specifies whether the fragment is the last one
248-
* @param {Boolean} options.mask Specifies whether or not to mask `data`
249-
* @param {Function} cb Callback
249+
* @param {Boolean} [options.compress=false] Specifies whether or not to
250+
* compress `data`
251+
* @param {Boolean} [options.binary=false] Specifies whether `data` is binary
252+
* or text
253+
* @param {Boolean} [options.fin=false] Specifies whether the fragment is the
254+
* last one
255+
* @param {Boolean} [options.mask=false] Specifies whether or not to mask
256+
* `data`
257+
* @param {Function} [cb] Callback
250258
* @public
251259
*/
252260
send(data, options, cb) {
@@ -300,14 +308,19 @@ class Sender {
300308
* Dispatches a data message.
301309
*
302310
* @param {Buffer} data The message to send
303-
* @param {Boolean} compress Specifies whether or not to compress `data`
311+
* @param {Boolean} [compress=false] Specifies whether or not to compress
312+
* `data`
304313
* @param {Object} options Options object
305314
* @param {Number} options.opcode The opcode
306-
* @param {Boolean} options.readOnly Specifies whether `data` can be modified
307-
* @param {Boolean} options.fin Specifies whether or not to set the FIN bit
308-
* @param {Boolean} options.mask Specifies whether or not to mask `data`
309-
* @param {Boolean} options.rsv1 Specifies whether or not to set the RSV1 bit
310-
* @param {Function} cb Callback
315+
* @param {Boolean} [options.readOnly=false] Specifies whether `data` can be
316+
* modified
317+
* @param {Boolean} [options.fin=false] Specifies whether or not to set the
318+
* FIN bit
319+
* @param {Boolean} [options.mask=false] Specifies whether or not to mask
320+
* `data`
321+
* @param {Boolean} [options.rsv1=false] Specifies whether or not to set the
322+
* RSV1 bit
323+
* @param {Function} [cb] Callback
311324
* @private
312325
*/
313326
dispatch(data, compress, options, cb) {
@@ -374,7 +387,7 @@ class Sender {
374387
* Sends a frame.
375388
*
376389
* @param {Buffer[]} list The frame to send
377-
* @param {Function} cb Callback
390+
* @param {Function} [cb] Callback
378391
* @private
379392
*/
380393
sendFrame(list, cb) {

‎lib/stream.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ function duplexOnError(err) {
4242
* Wraps a `WebSocket` in a duplex stream.
4343
*
4444
* @param {WebSocket} ws The `WebSocket` to wrap
45-
* @param {Object} options The options for the `Duplex` constructor
45+
* @param {Object} [options] The options for the `Duplex` constructor
4646
* @return {stream.Duplex} The duplex stream
4747
* @public
4848
*/

‎lib/websocket-server.js

+16-15
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,22 @@ class WebSocketServer extends EventEmitter {
2121
* Create a `WebSocketServer` instance.
2222
*
2323
* @param {Object} options Configuration options
24-
* @param {Number} options.backlog The maximum length of the queue of pending
25-
* connections
26-
* @param {Boolean} options.clientTracking Specifies whether or not to track
27-
* clients
28-
* @param {Function} options.handleProtocols A hook to handle protocols
29-
* @param {String} options.host The hostname where to bind the server
30-
* @param {Number} options.maxPayload The maximum allowed message size
31-
* @param {Boolean} options.noServer Enable no server mode
32-
* @param {String} options.path Accept only connections matching this path
33-
* @param {(Boolean|Object)} options.perMessageDeflate Enable/disable
24+
* @param {Number} [options.backlog=511] The maximum length of the queue of
25+
* pending connections
26+
* @param {Boolean} [options.clientTracking=true] Specifies whether or not to
27+
* track clients
28+
* @param {Function} [options.handleProtocols] A hook to handle protocols
29+
* @param {String} [options.host] The hostname where to bind the server
30+
* @param {Number} [options.maxPayload=104857600] The maximum allowed message
31+
* size
32+
* @param {Boolean} [options.noServer=false] Enable no server mode
33+
* @param {String} [options.path] Accept only connections matching this path
34+
* @param {(Boolean|Object)} [options.perMessageDeflate=false] Enable/disable
3435
* permessage-deflate
35-
* @param {Number} options.port The port where to bind the server
36-
* @param {http.Server} options.server A pre-created HTTP/S server to use
37-
* @param {Function} options.verifyClient A hook to reject connections
38-
* @param {Function} callback A listener for the `listening` event
36+
* @param {Number} [options.port] The port where to bind the server
37+
* @param {http.Server} [options.server] A pre-created HTTP/S server to use
38+
* @param {Function} [options.verifyClient] A hook to reject connections
39+
* @param {Function} [callback] A listener for the `listening` event
3940
*/
4041
constructor(options, callback) {
4142
super();
@@ -119,7 +120,7 @@ class WebSocketServer extends EventEmitter {
119120
/**
120121
* Close the server.
121122
*
122-
* @param {Function} cb Callback
123+
* @param {Function} [cb] Callback
123124
* @public
124125
*/
125126
close(cb) {

0 commit comments

Comments
 (0)