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

Commit

Permalink
style(jsdoc): fixed comments for functions in logger.ts and util.ts
Browse files Browse the repository at this point in the history
  • Loading branch information
yadimon committed Mar 11, 2020
1 parent ddcb9ed commit 27842b8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
10 changes: 6 additions & 4 deletions lib/logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,31 +83,31 @@ export class Logger {

/**
* Log INFO
* @param ...msgs multiple arguments to be logged.
* @param msgs multiple arguments to be logged.
*/
info(...msgs: any[]): void {
this.log_(LogLevel.INFO, msgs);
}

/**
* Log DEBUG
* @param ...msgs multiple arguments to be logged.
* @param msgs multiple arguments to be logged.
*/
debug(...msgs: any[]): void {
this.log_(LogLevel.DEBUG, msgs);
}

/**
* Log WARN
* @param ...msgs multiple arguments to be logged.
* @param msgs multiple arguments to be logged.
*/
warn(...msgs: any[]): void {
this.log_(LogLevel.WARN, msgs);
}

/**
* Log ERROR
* @param ...msgs multiple arguments to be logged.
* @param msgs multiple arguments to be logged.
*/
error(...msgs: any[]): void {
this.log_(LogLevel.ERROR, msgs);
Expand Down Expand Up @@ -221,6 +221,7 @@ export class Logger {
/**
* Get the identifier of the logger as '/<id>'
* @param logLevel The log level of the message.
* @param id not used yet
* @param writeTo The enum for where to write the logs.
* @return The string of the formatted id
*/
Expand All @@ -239,6 +240,7 @@ export class Logger {
/**
* Get the log level formatted with the first letter. For info, it is I.
* @param logLevel The log level of the message.
* @param id not used yet
* @param writeTo The enum for where to write the logs.
* @return The string of the formatted log level
*/
Expand Down
4 changes: 2 additions & 2 deletions lib/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export function filterStackTrace(text: string): string {
/**
* Internal helper for abstraction of polymorphic filenameOrFn properties.
* @param {object} filenameOrFn The filename or function that we will execute.
* @param {Array.<object>}} args The args to pass into filenameOrFn.
* @param {Array.<object>} args The args to pass into filenameOrFn.
* @return {Promise} A promise that will resolve when filenameOrFn completes.
*/
export async function runFilenameOrFn_(
Expand Down Expand Up @@ -82,7 +82,7 @@ export function joinTestLogs(log1: any, log2: any): any {
* Returns false if an error indicates a missing or stale element, re-throws
* the error otherwise
*
* @param {*} The error to check
* @param {*} error The error to check
* @throws {*} The error it was passed if it doesn't indicate a missing or stale
* element
* @return {boolean} false, if it doesn't re-throw the error
Expand Down

0 comments on commit 27842b8

Please sign in to comment.