Merge pull request #280 from richardzen/patch-2

chore: format `concurreny.ts` in maxun-core
This commit is contained in:
Karishma Shukla
2024-12-21 16:01:51 +05:30
committed by GitHub

View File

@@ -3,36 +3,36 @@
*/ */
export default class Concurrency { export default class Concurrency {
/** /**
* Maximum number of workers running in parallel. If set to `null`, there is no limit. * Maximum number of workers running in parallel. If set to `null`, there is no limit.
*/ */
maxConcurrency: number = 1; maxConcurrency: number = 1;
/** /**
* Number of currently active workers. * Number of currently active workers.
*/ */
activeWorkers: number = 0; activeWorkers: number = 0;
/** /**
* Queue of jobs waiting to be completed. * Queue of jobs waiting to be completed.
*/ */
private jobQueue: Function[] = []; private jobQueue: Function[] = [];
/** /**
* "Resolve" callbacks of the waitForCompletion() promises. * "Resolve" callbacks of the waitForCompletion() promises.
*/ */
private waiting: Function[] = []; private waiting: Function[] = [];
/** /**
* Constructs a new instance of concurrency manager. * Constructs a new instance of concurrency manager.
* @param {number} maxConcurrency Maximum number of workers running in parallel. * @param {number} maxConcurrency Maximum number of workers running in parallel.
*/ */
constructor(maxConcurrency: number) { constructor(maxConcurrency: number) {
this.maxConcurrency = maxConcurrency; this.maxConcurrency = maxConcurrency;
} }
/** /**
* Takes a waiting job out of the queue and runs it. * Takes a waiting job out of the queue and runs it.
*/ */
private runNextJob(): void { private runNextJob(): void {
const job = this.jobQueue.pop(); const job = this.jobQueue.pop();
@@ -53,12 +53,12 @@ export default class Concurrency {
} }
/** /**
* Pass a job (a time-demanding async function) to the concurrency manager. \ * Pass a job (a time-demanding async function) to the concurrency manager. \
* The time of the job's execution depends on the concurrency manager itself * The time of the job's execution depends on the concurrency manager itself
* (given a generous enough `maxConcurrency` value, it might be immediate, * (given a generous enough `maxConcurrency` value, it might be immediate,
* but this is not guaranteed). * but this is not guaranteed).
* @param worker Async function to be executed (job to be processed). * @param worker Async function to be executed (job to be processed).
*/ */
addJob(job: () => Promise<any>): void { addJob(job: () => Promise<any>): void {
// console.debug("Adding a worker!"); // console.debug("Adding a worker!");
this.jobQueue.push(job); this.jobQueue.push(job);
@@ -72,11 +72,11 @@ export default class Concurrency {
} }
/** /**
* Waits until there is no running nor waiting job. \ * Waits until there is no running nor waiting job. \
* If the concurrency manager is idle at the time of calling this function, * If the concurrency manager is idle at the time of calling this function,
* it waits until at least one job is completed (can be "presubscribed"). * it waits until at least one job is completed (can be "presubscribed").
* @returns Promise, resolved after there is no running/waiting worker. * @returns Promise, resolved after there is no running/waiting worker.
*/ */
waitForCompletion(): Promise<void> { waitForCompletion(): Promise<void> {
return new Promise((res) => { return new Promise((res) => {
this.waiting.push(res); this.waiting.push(res);