From a7a7f4f34b147490a713d8b4cef7c6941f3f3eed Mon Sep 17 00:00:00 2001 From: fdipilla Date: Thu, 25 Apr 2024 01:21:14 -0300 Subject: [PATCH] docs(queue): minor styling changes for consistency (#2541) --- src/classes/queue.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/classes/queue.ts b/src/classes/queue.ts index 9326f77f21..82d609dcb6 100644 --- a/src/classes/queue.ts +++ b/src/classes/queue.ts @@ -186,7 +186,7 @@ export class Queue< /** * Adds a new job to the queue. * - * @param name - Name of the job to be added to the queue,. + * @param name - Name of the job to be added to the queue. * @param data - Arbitrary data to append to the job. * @param opts - Job options that affects how the job is going to be processed. */ @@ -319,7 +319,7 @@ export class Queue< * * @see removeRepeatableByKey * - * @param name - job name + * @param name - Job name * @param repeatOpts - * @param jobId - * @returns @@ -342,7 +342,7 @@ export class Queue< * * @see getRepeatableJobs * - * @param repeatJobKey - to the repeatable job. + * @param repeatJobKey - To the repeatable job. * @returns */ async removeRepeatableByKey(key: string): Promise { @@ -369,7 +369,7 @@ export class Queue< * Updates the given job's progress. * * @param jobId - The id of the job to update - * @param progress - number or object to be saved as progress. + * @param progress - Number or object to be saved as progress. */ async updateJobProgress( jobId: string, @@ -382,8 +382,8 @@ export class Queue< * Logs one row of job's log data. * * @param jobId - The job id to log against. - * @param logRow - string with log data to be logged. - * @param keepLogs - max number of log entries to keep (0 for unlimited). + * @param logRow - String with log data to be logged. + * @param keepLogs - Max number of log entries to keep (0 for unlimited). * * @returns The total number of log entries for this job so far. */