Skip to content
This repository was archived by the owner on Jul 29, 2024. It is now read-only.

Commit c49bbe0

Browse files
committed
chore(jsdoc): fixed comments for functions in logger.ts and util.ts
1 parent ddcb9ed commit c49bbe0

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

lib/logger.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,31 +83,31 @@ export class Logger {
8383

8484
/**
8585
* Log INFO
86-
* @param ...msgs multiple arguments to be logged.
86+
* @param msgs multiple arguments to be logged.
8787
*/
8888
info(...msgs: any[]): void {
8989
this.log_(LogLevel.INFO, msgs);
9090
}
9191

9292
/**
9393
* Log DEBUG
94-
* @param ...msgs multiple arguments to be logged.
94+
* @param msgs multiple arguments to be logged.
9595
*/
9696
debug(...msgs: any[]): void {
9797
this.log_(LogLevel.DEBUG, msgs);
9898
}
9999

100100
/**
101101
* Log WARN
102-
* @param ...msgs multiple arguments to be logged.
102+
* @param msgs multiple arguments to be logged.
103103
*/
104104
warn(...msgs: any[]): void {
105105
this.log_(LogLevel.WARN, msgs);
106106
}
107107

108108
/**
109109
* Log ERROR
110-
* @param ...msgs multiple arguments to be logged.
110+
* @param msgs multiple arguments to be logged.
111111
*/
112112
error(...msgs: any[]): void {
113113
this.log_(LogLevel.ERROR, msgs);
@@ -221,6 +221,7 @@ export class Logger {
221221
/**
222222
* Get the identifier of the logger as '/<id>'
223223
* @param logLevel The log level of the message.
224+
* @param id not used yet
224225
* @param writeTo The enum for where to write the logs.
225226
* @return The string of the formatted id
226227
*/
@@ -239,6 +240,7 @@ export class Logger {
239240
/**
240241
* Get the log level formatted with the first letter. For info, it is I.
241242
* @param logLevel The log level of the message.
243+
* @param id not used yet
242244
* @param writeTo The enum for where to write the logs.
243245
* @return The string of the formatted log level
244246
*/

lib/util.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export function filterStackTrace(text: string): string {
3131
/**
3232
* Internal helper for abstraction of polymorphic filenameOrFn properties.
3333
* @param {object} filenameOrFn The filename or function that we will execute.
34-
* @param {Array.<object>}} args The args to pass into filenameOrFn.
34+
* @param {Array.<object>} args The args to pass into filenameOrFn.
3535
* @return {Promise} A promise that will resolve when filenameOrFn completes.
3636
*/
3737
export async function runFilenameOrFn_(
@@ -82,7 +82,7 @@ export function joinTestLogs(log1: any, log2: any): any {
8282
* Returns false if an error indicates a missing or stale element, re-throws
8383
* the error otherwise
8484
*
85-
* @param {*} The error to check
85+
* @param {*} error The error to check
8686
* @throws {*} The error it was passed if it doesn't indicate a missing or stale
8787
* element
8888
* @return {boolean} false, if it doesn't re-throw the error

0 commit comments

Comments
 (0)