Skip to content

Commit a7a7f4f

Browse files
authored
docs(queue): minor styling changes for consistency (#2541)
1 parent 8a296f1 commit a7a7f4f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/classes/queue.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ export class Queue<
186186
/**
187187
* Adds a new job to the queue.
188188
*
189-
* @param name - Name of the job to be added to the queue,.
189+
* @param name - Name of the job to be added to the queue.
190190
* @param data - Arbitrary data to append to the job.
191191
* @param opts - Job options that affects how the job is going to be processed.
192192
*/
@@ -319,7 +319,7 @@ export class Queue<
319319
*
320320
* @see removeRepeatableByKey
321321
*
322-
* @param name - job name
322+
* @param name - Job name
323323
* @param repeatOpts -
324324
* @param jobId -
325325
* @returns
@@ -342,7 +342,7 @@ export class Queue<
342342
*
343343
* @see getRepeatableJobs
344344
*
345-
* @param repeatJobKey - to the repeatable job.
345+
* @param repeatJobKey - To the repeatable job.
346346
* @returns
347347
*/
348348
async removeRepeatableByKey(key: string): Promise<boolean> {
@@ -369,7 +369,7 @@ export class Queue<
369369
* Updates the given job's progress.
370370
*
371371
* @param jobId - The id of the job to update
372-
* @param progress - number or object to be saved as progress.
372+
* @param progress - Number or object to be saved as progress.
373373
*/
374374
async updateJobProgress(
375375
jobId: string,
@@ -382,8 +382,8 @@ export class Queue<
382382
* Logs one row of job's log data.
383383
*
384384
* @param jobId - The job id to log against.
385-
* @param logRow - string with log data to be logged.
386-
* @param keepLogs - max number of log entries to keep (0 for unlimited).
385+
* @param logRow - String with log data to be logged.
386+
* @param keepLogs - Max number of log entries to keep (0 for unlimited).
387387
*
388388
* @returns The total number of log entries for this job so far.
389389
*/

0 commit comments

Comments
 (0)