Skip to content

Commit 86c8987

Browse files
committedApr 5, 2023
Bug 1826366 - [remote] Apply lint --fix for valid-jsdoc in remote r=webdriver-reviewers,whimboo
Differential Revision: https://phabricator.services.mozilla.com/D174738
1 parent 4035aa0 commit 86c8987

File tree

101 files changed

+708
-706
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+708
-706
lines changed
 

‎remote/cdp/CDPConnection.sys.mjs

+13-13
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,11 @@ export class CDPConnection extends WebSocketConnection {
7070
/**
7171
* Send an error back to the CDP client.
7272
*
73-
* @param {Number} id
73+
* @param {number} id
7474
* Id of the packet which lead to an error.
7575
* @param {Error} err
7676
* Error object with `message` and `stack` attributes.
77-
* @param {String=} sessionId
77+
* @param {string=} sessionId
7878
* Id of the session used to send this packet. Falls back to the
7979
* default session if not specified.
8080
*/
@@ -90,12 +90,12 @@ export class CDPConnection extends WebSocketConnection {
9090
/**
9191
* Send an event coming from a Domain to the CDP client.
9292
*
93-
* @param {String} method
93+
* @param {string} method
9494
* The event name. This is composed by a domain name, a dot character
9595
* followed by the event name, e.g. `Target.targetCreated`.
96-
* @param {Object} params
96+
* @param {object} params
9797
* A JSON-serializable object, which is the payload of this event.
98-
* @param {String=} sessionId
98+
* @param {string=} sessionId
9999
* The sessionId from which this packet is emitted. Falls back to the
100100
* default session if not specified.
101101
*/
@@ -129,9 +129,9 @@ export class CDPConnection extends WebSocketConnection {
129129
/**
130130
* Interpret a given CDP packet for a given Session.
131131
*
132-
* @param {String} sessionId
132+
* @param {string} sessionId
133133
* ID of the session for which we should execute a command.
134-
* @param {String} message
134+
* @param {string} message
135135
* The stringified JSON payload of the CDP packet, which is about
136136
* executing a Domain's function.
137137
*/
@@ -158,11 +158,11 @@ export class CDPConnection extends WebSocketConnection {
158158
/**
159159
* Send the result of a call to a Domain's function back to the CDP client.
160160
*
161-
* @param {Number} id
161+
* @param {number} id
162162
* The request id being sent by the client to call the domain's method.
163-
* @param {Object} result
163+
* @param {object} result
164164
* A JSON-serializable object, which is the actual result.
165-
* @param {String=} sessionId
165+
* @param {string=} sessionId
166166
* The sessionId from which this packet is emitted. Falls back to the
167167
* default session if not specified.
168168
*/
@@ -208,7 +208,7 @@ export class CDPConnection extends WebSocketConnection {
208208
* This packet is sent by a CDP client and is meant to execute
209209
* a particular function on a given Domain.
210210
*
211-
* @param {Object} packet
211+
* @param {object} packet
212212
* JSON-serializable object sent by the client.
213213
*/
214214
async onPacket(packet) {
@@ -269,10 +269,10 @@ export class CDPConnection extends WebSocketConnection {
269269
/**
270270
* Splits a CDP method into domain and command components.
271271
*
272-
* @param {String} method
272+
* @param {string} method
273273
* Name of the method to split, e.g. "Browser.getVersion".
274274
*
275-
* @returns {Object<String, String>}
275+
* @returns {Object<string, string>}
276276
* Object with the domain ("Browser") and command ("getVersion")
277277
* as properties.
278278
*/

‎remote/cdp/Error.sys.mjs

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ export class RemoteAgentError extends Error {
5555
* error serialisation to include discrete fields for each data
5656
* property.
5757
*
58-
* @param {Object} json
58+
* @param {object} json
5959
* CDP error encoded as a JSON object, which must have a
6060
* "message" field, where the first line will make out the error
6161
* message and the subsequent lines the stacktrace.
6262
*
63-
* @return {RemoteAgentError}
63+
* @returns {RemoteAgentError}
6464
*/
6565
static fromJSON(json) {
6666
const [message, ...stack] = json.message.split("\n");

0 commit comments

Comments
 (0)
Failed to load comments.