Skip to content

Commit

Permalink
lib,tools: remove empty lines between JSDoc tags
Browse files Browse the repository at this point in the history
This is in preparation for enabling a recommended JSDoc lint rule.

PR-URL: #41147
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Trott authored and danielleadams committed Feb 1, 2022

Verified

This commit was signed with the committer’s verified signature. The key has expired.
danielleadams Danielle Adams
1 parent de2140d commit 4814667
Showing 7 changed files with 1,012 additions and 23 deletions.
4 changes: 3 additions & 1 deletion lib/internal/blob.js
Original file line number Diff line number Diff line change
@@ -123,7 +123,9 @@ function getSource(source, endings) {
class Blob {
/**
* @typedef {string|ArrayBuffer|ArrayBufferView|Blob} SourcePart
*
*/

/**
* @param {SourcePart[]} [sources]
* @param {{
* endings? : string,
955 changes: 955 additions & 0 deletions lib/internal/webstreams/adapters.js

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion lib/internal/webstreams/queuingstrategies.js
Original file line number Diff line number Diff line change
@@ -38,7 +38,9 @@ const isCountQueuingStrategy =
* @callback QueuingStrategySize
* @param {any} chunk
* @returns {number}
*
*/

/**
* @typedef {{
* highWaterMark : number,
* size? : QueuingStrategySize,
33 changes: 24 additions & 9 deletions lib/internal/webstreams/readablestream.js
Original file line number Diff line number Diff line change
@@ -140,45 +140,60 @@ const kPull = Symbol('kPull');
* @typedef {import('./queuingstrategies').QueuingStrategySize
* } QueuingStrategySize
* @typedef {import('./writablestream').WritableStream} WritableStream
*
*/

/**
* @typedef {ReadableStreamDefaultController | ReadableByteStreamController
* } ReadableStreamController
*
*/

/**
* @typedef {ReadableStreamDefaultReader | ReadableStreamBYOBReader
* } ReadableStreamReader
*
*/

/**
* @callback UnderlyingSourceStartCallback
* @param {ReadableStreamController} controller
* @returns { any | Promise<void> }
*
*/

/**
* @callback UnderlyingSourcePullCallback
* @param {ReadableStreamController} controller
* @returns { Promise<void> }
*
*/

/**
* @callback UnderlyingSourceCancelCallback
* @param {any} reason
* @returns { Promise<void> }
*
*/

/**
* @typedef {{
* readable: ReadableStream,
* writable: WritableStream,
* }} ReadableWritablePair
*
*/

/**
* @typedef {{
* preventClose? : boolean,
* preventAbort? : boolean,
* preventCancel? : boolean,
* signal? : AbortSignal,
* }} StreamPipeOptions
*
*/

/**
* @typedef {{
* start? : UnderlyingSourceStartCallback,
* pull? : UnderlyingSourcePullCallback,
* cancel? : UnderlyingSourceCancelCallback,
* type? : "bytes",
* autoAllocateChunkSize? : number
* }} UnderlyingSource
*
*/

class ReadableStream {
16 changes: 12 additions & 4 deletions lib/internal/webstreams/transformstream.js
Original file line number Diff line number Diff line change
@@ -70,19 +70,27 @@ const assert = require('internal/assert');
* } QueuingStrategy
* @typedef {import('./queuingstrategies').QueuingStrategySize
* } QueuingStrategySize
*
*/

/**
* @callback TransformerStartCallback
* @param {TransformStreamDefaultController} controller;
*
*/

/**
* @callback TransformerFlushCallback
* @param {TransformStreamDefaultController} controller;
* @returns {Promise<void>}
*
*/

/**
* @callback TransformerTransformCallback
* @param {any} chunk
* @param {TransformStreamDefaultController} controller
* @returns {Promise<void>}
*
*/

/**
* @typedef {{
* start? : TransformerStartCallback,
* transform? : TransformerTransformCallback,
20 changes: 15 additions & 5 deletions lib/internal/webstreams/writablestream.js
Original file line number Diff line number Diff line change
@@ -83,22 +83,32 @@ const kError = Symbol('kError');
* } QueuingStrategy
* @typedef {import('./queuingstrategies').QueuingStrategySize
* } QueuingStrategySize
*
*/

/**
* @callback UnderlyingSinkStartCallback
* @param {WritableStreamDefaultController} controller
*
*/

/**
* @callback UnderlyingSinkWriteCallback
* @param {any} chunk
* @param {WritableStreamDefaultController} controller
* @returns {Promise<void>}
*
*/

/**
* @callback UnderlyingSinkCloseCallback
* @returns {Promise<void>}
*
*/

/**
* @callback UnderlyingSinkAbortCallback
* @param {any} reason
* @returns {Promise<void>}
*
*/

/**
* @typedef {{
* start? : UnderlyingSinkStartCallback,
* write? : UnderlyingSinkWriteCallback,
3 changes: 0 additions & 3 deletions tools/eslint-rules/crypto-check.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
/**
* @fileoverview Check that common.hasCrypto is used if crypto, tls,
* https, or http2 modules are required.
*
* This rule can be ignored using // eslint-disable-line crypto-check
*
* @author Daniel Bevenius <daniel.bevenius@gmail.com>
*/
'use strict';

0 comments on commit 4814667

Please sign in to comment.