qpass 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -79,6 +79,7 @@ Use the global build from your package output or CDN:
79
79
  new Qpass({
80
80
  breakWhenError?: boolean;
81
81
  batchSize?: number; // >= 1, default: 1
82
+ rolling?: boolean; // default: false
82
83
  onProgress?: (progress: {
83
84
  batchToProcess: number;
84
85
  itemsToProcess: number;
@@ -92,16 +93,17 @@ new Qpass({
92
93
  - `batchSize` (default `1`): number of jobs to run in parallel per cycle.
93
94
  - `breakWhenError` (default `false`): when `true`, queued jobs are cleared after an error is seen.
94
95
  - `onProgress`: called after each cycle finishes.
96
+ - `rolling` (default `false`): start a waiting job as soon as ANY running job settles, keeping at most `batchSize` running, instead of waiting for the whole cycle to finish. A job that never settles then holds one slot instead of stopping the queue. See [Rolling mode](#rolling-mode).
95
97
 
96
98
  ### `add(jobs)`
97
99
 
98
100
  ```ts
99
- add(jobs: (() => Promise<any>)[] | (() => Promise<any>)): string | string[]
101
+ add(jobs: (() => Promise<any>)[] | (() => Promise<any>)): string[]
100
102
  ```
101
103
 
102
104
  - Adds one or many jobs to the queue.
103
105
  - Starts processing automatically.
104
- - Returns the generated job id for a single job, or an array of ids for multiple jobs.
106
+ - Returns the array of ids for multiple jobs.
105
107
 
106
108
  ### `remove(id)`
107
109
 
@@ -113,6 +115,17 @@ remove(id: string | number): boolean
113
115
  - Returns `true` when a queued job is removed, or `false` if the id was not found.
114
116
  - Does not stop jobs already in progress.
115
117
 
118
+ ### `setBatchSize(size)`
119
+
120
+ ```ts
121
+ setBatchSize(size: number): void
122
+ ```
123
+
124
+ - Changes the number of jobs processed per batch.
125
+ - Takes effect on the next batch; any batch already in progress completes at its original size.
126
+ - Throws if `size` is not a number or is less than `1`.
127
+ - Safe to call at any point: mid-processing, while adding, or while removing jobs.
128
+
116
129
  ### `terminate()`
117
130
 
118
131
  ```ts
@@ -135,6 +148,24 @@ Notes:
135
148
  - Progress is reported per cycle, not per individual job completion.
136
149
  - If you call `add` repeatedly (for example, inside a loop), the first cycle may be smaller than `batchSize` because processing starts immediately.
137
150
 
151
+ ## Rolling mode
152
+
153
+ By default Qpass runs jobs in cycles: it starts up to `batchSize` jobs and starts nothing more until every one of them has settled. If one job never settles (a network request that never gets an answer, for example), the cycle never ends and every job queued after it waits forever.
154
+
155
+ With `rolling: true` there are no cycles. Whenever a job settles, the next waiting job starts, so at most `batchSize` jobs are running at any moment and a stuck job only holds its own slot.
156
+
157
+ ```js
158
+ const queue = new Qpass({ batchSize: 3, rolling: true });
159
+ ```
160
+
161
+ In rolling mode:
162
+
163
+ - `onProgress` is called every `batchSize` completions and whenever the queue becomes idle (nothing running, nothing waiting), with the same `{ batchToProcess, itemsToProcess, completed }` shape. `completed` holds the results since the previous call.
164
+ - `setBatchSize` takes effect at once: a larger size starts waiting jobs right away, a smaller one lets running jobs finish down to it.
165
+ - `breakWhenError` and `terminate()` behave as in cycle mode: waiting jobs are cleared, running ones still settle.
166
+
167
+ Rolling mode does not time jobs out. A job that never settles keeps its slot; give the job itself a timeout if it can hang.
168
+
138
169
  ## Error handling
139
170
 
140
171
  ### Continue on error (`breakWhenError: false`)
package/dist/index.cjs CHANGED
@@ -23,7 +23,7 @@ __export(index_exports, {
23
23
  default: () => index_default
24
24
  });
25
25
  module.exports = __toCommonJS(index_exports);
26
- var QPASS_VERSION = true ? "1.2.0" : "0.0.0";
26
+ var QPASS_VERSION = true ? "1.3.0" : "0.0.0";
27
27
  var Qpass = class {
28
28
  version = QPASS_VERSION;
29
29
  // version info
@@ -43,11 +43,18 @@ var Qpass = class {
43
43
  // completed results for current cycle
44
44
  stopProcessing = false;
45
45
  // stop scheduling new jobs when true
46
+ // rolling mode: start a waiting job as soon as ANY running job settles (never more than
47
+ // batchSize at once), instead of waiting for the whole cycle. One job that never settles
48
+ // then holds one slot, not the whole queue.
49
+ rolling = false;
50
+ rollingCompleted = [];
51
+ // rolling mode: results since the last report
46
52
  get batchToProcess() {
47
53
  return Math.ceil(this.items.length / this.batchSize);
48
54
  }
49
55
  constructor(option) {
50
56
  this.breakWhenError = !!option?.breakWhenError;
57
+ this.rolling = !!option?.rolling;
51
58
  this.batchSize = option?.batchSize ?? 1;
52
59
  if (typeof this.batchSize !== "number" || this.batchSize < 1) {
53
60
  throw new Error("batchSize must be at least 1");
@@ -77,6 +84,14 @@ var Qpass = class {
77
84
  this.processNext();
78
85
  return addedIds;
79
86
  }
87
+ // change the number of jobs processed per batch
88
+ setBatchSize(size) {
89
+ if (typeof size !== "number" || size < 1) {
90
+ throw new Error("batchSize must be at least 1");
91
+ }
92
+ this.batchSize = size;
93
+ if (this.rolling) this.fillSlots();
94
+ }
80
95
  // remove a queued job by id
81
96
  remove(id) {
82
97
  const jobId = String(id);
@@ -89,6 +104,10 @@ var Qpass = class {
89
104
  }
90
105
  // process next batch of jobs
91
106
  processNext() {
107
+ if (this.rolling) {
108
+ this.fillSlots();
109
+ return;
110
+ }
92
111
  if (this.stopProcessing || this.items.length === 0 || this.activeCount > 0) {
93
112
  return;
94
113
  }
@@ -105,6 +124,43 @@ var Qpass = class {
105
124
  });
106
125
  });
107
126
  }
127
+ // rolling mode: start waiting jobs until batchSize are running
128
+ fillSlots() {
129
+ while (!this.stopProcessing && this.items.length > 0 && this.activeCount < this.batchSize) {
130
+ const item = this.items.shift();
131
+ this.activeCount += 1;
132
+ Promise.resolve().then(() => item.job()).then((result) => {
133
+ this.finalizeRolling(result, false);
134
+ return result;
135
+ }).catch((err) => {
136
+ this.finalizeRolling(err, true);
137
+ return err;
138
+ });
139
+ }
140
+ }
141
+ // rolling mode: one job settled. Refill first (a throwing onProgress must not stall the
142
+ // queue), then report every batchSize completions and whenever the queue goes idle.
143
+ finalizeRolling(value, isError) {
144
+ this.activeCount -= 1;
145
+ this.rollingCompleted.push(value);
146
+ if (isError && this.breakWhenError) {
147
+ this.stopProcessing = true;
148
+ this.items = [];
149
+ }
150
+ this.fillSlots();
151
+ const idle = this.activeCount === 0 && this.items.length === 0;
152
+ if (this.rollingCompleted.length >= this.batchSize || idle) {
153
+ const completed = this.rollingCompleted;
154
+ this.rollingCompleted = [];
155
+ if (this.onProgress) {
156
+ this.onProgress({
157
+ batchToProcess: this.batchToProcess,
158
+ itemsToProcess: this.items.length,
159
+ completed
160
+ });
161
+ }
162
+ }
163
+ }
108
164
  finalizeJob(index, value, isError) {
109
165
  this.currentCycleCompleted[index] = value;
110
166
  this.activeCount -= 1;
@@ -1 +1 @@
1
- {"version":3,"sources":["../index.ts"],"sourcesContent":["declare const __QPASS_VERSION__: string;\n\nconst QPASS_VERSION =\n typeof __QPASS_VERSION__ === \"string\" ? __QPASS_VERSION__ : \"0.0.0\";\n\nclass Qpass {\n version = QPASS_VERSION; // version info\n\n private items: { id: string; job: () => Promise<any> }[] = []; // job queue\n private nextJobId: number = 1; // auto-generated job id\n private breakWhenError: boolean = false; // whether to stop on error\n private batchSize: number = 1; // number of jobs to process at once\n private onProgress?: (progress: {\n batchToProcess: number; // remaining batch count\n itemsToProcess: number; // remaining job count\n completed: any[]; // completed job results array\n }) => void; // progress callback\n\n private activeCount: number = 0; // number of jobs currently running\n private currentCycleCompleted: any[] = []; // completed results for current cycle\n private stopProcessing: boolean = false; // stop scheduling new jobs when true\n\n private get batchToProcess() {\n // calculate total batch count\n return Math.ceil(this.items.length / this.batchSize);\n }\n\n constructor(option?: {\n breakWhenError?: boolean;\n onProgress?: (progress: {\n batchToProcess: number;\n itemsToProcess: number;\n completed: any[];\n }) => void;\n batchSize?: number; // must be at least 1, default is 1\n }) {\n this.breakWhenError = !!option?.breakWhenError;\n this.batchSize = option?.batchSize ?? 1;\n\n if (typeof this.batchSize !== \"number\" || this.batchSize < 1) {\n throw new Error(\"batchSize must be at least 1\");\n }\n\n if (option?.onProgress) {\n if (typeof option.onProgress === \"function\") {\n this.onProgress = option.onProgress;\n } else {\n throw new Error(\"onProgress must be a function\");\n }\n }\n }\n\n // add jobs to the queue at once. now returns job id.\n add(jobs: (() => Promise<any>)[] | (() => Promise<any>)): string[] {\n // check if jobs is an array, if not convert to array\n const jobsArray = Array.isArray(jobs) ? jobs : [jobs];\n const addedIds: string[] = [];\n\n // check if each job is a function, if so add to queue\n for (const job of jobsArray) {\n if (typeof job !== \"function\") {\n throw new Error(\n \"Each job must be a function that returns a Promise\"\n );\n }\n\n const id = String(this.nextJobId++);\n this.items.push({ id, job });\n addedIds.push(id);\n }\n\n this.processNext();\n return addedIds;\n }\n\n // remove a queued job by id\n remove(id: string | number) {\n const jobId = String(id);\n const index = this.items.findIndex((item) => item.id === jobId);\n\n if (index === -1) {\n return false;\n }\n\n this.items.splice(index, 1);\n return true;\n }\n\n // process next batch of jobs\n private processNext() {\n // exit if queue is empty, processing is stopped, or a cycle is still running\n if (\n this.stopProcessing ||\n this.items.length === 0 ||\n this.activeCount > 0\n ) {\n return;\n }\n\n const jobsToRun = this.items.splice(0, this.batchSize);\n this.activeCount = jobsToRun.length;\n this.currentCycleCompleted = new Array(jobsToRun.length);\n\n jobsToRun.forEach((item, index) => {\n Promise.resolve()\n .then(() => item.job())\n .then((result) => {\n this.finalizeJob(index, result, false);\n return result;\n })\n .catch((err) => {\n this.finalizeJob(index, err, true);\n return err;\n });\n });\n }\n\n private finalizeJob(index: number, value: any, isError: boolean) {\n this.currentCycleCompleted[index] = value;\n this.activeCount -= 1;\n\n if (isError && this.breakWhenError) {\n this.stopProcessing = true;\n this.items = [];\n }\n\n if (this.activeCount !== 0) {\n return;\n }\n\n const completed = this.currentCycleCompleted.slice();\n this.currentCycleCompleted = [];\n\n if (this.onProgress) {\n this.onProgress({\n batchToProcess: this.batchToProcess,\n itemsToProcess: this.items.length,\n completed: completed,\n });\n }\n\n this.processNext();\n }\n\n terminate() {\n // remove all remaining jobs from queue\n this.items = [];\n }\n}\n\nexport default Qpass;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,IAAM,gBACF,OAAwC,UAAoB;AAEhE,IAAM,QAAN,MAAY;AAAA,EACR,UAAU;AAAA;AAAA,EAEF,QAAmD,CAAC;AAAA;AAAA,EACpD,YAAoB;AAAA;AAAA,EACpB,iBAA0B;AAAA;AAAA,EAC1B,YAAoB;AAAA;AAAA,EACpB;AAAA;AAAA,EAMA,cAAsB;AAAA;AAAA,EACtB,wBAA+B,CAAC;AAAA;AAAA,EAChC,iBAA0B;AAAA;AAAA,EAElC,IAAY,iBAAiB;AAEzB,WAAO,KAAK,KAAK,KAAK,MAAM,SAAS,KAAK,SAAS;AAAA,EACvD;AAAA,EAEA,YAAY,QAQT;AACC,SAAK,iBAAiB,CAAC,CAAC,QAAQ;AAChC,SAAK,YAAY,QAAQ,aAAa;AAEtC,QAAI,OAAO,KAAK,cAAc,YAAY,KAAK,YAAY,GAAG;AAC1D,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAClD;AAEA,QAAI,QAAQ,YAAY;AACpB,UAAI,OAAO,OAAO,eAAe,YAAY;AACzC,aAAK,aAAa,OAAO;AAAA,MAC7B,OAAO;AACH,cAAM,IAAI,MAAM,+BAA+B;AAAA,MACnD;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA,EAGA,IAAI,MAA+D;AAE/D,UAAM,YAAY,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACpD,UAAM,WAAqB,CAAC;AAG5B,eAAW,OAAO,WAAW;AACzB,UAAI,OAAO,QAAQ,YAAY;AAC3B,cAAM,IAAI;AAAA,UACN;AAAA,QACJ;AAAA,MACJ;AAEA,YAAM,KAAK,OAAO,KAAK,WAAW;AAClC,WAAK,MAAM,KAAK,EAAE,IAAI,IAAI,CAAC;AAC3B,eAAS,KAAK,EAAE;AAAA,IACpB;AAEA,SAAK,YAAY;AACjB,WAAO;AAAA,EACX;AAAA;AAAA,EAGA,OAAO,IAAqB;AACxB,UAAM,QAAQ,OAAO,EAAE;AACvB,UAAM,QAAQ,KAAK,MAAM,UAAU,CAAC,SAAS,KAAK,OAAO,KAAK;AAE9D,QAAI,UAAU,IAAI;AACd,aAAO;AAAA,IACX;AAEA,SAAK,MAAM,OAAO,OAAO,CAAC;AAC1B,WAAO;AAAA,EACX;AAAA;AAAA,EAGQ,cAAc;AAElB,QACI,KAAK,kBACL,KAAK,MAAM,WAAW,KACtB,KAAK,cAAc,GACrB;AACE;AAAA,IACJ;AAEA,UAAM,YAAY,KAAK,MAAM,OAAO,GAAG,KAAK,SAAS;AACrD,SAAK,cAAc,UAAU;AAC7B,SAAK,wBAAwB,IAAI,MAAM,UAAU,MAAM;AAEvD,cAAU,QAAQ,CAAC,MAAM,UAAU;AAC/B,cAAQ,QAAQ,EACX,KAAK,MAAM,KAAK,IAAI,CAAC,EACrB,KAAK,CAAC,WAAW;AACd,aAAK,YAAY,OAAO,QAAQ,KAAK;AACrC,eAAO;AAAA,MACX,CAAC,EACA,MAAM,CAAC,QAAQ;AACZ,aAAK,YAAY,OAAO,KAAK,IAAI;AACjC,eAAO;AAAA,MACX,CAAC;AAAA,IACT,CAAC;AAAA,EACL;AAAA,EAEQ,YAAY,OAAe,OAAY,SAAkB;AAC7D,SAAK,sBAAsB,KAAK,IAAI;AACpC,SAAK,eAAe;AAEpB,QAAI,WAAW,KAAK,gBAAgB;AAChC,WAAK,iBAAiB;AACtB,WAAK,QAAQ,CAAC;AAAA,IAClB;AAEA,QAAI,KAAK,gBAAgB,GAAG;AACxB;AAAA,IACJ;AAEA,UAAM,YAAY,KAAK,sBAAsB,MAAM;AACnD,SAAK,wBAAwB,CAAC;AAE9B,QAAI,KAAK,YAAY;AACjB,WAAK,WAAW;AAAA,QACZ,gBAAgB,KAAK;AAAA,QACrB,gBAAgB,KAAK,MAAM;AAAA,QAC3B;AAAA,MACJ,CAAC;AAAA,IACL;AAEA,SAAK,YAAY;AAAA,EACrB;AAAA,EAEA,YAAY;AAER,SAAK,QAAQ,CAAC;AAAA,EAClB;AACJ;AAEA,IAAO,gBAAQ;","names":[]}
1
+ {"version":3,"sources":["../index.ts"],"sourcesContent":["declare const __QPASS_VERSION__: string;\n\nconst QPASS_VERSION =\n typeof __QPASS_VERSION__ === \"string\" ? __QPASS_VERSION__ : \"0.0.0\";\n\nclass Qpass {\n version = QPASS_VERSION; // version info\n\n private items: { id: string; job: () => Promise<any> }[] = []; // job queue\n private nextJobId: number = 1; // auto-generated job id\n private breakWhenError: boolean = false; // whether to stop on error\n private batchSize: number = 1; // number of jobs to process at once\n private onProgress?: (progress: {\n batchToProcess: number; // remaining batch count\n itemsToProcess: number; // remaining job count\n completed: any[]; // completed job results array\n }) => void; // progress callback\n\n private activeCount: number = 0; // number of jobs currently running\n private currentCycleCompleted: any[] = []; // completed results for current cycle\n private stopProcessing: boolean = false; // stop scheduling new jobs when true\n // rolling mode: start a waiting job as soon as ANY running job settles (never more than\n // batchSize at once), instead of waiting for the whole cycle. One job that never settles\n // then holds one slot, not the whole queue.\n private rolling: boolean = false;\n private rollingCompleted: any[] = []; // rolling mode: results since the last report\n\n private get batchToProcess() {\n // calculate total batch count\n return Math.ceil(this.items.length / this.batchSize);\n }\n\n constructor(option?: {\n breakWhenError?: boolean;\n onProgress?: (progress: {\n batchToProcess: number;\n itemsToProcess: number;\n completed: any[];\n }) => void;\n batchSize?: number; // must be at least 1, default is 1\n rolling?: boolean; // start the next job whenever any job settles, default false\n }) {\n this.breakWhenError = !!option?.breakWhenError;\n this.rolling = !!option?.rolling;\n this.batchSize = option?.batchSize ?? 1;\n\n if (typeof this.batchSize !== \"number\" || this.batchSize < 1) {\n throw new Error(\"batchSize must be at least 1\");\n }\n\n if (option?.onProgress) {\n if (typeof option.onProgress === \"function\") {\n this.onProgress = option.onProgress;\n } else {\n throw new Error(\"onProgress must be a function\");\n }\n }\n }\n\n // add jobs to the queue at once. now returns job id.\n add(jobs: (() => Promise<any>)[] | (() => Promise<any>)): string[] {\n // check if jobs is an array, if not convert to array\n const jobsArray = Array.isArray(jobs) ? jobs : [jobs];\n const addedIds: string[] = [];\n\n // check if each job is a function, if so add to queue\n for (const job of jobsArray) {\n if (typeof job !== \"function\") {\n throw new Error(\n \"Each job must be a function that returns a Promise\"\n );\n }\n\n const id = String(this.nextJobId++);\n this.items.push({ id, job });\n addedIds.push(id);\n }\n\n this.processNext();\n return addedIds;\n }\n\n // change the number of jobs processed per batch\n setBatchSize(size: number) {\n if (typeof size !== \"number\" || size < 1) {\n throw new Error(\"batchSize must be at least 1\");\n }\n this.batchSize = size;\n // rolling mode: a larger size can start waiting jobs right away\n if (this.rolling) this.fillSlots();\n }\n\n // remove a queued job by id\n remove(id: string | number) {\n const jobId = String(id);\n const index = this.items.findIndex((item) => item.id === jobId);\n\n if (index === -1) {\n return false;\n }\n\n this.items.splice(index, 1);\n return true;\n }\n\n // process next batch of jobs\n private processNext() {\n if (this.rolling) {\n this.fillSlots();\n return;\n }\n // exit if queue is empty, processing is stopped, or a cycle is still running\n if (\n this.stopProcessing ||\n this.items.length === 0 ||\n this.activeCount > 0\n ) {\n return;\n }\n\n const jobsToRun = this.items.splice(0, this.batchSize);\n this.activeCount = jobsToRun.length;\n this.currentCycleCompleted = new Array(jobsToRun.length);\n\n jobsToRun.forEach((item, index) => {\n Promise.resolve()\n .then(() => item.job())\n .then((result) => {\n this.finalizeJob(index, result, false);\n return result;\n })\n .catch((err) => {\n this.finalizeJob(index, err, true);\n return err;\n });\n });\n }\n\n // rolling mode: start waiting jobs until batchSize are running\n private fillSlots() {\n while (\n !this.stopProcessing &&\n this.items.length > 0 &&\n this.activeCount < this.batchSize\n ) {\n const item = this.items.shift()!;\n this.activeCount += 1;\n Promise.resolve()\n .then(() => item.job())\n .then((result) => {\n this.finalizeRolling(result, false);\n return result;\n })\n .catch((err) => {\n this.finalizeRolling(err, true);\n return err;\n });\n }\n }\n\n // rolling mode: one job settled. Refill first (a throwing onProgress must not stall the\n // queue), then report every batchSize completions and whenever the queue goes idle.\n private finalizeRolling(value: any, isError: boolean) {\n this.activeCount -= 1;\n this.rollingCompleted.push(value);\n\n if (isError && this.breakWhenError) {\n this.stopProcessing = true;\n this.items = [];\n }\n\n this.fillSlots();\n\n const idle = this.activeCount === 0 && this.items.length === 0;\n if (this.rollingCompleted.length >= this.batchSize || idle) {\n const completed = this.rollingCompleted;\n this.rollingCompleted = [];\n if (this.onProgress) {\n this.onProgress({\n batchToProcess: this.batchToProcess,\n itemsToProcess: this.items.length,\n completed: completed,\n });\n }\n }\n }\n\n private finalizeJob(index: number, value: any, isError: boolean) {\n this.currentCycleCompleted[index] = value;\n this.activeCount -= 1;\n\n if (isError && this.breakWhenError) {\n this.stopProcessing = true;\n this.items = [];\n }\n\n if (this.activeCount !== 0) {\n return;\n }\n\n const completed = this.currentCycleCompleted.slice();\n this.currentCycleCompleted = [];\n\n if (this.onProgress) {\n this.onProgress({\n batchToProcess: this.batchToProcess,\n itemsToProcess: this.items.length,\n completed: completed,\n });\n }\n\n this.processNext();\n }\n\n terminate() {\n // remove all remaining jobs from queue\n this.items = [];\n }\n}\n\nexport default Qpass;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,IAAM,gBACF,OAAwC,UAAoB;AAEhE,IAAM,QAAN,MAAY;AAAA,EACR,UAAU;AAAA;AAAA,EAEF,QAAmD,CAAC;AAAA;AAAA,EACpD,YAAoB;AAAA;AAAA,EACpB,iBAA0B;AAAA;AAAA,EAC1B,YAAoB;AAAA;AAAA,EACpB;AAAA;AAAA,EAMA,cAAsB;AAAA;AAAA,EACtB,wBAA+B,CAAC;AAAA;AAAA,EAChC,iBAA0B;AAAA;AAAA;AAAA;AAAA;AAAA,EAI1B,UAAmB;AAAA,EACnB,mBAA0B,CAAC;AAAA;AAAA,EAEnC,IAAY,iBAAiB;AAEzB,WAAO,KAAK,KAAK,KAAK,MAAM,SAAS,KAAK,SAAS;AAAA,EACvD;AAAA,EAEA,YAAY,QAST;AACC,SAAK,iBAAiB,CAAC,CAAC,QAAQ;AAChC,SAAK,UAAU,CAAC,CAAC,QAAQ;AACzB,SAAK,YAAY,QAAQ,aAAa;AAEtC,QAAI,OAAO,KAAK,cAAc,YAAY,KAAK,YAAY,GAAG;AAC1D,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAClD;AAEA,QAAI,QAAQ,YAAY;AACpB,UAAI,OAAO,OAAO,eAAe,YAAY;AACzC,aAAK,aAAa,OAAO;AAAA,MAC7B,OAAO;AACH,cAAM,IAAI,MAAM,+BAA+B;AAAA,MACnD;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA,EAGA,IAAI,MAA+D;AAE/D,UAAM,YAAY,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACpD,UAAM,WAAqB,CAAC;AAG5B,eAAW,OAAO,WAAW;AACzB,UAAI,OAAO,QAAQ,YAAY;AAC3B,cAAM,IAAI;AAAA,UACN;AAAA,QACJ;AAAA,MACJ;AAEA,YAAM,KAAK,OAAO,KAAK,WAAW;AAClC,WAAK,MAAM,KAAK,EAAE,IAAI,IAAI,CAAC;AAC3B,eAAS,KAAK,EAAE;AAAA,IACpB;AAEA,SAAK,YAAY;AACjB,WAAO;AAAA,EACX;AAAA;AAAA,EAGA,aAAa,MAAc;AACvB,QAAI,OAAO,SAAS,YAAY,OAAO,GAAG;AACtC,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAClD;AACA,SAAK,YAAY;AAEjB,QAAI,KAAK,QAAS,MAAK,UAAU;AAAA,EACrC;AAAA;AAAA,EAGA,OAAO,IAAqB;AACxB,UAAM,QAAQ,OAAO,EAAE;AACvB,UAAM,QAAQ,KAAK,MAAM,UAAU,CAAC,SAAS,KAAK,OAAO,KAAK;AAE9D,QAAI,UAAU,IAAI;AACd,aAAO;AAAA,IACX;AAEA,SAAK,MAAM,OAAO,OAAO,CAAC;AAC1B,WAAO;AAAA,EACX;AAAA;AAAA,EAGQ,cAAc;AAClB,QAAI,KAAK,SAAS;AACd,WAAK,UAAU;AACf;AAAA,IACJ;AAEA,QACI,KAAK,kBACL,KAAK,MAAM,WAAW,KACtB,KAAK,cAAc,GACrB;AACE;AAAA,IACJ;AAEA,UAAM,YAAY,KAAK,MAAM,OAAO,GAAG,KAAK,SAAS;AACrD,SAAK,cAAc,UAAU;AAC7B,SAAK,wBAAwB,IAAI,MAAM,UAAU,MAAM;AAEvD,cAAU,QAAQ,CAAC,MAAM,UAAU;AAC/B,cAAQ,QAAQ,EACX,KAAK,MAAM,KAAK,IAAI,CAAC,EACrB,KAAK,CAAC,WAAW;AACd,aAAK,YAAY,OAAO,QAAQ,KAAK;AACrC,eAAO;AAAA,MACX,CAAC,EACA,MAAM,CAAC,QAAQ;AACZ,aAAK,YAAY,OAAO,KAAK,IAAI;AACjC,eAAO;AAAA,MACX,CAAC;AAAA,IACT,CAAC;AAAA,EACL;AAAA;AAAA,EAGQ,YAAY;AAChB,WACI,CAAC,KAAK,kBACN,KAAK,MAAM,SAAS,KACpB,KAAK,cAAc,KAAK,WAC1B;AACE,YAAM,OAAO,KAAK,MAAM,MAAM;AAC9B,WAAK,eAAe;AACpB,cAAQ,QAAQ,EACX,KAAK,MAAM,KAAK,IAAI,CAAC,EACrB,KAAK,CAAC,WAAW;AACd,aAAK,gBAAgB,QAAQ,KAAK;AAClC,eAAO;AAAA,MACX,CAAC,EACA,MAAM,CAAC,QAAQ;AACZ,aAAK,gBAAgB,KAAK,IAAI;AAC9B,eAAO;AAAA,MACX,CAAC;AAAA,IACT;AAAA,EACJ;AAAA;AAAA;AAAA,EAIQ,gBAAgB,OAAY,SAAkB;AAClD,SAAK,eAAe;AACpB,SAAK,iBAAiB,KAAK,KAAK;AAEhC,QAAI,WAAW,KAAK,gBAAgB;AAChC,WAAK,iBAAiB;AACtB,WAAK,QAAQ,CAAC;AAAA,IAClB;AAEA,SAAK,UAAU;AAEf,UAAM,OAAO,KAAK,gBAAgB,KAAK,KAAK,MAAM,WAAW;AAC7D,QAAI,KAAK,iBAAiB,UAAU,KAAK,aAAa,MAAM;AACxD,YAAM,YAAY,KAAK;AACvB,WAAK,mBAAmB,CAAC;AACzB,UAAI,KAAK,YAAY;AACjB,aAAK,WAAW;AAAA,UACZ,gBAAgB,KAAK;AAAA,UACrB,gBAAgB,KAAK,MAAM;AAAA,UAC3B;AAAA,QACJ,CAAC;AAAA,MACL;AAAA,IACJ;AAAA,EACJ;AAAA,EAEQ,YAAY,OAAe,OAAY,SAAkB;AAC7D,SAAK,sBAAsB,KAAK,IAAI;AACpC,SAAK,eAAe;AAEpB,QAAI,WAAW,KAAK,gBAAgB;AAChC,WAAK,iBAAiB;AACtB,WAAK,QAAQ,CAAC;AAAA,IAClB;AAEA,QAAI,KAAK,gBAAgB,GAAG;AACxB;AAAA,IACJ;AAEA,UAAM,YAAY,KAAK,sBAAsB,MAAM;AACnD,SAAK,wBAAwB,CAAC;AAE9B,QAAI,KAAK,YAAY;AACjB,WAAK,WAAW;AAAA,QACZ,gBAAgB,KAAK;AAAA,QACrB,gBAAgB,KAAK,MAAM;AAAA,QAC3B;AAAA,MACJ,CAAC;AAAA,IACL;AAEA,SAAK,YAAY;AAAA,EACrB;AAAA,EAEA,YAAY;AAER,SAAK,QAAQ,CAAC;AAAA,EAClB;AACJ;AAEA,IAAO,gBAAQ;","names":[]}
package/dist/index.d.cts CHANGED
@@ -8,6 +8,8 @@ declare class Qpass {
8
8
  private activeCount;
9
9
  private currentCycleCompleted;
10
10
  private stopProcessing;
11
+ private rolling;
12
+ private rollingCompleted;
11
13
  private get batchToProcess();
12
14
  constructor(option?: {
13
15
  breakWhenError?: boolean;
@@ -17,10 +19,14 @@ declare class Qpass {
17
19
  completed: any[];
18
20
  }) => void;
19
21
  batchSize?: number;
22
+ rolling?: boolean;
20
23
  });
21
24
  add(jobs: (() => Promise<any>)[] | (() => Promise<any>)): string[];
25
+ setBatchSize(size: number): void;
22
26
  remove(id: string | number): boolean;
23
27
  private processNext;
28
+ private fillSlots;
29
+ private finalizeRolling;
24
30
  private finalizeJob;
25
31
  terminate(): void;
26
32
  }
package/dist/index.d.ts CHANGED
@@ -8,6 +8,8 @@ declare class Qpass {
8
8
  private activeCount;
9
9
  private currentCycleCompleted;
10
10
  private stopProcessing;
11
+ private rolling;
12
+ private rollingCompleted;
11
13
  private get batchToProcess();
12
14
  constructor(option?: {
13
15
  breakWhenError?: boolean;
@@ -17,10 +19,14 @@ declare class Qpass {
17
19
  completed: any[];
18
20
  }) => void;
19
21
  batchSize?: number;
22
+ rolling?: boolean;
20
23
  });
21
24
  add(jobs: (() => Promise<any>)[] | (() => Promise<any>)): string[];
25
+ setBatchSize(size: number): void;
22
26
  remove(id: string | number): boolean;
23
27
  private processNext;
28
+ private fillSlots;
29
+ private finalizeRolling;
24
30
  private finalizeJob;
25
31
  terminate(): void;
26
32
  }
package/dist/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  // index.ts
2
- var QPASS_VERSION = true ? "1.2.0" : "0.0.0";
2
+ var QPASS_VERSION = true ? "1.3.0" : "0.0.0";
3
3
  var Qpass = class {
4
4
  version = QPASS_VERSION;
5
5
  // version info
@@ -19,11 +19,18 @@ var Qpass = class {
19
19
  // completed results for current cycle
20
20
  stopProcessing = false;
21
21
  // stop scheduling new jobs when true
22
+ // rolling mode: start a waiting job as soon as ANY running job settles (never more than
23
+ // batchSize at once), instead of waiting for the whole cycle. One job that never settles
24
+ // then holds one slot, not the whole queue.
25
+ rolling = false;
26
+ rollingCompleted = [];
27
+ // rolling mode: results since the last report
22
28
  get batchToProcess() {
23
29
  return Math.ceil(this.items.length / this.batchSize);
24
30
  }
25
31
  constructor(option) {
26
32
  this.breakWhenError = !!option?.breakWhenError;
33
+ this.rolling = !!option?.rolling;
27
34
  this.batchSize = option?.batchSize ?? 1;
28
35
  if (typeof this.batchSize !== "number" || this.batchSize < 1) {
29
36
  throw new Error("batchSize must be at least 1");
@@ -53,6 +60,14 @@ var Qpass = class {
53
60
  this.processNext();
54
61
  return addedIds;
55
62
  }
63
+ // change the number of jobs processed per batch
64
+ setBatchSize(size) {
65
+ if (typeof size !== "number" || size < 1) {
66
+ throw new Error("batchSize must be at least 1");
67
+ }
68
+ this.batchSize = size;
69
+ if (this.rolling) this.fillSlots();
70
+ }
56
71
  // remove a queued job by id
57
72
  remove(id) {
58
73
  const jobId = String(id);
@@ -65,6 +80,10 @@ var Qpass = class {
65
80
  }
66
81
  // process next batch of jobs
67
82
  processNext() {
83
+ if (this.rolling) {
84
+ this.fillSlots();
85
+ return;
86
+ }
68
87
  if (this.stopProcessing || this.items.length === 0 || this.activeCount > 0) {
69
88
  return;
70
89
  }
@@ -81,6 +100,43 @@ var Qpass = class {
81
100
  });
82
101
  });
83
102
  }
103
+ // rolling mode: start waiting jobs until batchSize are running
104
+ fillSlots() {
105
+ while (!this.stopProcessing && this.items.length > 0 && this.activeCount < this.batchSize) {
106
+ const item = this.items.shift();
107
+ this.activeCount += 1;
108
+ Promise.resolve().then(() => item.job()).then((result) => {
109
+ this.finalizeRolling(result, false);
110
+ return result;
111
+ }).catch((err) => {
112
+ this.finalizeRolling(err, true);
113
+ return err;
114
+ });
115
+ }
116
+ }
117
+ // rolling mode: one job settled. Refill first (a throwing onProgress must not stall the
118
+ // queue), then report every batchSize completions and whenever the queue goes idle.
119
+ finalizeRolling(value, isError) {
120
+ this.activeCount -= 1;
121
+ this.rollingCompleted.push(value);
122
+ if (isError && this.breakWhenError) {
123
+ this.stopProcessing = true;
124
+ this.items = [];
125
+ }
126
+ this.fillSlots();
127
+ const idle = this.activeCount === 0 && this.items.length === 0;
128
+ if (this.rollingCompleted.length >= this.batchSize || idle) {
129
+ const completed = this.rollingCompleted;
130
+ this.rollingCompleted = [];
131
+ if (this.onProgress) {
132
+ this.onProgress({
133
+ batchToProcess: this.batchToProcess,
134
+ itemsToProcess: this.items.length,
135
+ completed
136
+ });
137
+ }
138
+ }
139
+ }
84
140
  finalizeJob(index, value, isError) {
85
141
  this.currentCycleCompleted[index] = value;
86
142
  this.activeCount -= 1;
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../index.ts"],"sourcesContent":["declare const __QPASS_VERSION__: string;\n\nconst QPASS_VERSION =\n typeof __QPASS_VERSION__ === \"string\" ? __QPASS_VERSION__ : \"0.0.0\";\n\nclass Qpass {\n version = QPASS_VERSION; // version info\n\n private items: { id: string; job: () => Promise<any> }[] = []; // job queue\n private nextJobId: number = 1; // auto-generated job id\n private breakWhenError: boolean = false; // whether to stop on error\n private batchSize: number = 1; // number of jobs to process at once\n private onProgress?: (progress: {\n batchToProcess: number; // remaining batch count\n itemsToProcess: number; // remaining job count\n completed: any[]; // completed job results array\n }) => void; // progress callback\n\n private activeCount: number = 0; // number of jobs currently running\n private currentCycleCompleted: any[] = []; // completed results for current cycle\n private stopProcessing: boolean = false; // stop scheduling new jobs when true\n\n private get batchToProcess() {\n // calculate total batch count\n return Math.ceil(this.items.length / this.batchSize);\n }\n\n constructor(option?: {\n breakWhenError?: boolean;\n onProgress?: (progress: {\n batchToProcess: number;\n itemsToProcess: number;\n completed: any[];\n }) => void;\n batchSize?: number; // must be at least 1, default is 1\n }) {\n this.breakWhenError = !!option?.breakWhenError;\n this.batchSize = option?.batchSize ?? 1;\n\n if (typeof this.batchSize !== \"number\" || this.batchSize < 1) {\n throw new Error(\"batchSize must be at least 1\");\n }\n\n if (option?.onProgress) {\n if (typeof option.onProgress === \"function\") {\n this.onProgress = option.onProgress;\n } else {\n throw new Error(\"onProgress must be a function\");\n }\n }\n }\n\n // add jobs to the queue at once. now returns job id.\n add(jobs: (() => Promise<any>)[] | (() => Promise<any>)): string[] {\n // check if jobs is an array, if not convert to array\n const jobsArray = Array.isArray(jobs) ? jobs : [jobs];\n const addedIds: string[] = [];\n\n // check if each job is a function, if so add to queue\n for (const job of jobsArray) {\n if (typeof job !== \"function\") {\n throw new Error(\n \"Each job must be a function that returns a Promise\"\n );\n }\n\n const id = String(this.nextJobId++);\n this.items.push({ id, job });\n addedIds.push(id);\n }\n\n this.processNext();\n return addedIds;\n }\n\n // remove a queued job by id\n remove(id: string | number) {\n const jobId = String(id);\n const index = this.items.findIndex((item) => item.id === jobId);\n\n if (index === -1) {\n return false;\n }\n\n this.items.splice(index, 1);\n return true;\n }\n\n // process next batch of jobs\n private processNext() {\n // exit if queue is empty, processing is stopped, or a cycle is still running\n if (\n this.stopProcessing ||\n this.items.length === 0 ||\n this.activeCount > 0\n ) {\n return;\n }\n\n const jobsToRun = this.items.splice(0, this.batchSize);\n this.activeCount = jobsToRun.length;\n this.currentCycleCompleted = new Array(jobsToRun.length);\n\n jobsToRun.forEach((item, index) => {\n Promise.resolve()\n .then(() => item.job())\n .then((result) => {\n this.finalizeJob(index, result, false);\n return result;\n })\n .catch((err) => {\n this.finalizeJob(index, err, true);\n return err;\n });\n });\n }\n\n private finalizeJob(index: number, value: any, isError: boolean) {\n this.currentCycleCompleted[index] = value;\n this.activeCount -= 1;\n\n if (isError && this.breakWhenError) {\n this.stopProcessing = true;\n this.items = [];\n }\n\n if (this.activeCount !== 0) {\n return;\n }\n\n const completed = this.currentCycleCompleted.slice();\n this.currentCycleCompleted = [];\n\n if (this.onProgress) {\n this.onProgress({\n batchToProcess: this.batchToProcess,\n itemsToProcess: this.items.length,\n completed: completed,\n });\n }\n\n this.processNext();\n }\n\n terminate() {\n // remove all remaining jobs from queue\n this.items = [];\n }\n}\n\nexport default Qpass;\n"],"mappings":";AAEA,IAAM,gBACF,OAAwC,UAAoB;AAEhE,IAAM,QAAN,MAAY;AAAA,EACR,UAAU;AAAA;AAAA,EAEF,QAAmD,CAAC;AAAA;AAAA,EACpD,YAAoB;AAAA;AAAA,EACpB,iBAA0B;AAAA;AAAA,EAC1B,YAAoB;AAAA;AAAA,EACpB;AAAA;AAAA,EAMA,cAAsB;AAAA;AAAA,EACtB,wBAA+B,CAAC;AAAA;AAAA,EAChC,iBAA0B;AAAA;AAAA,EAElC,IAAY,iBAAiB;AAEzB,WAAO,KAAK,KAAK,KAAK,MAAM,SAAS,KAAK,SAAS;AAAA,EACvD;AAAA,EAEA,YAAY,QAQT;AACC,SAAK,iBAAiB,CAAC,CAAC,QAAQ;AAChC,SAAK,YAAY,QAAQ,aAAa;AAEtC,QAAI,OAAO,KAAK,cAAc,YAAY,KAAK,YAAY,GAAG;AAC1D,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAClD;AAEA,QAAI,QAAQ,YAAY;AACpB,UAAI,OAAO,OAAO,eAAe,YAAY;AACzC,aAAK,aAAa,OAAO;AAAA,MAC7B,OAAO;AACH,cAAM,IAAI,MAAM,+BAA+B;AAAA,MACnD;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA,EAGA,IAAI,MAA+D;AAE/D,UAAM,YAAY,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACpD,UAAM,WAAqB,CAAC;AAG5B,eAAW,OAAO,WAAW;AACzB,UAAI,OAAO,QAAQ,YAAY;AAC3B,cAAM,IAAI;AAAA,UACN;AAAA,QACJ;AAAA,MACJ;AAEA,YAAM,KAAK,OAAO,KAAK,WAAW;AAClC,WAAK,MAAM,KAAK,EAAE,IAAI,IAAI,CAAC;AAC3B,eAAS,KAAK,EAAE;AAAA,IACpB;AAEA,SAAK,YAAY;AACjB,WAAO;AAAA,EACX;AAAA;AAAA,EAGA,OAAO,IAAqB;AACxB,UAAM,QAAQ,OAAO,EAAE;AACvB,UAAM,QAAQ,KAAK,MAAM,UAAU,CAAC,SAAS,KAAK,OAAO,KAAK;AAE9D,QAAI,UAAU,IAAI;AACd,aAAO;AAAA,IACX;AAEA,SAAK,MAAM,OAAO,OAAO,CAAC;AAC1B,WAAO;AAAA,EACX;AAAA;AAAA,EAGQ,cAAc;AAElB,QACI,KAAK,kBACL,KAAK,MAAM,WAAW,KACtB,KAAK,cAAc,GACrB;AACE;AAAA,IACJ;AAEA,UAAM,YAAY,KAAK,MAAM,OAAO,GAAG,KAAK,SAAS;AACrD,SAAK,cAAc,UAAU;AAC7B,SAAK,wBAAwB,IAAI,MAAM,UAAU,MAAM;AAEvD,cAAU,QAAQ,CAAC,MAAM,UAAU;AAC/B,cAAQ,QAAQ,EACX,KAAK,MAAM,KAAK,IAAI,CAAC,EACrB,KAAK,CAAC,WAAW;AACd,aAAK,YAAY,OAAO,QAAQ,KAAK;AACrC,eAAO;AAAA,MACX,CAAC,EACA,MAAM,CAAC,QAAQ;AACZ,aAAK,YAAY,OAAO,KAAK,IAAI;AACjC,eAAO;AAAA,MACX,CAAC;AAAA,IACT,CAAC;AAAA,EACL;AAAA,EAEQ,YAAY,OAAe,OAAY,SAAkB;AAC7D,SAAK,sBAAsB,KAAK,IAAI;AACpC,SAAK,eAAe;AAEpB,QAAI,WAAW,KAAK,gBAAgB;AAChC,WAAK,iBAAiB;AACtB,WAAK,QAAQ,CAAC;AAAA,IAClB;AAEA,QAAI,KAAK,gBAAgB,GAAG;AACxB;AAAA,IACJ;AAEA,UAAM,YAAY,KAAK,sBAAsB,MAAM;AACnD,SAAK,wBAAwB,CAAC;AAE9B,QAAI,KAAK,YAAY;AACjB,WAAK,WAAW;AAAA,QACZ,gBAAgB,KAAK;AAAA,QACrB,gBAAgB,KAAK,MAAM;AAAA,QAC3B;AAAA,MACJ,CAAC;AAAA,IACL;AAEA,SAAK,YAAY;AAAA,EACrB;AAAA,EAEA,YAAY;AAER,SAAK,QAAQ,CAAC;AAAA,EAClB;AACJ;AAEA,IAAO,gBAAQ;","names":[]}
1
+ {"version":3,"sources":["../index.ts"],"sourcesContent":["declare const __QPASS_VERSION__: string;\n\nconst QPASS_VERSION =\n typeof __QPASS_VERSION__ === \"string\" ? __QPASS_VERSION__ : \"0.0.0\";\n\nclass Qpass {\n version = QPASS_VERSION; // version info\n\n private items: { id: string; job: () => Promise<any> }[] = []; // job queue\n private nextJobId: number = 1; // auto-generated job id\n private breakWhenError: boolean = false; // whether to stop on error\n private batchSize: number = 1; // number of jobs to process at once\n private onProgress?: (progress: {\n batchToProcess: number; // remaining batch count\n itemsToProcess: number; // remaining job count\n completed: any[]; // completed job results array\n }) => void; // progress callback\n\n private activeCount: number = 0; // number of jobs currently running\n private currentCycleCompleted: any[] = []; // completed results for current cycle\n private stopProcessing: boolean = false; // stop scheduling new jobs when true\n // rolling mode: start a waiting job as soon as ANY running job settles (never more than\n // batchSize at once), instead of waiting for the whole cycle. One job that never settles\n // then holds one slot, not the whole queue.\n private rolling: boolean = false;\n private rollingCompleted: any[] = []; // rolling mode: results since the last report\n\n private get batchToProcess() {\n // calculate total batch count\n return Math.ceil(this.items.length / this.batchSize);\n }\n\n constructor(option?: {\n breakWhenError?: boolean;\n onProgress?: (progress: {\n batchToProcess: number;\n itemsToProcess: number;\n completed: any[];\n }) => void;\n batchSize?: number; // must be at least 1, default is 1\n rolling?: boolean; // start the next job whenever any job settles, default false\n }) {\n this.breakWhenError = !!option?.breakWhenError;\n this.rolling = !!option?.rolling;\n this.batchSize = option?.batchSize ?? 1;\n\n if (typeof this.batchSize !== \"number\" || this.batchSize < 1) {\n throw new Error(\"batchSize must be at least 1\");\n }\n\n if (option?.onProgress) {\n if (typeof option.onProgress === \"function\") {\n this.onProgress = option.onProgress;\n } else {\n throw new Error(\"onProgress must be a function\");\n }\n }\n }\n\n // add jobs to the queue at once. now returns job id.\n add(jobs: (() => Promise<any>)[] | (() => Promise<any>)): string[] {\n // check if jobs is an array, if not convert to array\n const jobsArray = Array.isArray(jobs) ? jobs : [jobs];\n const addedIds: string[] = [];\n\n // check if each job is a function, if so add to queue\n for (const job of jobsArray) {\n if (typeof job !== \"function\") {\n throw new Error(\n \"Each job must be a function that returns a Promise\"\n );\n }\n\n const id = String(this.nextJobId++);\n this.items.push({ id, job });\n addedIds.push(id);\n }\n\n this.processNext();\n return addedIds;\n }\n\n // change the number of jobs processed per batch\n setBatchSize(size: number) {\n if (typeof size !== \"number\" || size < 1) {\n throw new Error(\"batchSize must be at least 1\");\n }\n this.batchSize = size;\n // rolling mode: a larger size can start waiting jobs right away\n if (this.rolling) this.fillSlots();\n }\n\n // remove a queued job by id\n remove(id: string | number) {\n const jobId = String(id);\n const index = this.items.findIndex((item) => item.id === jobId);\n\n if (index === -1) {\n return false;\n }\n\n this.items.splice(index, 1);\n return true;\n }\n\n // process next batch of jobs\n private processNext() {\n if (this.rolling) {\n this.fillSlots();\n return;\n }\n // exit if queue is empty, processing is stopped, or a cycle is still running\n if (\n this.stopProcessing ||\n this.items.length === 0 ||\n this.activeCount > 0\n ) {\n return;\n }\n\n const jobsToRun = this.items.splice(0, this.batchSize);\n this.activeCount = jobsToRun.length;\n this.currentCycleCompleted = new Array(jobsToRun.length);\n\n jobsToRun.forEach((item, index) => {\n Promise.resolve()\n .then(() => item.job())\n .then((result) => {\n this.finalizeJob(index, result, false);\n return result;\n })\n .catch((err) => {\n this.finalizeJob(index, err, true);\n return err;\n });\n });\n }\n\n // rolling mode: start waiting jobs until batchSize are running\n private fillSlots() {\n while (\n !this.stopProcessing &&\n this.items.length > 0 &&\n this.activeCount < this.batchSize\n ) {\n const item = this.items.shift()!;\n this.activeCount += 1;\n Promise.resolve()\n .then(() => item.job())\n .then((result) => {\n this.finalizeRolling(result, false);\n return result;\n })\n .catch((err) => {\n this.finalizeRolling(err, true);\n return err;\n });\n }\n }\n\n // rolling mode: one job settled. Refill first (a throwing onProgress must not stall the\n // queue), then report every batchSize completions and whenever the queue goes idle.\n private finalizeRolling(value: any, isError: boolean) {\n this.activeCount -= 1;\n this.rollingCompleted.push(value);\n\n if (isError && this.breakWhenError) {\n this.stopProcessing = true;\n this.items = [];\n }\n\n this.fillSlots();\n\n const idle = this.activeCount === 0 && this.items.length === 0;\n if (this.rollingCompleted.length >= this.batchSize || idle) {\n const completed = this.rollingCompleted;\n this.rollingCompleted = [];\n if (this.onProgress) {\n this.onProgress({\n batchToProcess: this.batchToProcess,\n itemsToProcess: this.items.length,\n completed: completed,\n });\n }\n }\n }\n\n private finalizeJob(index: number, value: any, isError: boolean) {\n this.currentCycleCompleted[index] = value;\n this.activeCount -= 1;\n\n if (isError && this.breakWhenError) {\n this.stopProcessing = true;\n this.items = [];\n }\n\n if (this.activeCount !== 0) {\n return;\n }\n\n const completed = this.currentCycleCompleted.slice();\n this.currentCycleCompleted = [];\n\n if (this.onProgress) {\n this.onProgress({\n batchToProcess: this.batchToProcess,\n itemsToProcess: this.items.length,\n completed: completed,\n });\n }\n\n this.processNext();\n }\n\n terminate() {\n // remove all remaining jobs from queue\n this.items = [];\n }\n}\n\nexport default Qpass;\n"],"mappings":";AAEA,IAAM,gBACF,OAAwC,UAAoB;AAEhE,IAAM,QAAN,MAAY;AAAA,EACR,UAAU;AAAA;AAAA,EAEF,QAAmD,CAAC;AAAA;AAAA,EACpD,YAAoB;AAAA;AAAA,EACpB,iBAA0B;AAAA;AAAA,EAC1B,YAAoB;AAAA;AAAA,EACpB;AAAA;AAAA,EAMA,cAAsB;AAAA;AAAA,EACtB,wBAA+B,CAAC;AAAA;AAAA,EAChC,iBAA0B;AAAA;AAAA;AAAA;AAAA;AAAA,EAI1B,UAAmB;AAAA,EACnB,mBAA0B,CAAC;AAAA;AAAA,EAEnC,IAAY,iBAAiB;AAEzB,WAAO,KAAK,KAAK,KAAK,MAAM,SAAS,KAAK,SAAS;AAAA,EACvD;AAAA,EAEA,YAAY,QAST;AACC,SAAK,iBAAiB,CAAC,CAAC,QAAQ;AAChC,SAAK,UAAU,CAAC,CAAC,QAAQ;AACzB,SAAK,YAAY,QAAQ,aAAa;AAEtC,QAAI,OAAO,KAAK,cAAc,YAAY,KAAK,YAAY,GAAG;AAC1D,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAClD;AAEA,QAAI,QAAQ,YAAY;AACpB,UAAI,OAAO,OAAO,eAAe,YAAY;AACzC,aAAK,aAAa,OAAO;AAAA,MAC7B,OAAO;AACH,cAAM,IAAI,MAAM,+BAA+B;AAAA,MACnD;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA,EAGA,IAAI,MAA+D;AAE/D,UAAM,YAAY,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACpD,UAAM,WAAqB,CAAC;AAG5B,eAAW,OAAO,WAAW;AACzB,UAAI,OAAO,QAAQ,YAAY;AAC3B,cAAM,IAAI;AAAA,UACN;AAAA,QACJ;AAAA,MACJ;AAEA,YAAM,KAAK,OAAO,KAAK,WAAW;AAClC,WAAK,MAAM,KAAK,EAAE,IAAI,IAAI,CAAC;AAC3B,eAAS,KAAK,EAAE;AAAA,IACpB;AAEA,SAAK,YAAY;AACjB,WAAO;AAAA,EACX;AAAA;AAAA,EAGA,aAAa,MAAc;AACvB,QAAI,OAAO,SAAS,YAAY,OAAO,GAAG;AACtC,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAClD;AACA,SAAK,YAAY;AAEjB,QAAI,KAAK,QAAS,MAAK,UAAU;AAAA,EACrC;AAAA;AAAA,EAGA,OAAO,IAAqB;AACxB,UAAM,QAAQ,OAAO,EAAE;AACvB,UAAM,QAAQ,KAAK,MAAM,UAAU,CAAC,SAAS,KAAK,OAAO,KAAK;AAE9D,QAAI,UAAU,IAAI;AACd,aAAO;AAAA,IACX;AAEA,SAAK,MAAM,OAAO,OAAO,CAAC;AAC1B,WAAO;AAAA,EACX;AAAA;AAAA,EAGQ,cAAc;AAClB,QAAI,KAAK,SAAS;AACd,WAAK,UAAU;AACf;AAAA,IACJ;AAEA,QACI,KAAK,kBACL,KAAK,MAAM,WAAW,KACtB,KAAK,cAAc,GACrB;AACE;AAAA,IACJ;AAEA,UAAM,YAAY,KAAK,MAAM,OAAO,GAAG,KAAK,SAAS;AACrD,SAAK,cAAc,UAAU;AAC7B,SAAK,wBAAwB,IAAI,MAAM,UAAU,MAAM;AAEvD,cAAU,QAAQ,CAAC,MAAM,UAAU;AAC/B,cAAQ,QAAQ,EACX,KAAK,MAAM,KAAK,IAAI,CAAC,EACrB,KAAK,CAAC,WAAW;AACd,aAAK,YAAY,OAAO,QAAQ,KAAK;AACrC,eAAO;AAAA,MACX,CAAC,EACA,MAAM,CAAC,QAAQ;AACZ,aAAK,YAAY,OAAO,KAAK,IAAI;AACjC,eAAO;AAAA,MACX,CAAC;AAAA,IACT,CAAC;AAAA,EACL;AAAA;AAAA,EAGQ,YAAY;AAChB,WACI,CAAC,KAAK,kBACN,KAAK,MAAM,SAAS,KACpB,KAAK,cAAc,KAAK,WAC1B;AACE,YAAM,OAAO,KAAK,MAAM,MAAM;AAC9B,WAAK,eAAe;AACpB,cAAQ,QAAQ,EACX,KAAK,MAAM,KAAK,IAAI,CAAC,EACrB,KAAK,CAAC,WAAW;AACd,aAAK,gBAAgB,QAAQ,KAAK;AAClC,eAAO;AAAA,MACX,CAAC,EACA,MAAM,CAAC,QAAQ;AACZ,aAAK,gBAAgB,KAAK,IAAI;AAC9B,eAAO;AAAA,MACX,CAAC;AAAA,IACT;AAAA,EACJ;AAAA;AAAA;AAAA,EAIQ,gBAAgB,OAAY,SAAkB;AAClD,SAAK,eAAe;AACpB,SAAK,iBAAiB,KAAK,KAAK;AAEhC,QAAI,WAAW,KAAK,gBAAgB;AAChC,WAAK,iBAAiB;AACtB,WAAK,QAAQ,CAAC;AAAA,IAClB;AAEA,SAAK,UAAU;AAEf,UAAM,OAAO,KAAK,gBAAgB,KAAK,KAAK,MAAM,WAAW;AAC7D,QAAI,KAAK,iBAAiB,UAAU,KAAK,aAAa,MAAM;AACxD,YAAM,YAAY,KAAK;AACvB,WAAK,mBAAmB,CAAC;AACzB,UAAI,KAAK,YAAY;AACjB,aAAK,WAAW;AAAA,UACZ,gBAAgB,KAAK;AAAA,UACrB,gBAAgB,KAAK,MAAM;AAAA,UAC3B;AAAA,QACJ,CAAC;AAAA,MACL;AAAA,IACJ;AAAA,EACJ;AAAA,EAEQ,YAAY,OAAe,OAAY,SAAkB;AAC7D,SAAK,sBAAsB,KAAK,IAAI;AACpC,SAAK,eAAe;AAEpB,QAAI,WAAW,KAAK,gBAAgB;AAChC,WAAK,iBAAiB;AACtB,WAAK,QAAQ,CAAC;AAAA,IAClB;AAEA,QAAI,KAAK,gBAAgB,GAAG;AACxB;AAAA,IACJ;AAEA,UAAM,YAAY,KAAK,sBAAsB,MAAM;AACnD,SAAK,wBAAwB,CAAC;AAE9B,QAAI,KAAK,YAAY;AACjB,WAAK,WAAW;AAAA,QACZ,gBAAgB,KAAK;AAAA,QACrB,gBAAgB,KAAK,MAAM;AAAA,QAC3B;AAAA,MACJ,CAAC;AAAA,IACL;AAEA,SAAK,YAAY;AAAA,EACrB;AAAA,EAEA,YAAY;AAER,SAAK,QAAQ,CAAC;AAAA,EAClB;AACJ;AAEA,IAAO,gBAAQ;","names":[]}
package/dist/qpass.js CHANGED
@@ -23,7 +23,7 @@ var Qpass = (() => {
23
23
  __export(index_exports, {
24
24
  default: () => index_default
25
25
  });
26
- var QPASS_VERSION = true ? "1.2.0" : "0.0.0";
26
+ var QPASS_VERSION = true ? "1.3.0" : "0.0.0";
27
27
  var Qpass = class {
28
28
  version = QPASS_VERSION;
29
29
  // version info
@@ -43,11 +43,18 @@ var Qpass = (() => {
43
43
  // completed results for current cycle
44
44
  stopProcessing = false;
45
45
  // stop scheduling new jobs when true
46
+ // rolling mode: start a waiting job as soon as ANY running job settles (never more than
47
+ // batchSize at once), instead of waiting for the whole cycle. One job that never settles
48
+ // then holds one slot, not the whole queue.
49
+ rolling = false;
50
+ rollingCompleted = [];
51
+ // rolling mode: results since the last report
46
52
  get batchToProcess() {
47
53
  return Math.ceil(this.items.length / this.batchSize);
48
54
  }
49
55
  constructor(option) {
50
56
  this.breakWhenError = !!option?.breakWhenError;
57
+ this.rolling = !!option?.rolling;
51
58
  this.batchSize = option?.batchSize ?? 1;
52
59
  if (typeof this.batchSize !== "number" || this.batchSize < 1) {
53
60
  throw new Error("batchSize must be at least 1");
@@ -77,6 +84,14 @@ var Qpass = (() => {
77
84
  this.processNext();
78
85
  return addedIds;
79
86
  }
87
+ // change the number of jobs processed per batch
88
+ setBatchSize(size) {
89
+ if (typeof size !== "number" || size < 1) {
90
+ throw new Error("batchSize must be at least 1");
91
+ }
92
+ this.batchSize = size;
93
+ if (this.rolling) this.fillSlots();
94
+ }
80
95
  // remove a queued job by id
81
96
  remove(id) {
82
97
  const jobId = String(id);
@@ -89,6 +104,10 @@ var Qpass = (() => {
89
104
  }
90
105
  // process next batch of jobs
91
106
  processNext() {
107
+ if (this.rolling) {
108
+ this.fillSlots();
109
+ return;
110
+ }
92
111
  if (this.stopProcessing || this.items.length === 0 || this.activeCount > 0) {
93
112
  return;
94
113
  }
@@ -105,6 +124,43 @@ var Qpass = (() => {
105
124
  });
106
125
  });
107
126
  }
127
+ // rolling mode: start waiting jobs until batchSize are running
128
+ fillSlots() {
129
+ while (!this.stopProcessing && this.items.length > 0 && this.activeCount < this.batchSize) {
130
+ const item = this.items.shift();
131
+ this.activeCount += 1;
132
+ Promise.resolve().then(() => item.job()).then((result) => {
133
+ this.finalizeRolling(result, false);
134
+ return result;
135
+ }).catch((err) => {
136
+ this.finalizeRolling(err, true);
137
+ return err;
138
+ });
139
+ }
140
+ }
141
+ // rolling mode: one job settled. Refill first (a throwing onProgress must not stall the
142
+ // queue), then report every batchSize completions and whenever the queue goes idle.
143
+ finalizeRolling(value, isError) {
144
+ this.activeCount -= 1;
145
+ this.rollingCompleted.push(value);
146
+ if (isError && this.breakWhenError) {
147
+ this.stopProcessing = true;
148
+ this.items = [];
149
+ }
150
+ this.fillSlots();
151
+ const idle = this.activeCount === 0 && this.items.length === 0;
152
+ if (this.rollingCompleted.length >= this.batchSize || idle) {
153
+ const completed = this.rollingCompleted;
154
+ this.rollingCompleted = [];
155
+ if (this.onProgress) {
156
+ this.onProgress({
157
+ batchToProcess: this.batchToProcess,
158
+ itemsToProcess: this.items.length,
159
+ completed
160
+ });
161
+ }
162
+ }
163
+ }
108
164
  finalizeJob(index, value, isError) {
109
165
  this.currentCycleCompleted[index] = value;
110
166
  this.activeCount -= 1;
package/dist/qpass.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../index.ts"],"sourcesContent":["declare const __QPASS_VERSION__: string;\n\nconst QPASS_VERSION =\n typeof __QPASS_VERSION__ === \"string\" ? __QPASS_VERSION__ : \"0.0.0\";\n\nclass Qpass {\n version = QPASS_VERSION; // version info\n\n private items: { id: string; job: () => Promise<any> }[] = []; // job queue\n private nextJobId: number = 1; // auto-generated job id\n private breakWhenError: boolean = false; // whether to stop on error\n private batchSize: number = 1; // number of jobs to process at once\n private onProgress?: (progress: {\n batchToProcess: number; // remaining batch count\n itemsToProcess: number; // remaining job count\n completed: any[]; // completed job results array\n }) => void; // progress callback\n\n private activeCount: number = 0; // number of jobs currently running\n private currentCycleCompleted: any[] = []; // completed results for current cycle\n private stopProcessing: boolean = false; // stop scheduling new jobs when true\n\n private get batchToProcess() {\n // calculate total batch count\n return Math.ceil(this.items.length / this.batchSize);\n }\n\n constructor(option?: {\n breakWhenError?: boolean;\n onProgress?: (progress: {\n batchToProcess: number;\n itemsToProcess: number;\n completed: any[];\n }) => void;\n batchSize?: number; // must be at least 1, default is 1\n }) {\n this.breakWhenError = !!option?.breakWhenError;\n this.batchSize = option?.batchSize ?? 1;\n\n if (typeof this.batchSize !== \"number\" || this.batchSize < 1) {\n throw new Error(\"batchSize must be at least 1\");\n }\n\n if (option?.onProgress) {\n if (typeof option.onProgress === \"function\") {\n this.onProgress = option.onProgress;\n } else {\n throw new Error(\"onProgress must be a function\");\n }\n }\n }\n\n // add jobs to the queue at once. now returns job id.\n add(jobs: (() => Promise<any>)[] | (() => Promise<any>)): string[] {\n // check if jobs is an array, if not convert to array\n const jobsArray = Array.isArray(jobs) ? jobs : [jobs];\n const addedIds: string[] = [];\n\n // check if each job is a function, if so add to queue\n for (const job of jobsArray) {\n if (typeof job !== \"function\") {\n throw new Error(\n \"Each job must be a function that returns a Promise\"\n );\n }\n\n const id = String(this.nextJobId++);\n this.items.push({ id, job });\n addedIds.push(id);\n }\n\n this.processNext();\n return addedIds;\n }\n\n // remove a queued job by id\n remove(id: string | number) {\n const jobId = String(id);\n const index = this.items.findIndex((item) => item.id === jobId);\n\n if (index === -1) {\n return false;\n }\n\n this.items.splice(index, 1);\n return true;\n }\n\n // process next batch of jobs\n private processNext() {\n // exit if queue is empty, processing is stopped, or a cycle is still running\n if (\n this.stopProcessing ||\n this.items.length === 0 ||\n this.activeCount > 0\n ) {\n return;\n }\n\n const jobsToRun = this.items.splice(0, this.batchSize);\n this.activeCount = jobsToRun.length;\n this.currentCycleCompleted = new Array(jobsToRun.length);\n\n jobsToRun.forEach((item, index) => {\n Promise.resolve()\n .then(() => item.job())\n .then((result) => {\n this.finalizeJob(index, result, false);\n return result;\n })\n .catch((err) => {\n this.finalizeJob(index, err, true);\n return err;\n });\n });\n }\n\n private finalizeJob(index: number, value: any, isError: boolean) {\n this.currentCycleCompleted[index] = value;\n this.activeCount -= 1;\n\n if (isError && this.breakWhenError) {\n this.stopProcessing = true;\n this.items = [];\n }\n\n if (this.activeCount !== 0) {\n return;\n }\n\n const completed = this.currentCycleCompleted.slice();\n this.currentCycleCompleted = [];\n\n if (this.onProgress) {\n this.onProgress({\n batchToProcess: this.batchToProcess,\n itemsToProcess: this.items.length,\n completed: completed,\n });\n }\n\n this.processNext();\n }\n\n terminate() {\n // remove all remaining jobs from queue\n this.items = [];\n }\n}\n\nexport default Qpass;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAEA,MAAM,gBACF,OAAwC,UAAoB;AAEhE,MAAM,QAAN,MAAY;AAAA,IACR,UAAU;AAAA;AAAA,IAEF,QAAmD,CAAC;AAAA;AAAA,IACpD,YAAoB;AAAA;AAAA,IACpB,iBAA0B;AAAA;AAAA,IAC1B,YAAoB;AAAA;AAAA,IACpB;AAAA;AAAA,IAMA,cAAsB;AAAA;AAAA,IACtB,wBAA+B,CAAC;AAAA;AAAA,IAChC,iBAA0B;AAAA;AAAA,IAElC,IAAY,iBAAiB;AAEzB,aAAO,KAAK,KAAK,KAAK,MAAM,SAAS,KAAK,SAAS;AAAA,IACvD;AAAA,IAEA,YAAY,QAQT;AACC,WAAK,iBAAiB,CAAC,CAAC,QAAQ;AAChC,WAAK,YAAY,QAAQ,aAAa;AAEtC,UAAI,OAAO,KAAK,cAAc,YAAY,KAAK,YAAY,GAAG;AAC1D,cAAM,IAAI,MAAM,8BAA8B;AAAA,MAClD;AAEA,UAAI,QAAQ,YAAY;AACpB,YAAI,OAAO,OAAO,eAAe,YAAY;AACzC,eAAK,aAAa,OAAO;AAAA,QAC7B,OAAO;AACH,gBAAM,IAAI,MAAM,+BAA+B;AAAA,QACnD;AAAA,MACJ;AAAA,IACJ;AAAA;AAAA,IAGA,IAAI,MAA+D;AAE/D,YAAM,YAAY,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACpD,YAAM,WAAqB,CAAC;AAG5B,iBAAW,OAAO,WAAW;AACzB,YAAI,OAAO,QAAQ,YAAY;AAC3B,gBAAM,IAAI;AAAA,YACN;AAAA,UACJ;AAAA,QACJ;AAEA,cAAM,KAAK,OAAO,KAAK,WAAW;AAClC,aAAK,MAAM,KAAK,EAAE,IAAI,IAAI,CAAC;AAC3B,iBAAS,KAAK,EAAE;AAAA,MACpB;AAEA,WAAK,YAAY;AACjB,aAAO;AAAA,IACX;AAAA;AAAA,IAGA,OAAO,IAAqB;AACxB,YAAM,QAAQ,OAAO,EAAE;AACvB,YAAM,QAAQ,KAAK,MAAM,UAAU,CAAC,SAAS,KAAK,OAAO,KAAK;AAE9D,UAAI,UAAU,IAAI;AACd,eAAO;AAAA,MACX;AAEA,WAAK,MAAM,OAAO,OAAO,CAAC;AAC1B,aAAO;AAAA,IACX;AAAA;AAAA,IAGQ,cAAc;AAElB,UACI,KAAK,kBACL,KAAK,MAAM,WAAW,KACtB,KAAK,cAAc,GACrB;AACE;AAAA,MACJ;AAEA,YAAM,YAAY,KAAK,MAAM,OAAO,GAAG,KAAK,SAAS;AACrD,WAAK,cAAc,UAAU;AAC7B,WAAK,wBAAwB,IAAI,MAAM,UAAU,MAAM;AAEvD,gBAAU,QAAQ,CAAC,MAAM,UAAU;AAC/B,gBAAQ,QAAQ,EACX,KAAK,MAAM,KAAK,IAAI,CAAC,EACrB,KAAK,CAAC,WAAW;AACd,eAAK,YAAY,OAAO,QAAQ,KAAK;AACrC,iBAAO;AAAA,QACX,CAAC,EACA,MAAM,CAAC,QAAQ;AACZ,eAAK,YAAY,OAAO,KAAK,IAAI;AACjC,iBAAO;AAAA,QACX,CAAC;AAAA,MACT,CAAC;AAAA,IACL;AAAA,IAEQ,YAAY,OAAe,OAAY,SAAkB;AAC7D,WAAK,sBAAsB,KAAK,IAAI;AACpC,WAAK,eAAe;AAEpB,UAAI,WAAW,KAAK,gBAAgB;AAChC,aAAK,iBAAiB;AACtB,aAAK,QAAQ,CAAC;AAAA,MAClB;AAEA,UAAI,KAAK,gBAAgB,GAAG;AACxB;AAAA,MACJ;AAEA,YAAM,YAAY,KAAK,sBAAsB,MAAM;AACnD,WAAK,wBAAwB,CAAC;AAE9B,UAAI,KAAK,YAAY;AACjB,aAAK,WAAW;AAAA,UACZ,gBAAgB,KAAK;AAAA,UACrB,gBAAgB,KAAK,MAAM;AAAA,UAC3B;AAAA,QACJ,CAAC;AAAA,MACL;AAEA,WAAK,YAAY;AAAA,IACrB;AAAA,IAEA,YAAY;AAER,WAAK,QAAQ,CAAC;AAAA,IAClB;AAAA,EACJ;AAEA,MAAO,gBAAQ;","names":[]}
1
+ {"version":3,"sources":["../index.ts"],"sourcesContent":["declare const __QPASS_VERSION__: string;\n\nconst QPASS_VERSION =\n typeof __QPASS_VERSION__ === \"string\" ? __QPASS_VERSION__ : \"0.0.0\";\n\nclass Qpass {\n version = QPASS_VERSION; // version info\n\n private items: { id: string; job: () => Promise<any> }[] = []; // job queue\n private nextJobId: number = 1; // auto-generated job id\n private breakWhenError: boolean = false; // whether to stop on error\n private batchSize: number = 1; // number of jobs to process at once\n private onProgress?: (progress: {\n batchToProcess: number; // remaining batch count\n itemsToProcess: number; // remaining job count\n completed: any[]; // completed job results array\n }) => void; // progress callback\n\n private activeCount: number = 0; // number of jobs currently running\n private currentCycleCompleted: any[] = []; // completed results for current cycle\n private stopProcessing: boolean = false; // stop scheduling new jobs when true\n // rolling mode: start a waiting job as soon as ANY running job settles (never more than\n // batchSize at once), instead of waiting for the whole cycle. One job that never settles\n // then holds one slot, not the whole queue.\n private rolling: boolean = false;\n private rollingCompleted: any[] = []; // rolling mode: results since the last report\n\n private get batchToProcess() {\n // calculate total batch count\n return Math.ceil(this.items.length / this.batchSize);\n }\n\n constructor(option?: {\n breakWhenError?: boolean;\n onProgress?: (progress: {\n batchToProcess: number;\n itemsToProcess: number;\n completed: any[];\n }) => void;\n batchSize?: number; // must be at least 1, default is 1\n rolling?: boolean; // start the next job whenever any job settles, default false\n }) {\n this.breakWhenError = !!option?.breakWhenError;\n this.rolling = !!option?.rolling;\n this.batchSize = option?.batchSize ?? 1;\n\n if (typeof this.batchSize !== \"number\" || this.batchSize < 1) {\n throw new Error(\"batchSize must be at least 1\");\n }\n\n if (option?.onProgress) {\n if (typeof option.onProgress === \"function\") {\n this.onProgress = option.onProgress;\n } else {\n throw new Error(\"onProgress must be a function\");\n }\n }\n }\n\n // add jobs to the queue at once. now returns job id.\n add(jobs: (() => Promise<any>)[] | (() => Promise<any>)): string[] {\n // check if jobs is an array, if not convert to array\n const jobsArray = Array.isArray(jobs) ? jobs : [jobs];\n const addedIds: string[] = [];\n\n // check if each job is a function, if so add to queue\n for (const job of jobsArray) {\n if (typeof job !== \"function\") {\n throw new Error(\n \"Each job must be a function that returns a Promise\"\n );\n }\n\n const id = String(this.nextJobId++);\n this.items.push({ id, job });\n addedIds.push(id);\n }\n\n this.processNext();\n return addedIds;\n }\n\n // change the number of jobs processed per batch\n setBatchSize(size: number) {\n if (typeof size !== \"number\" || size < 1) {\n throw new Error(\"batchSize must be at least 1\");\n }\n this.batchSize = size;\n // rolling mode: a larger size can start waiting jobs right away\n if (this.rolling) this.fillSlots();\n }\n\n // remove a queued job by id\n remove(id: string | number) {\n const jobId = String(id);\n const index = this.items.findIndex((item) => item.id === jobId);\n\n if (index === -1) {\n return false;\n }\n\n this.items.splice(index, 1);\n return true;\n }\n\n // process next batch of jobs\n private processNext() {\n if (this.rolling) {\n this.fillSlots();\n return;\n }\n // exit if queue is empty, processing is stopped, or a cycle is still running\n if (\n this.stopProcessing ||\n this.items.length === 0 ||\n this.activeCount > 0\n ) {\n return;\n }\n\n const jobsToRun = this.items.splice(0, this.batchSize);\n this.activeCount = jobsToRun.length;\n this.currentCycleCompleted = new Array(jobsToRun.length);\n\n jobsToRun.forEach((item, index) => {\n Promise.resolve()\n .then(() => item.job())\n .then((result) => {\n this.finalizeJob(index, result, false);\n return result;\n })\n .catch((err) => {\n this.finalizeJob(index, err, true);\n return err;\n });\n });\n }\n\n // rolling mode: start waiting jobs until batchSize are running\n private fillSlots() {\n while (\n !this.stopProcessing &&\n this.items.length > 0 &&\n this.activeCount < this.batchSize\n ) {\n const item = this.items.shift()!;\n this.activeCount += 1;\n Promise.resolve()\n .then(() => item.job())\n .then((result) => {\n this.finalizeRolling(result, false);\n return result;\n })\n .catch((err) => {\n this.finalizeRolling(err, true);\n return err;\n });\n }\n }\n\n // rolling mode: one job settled. Refill first (a throwing onProgress must not stall the\n // queue), then report every batchSize completions and whenever the queue goes idle.\n private finalizeRolling(value: any, isError: boolean) {\n this.activeCount -= 1;\n this.rollingCompleted.push(value);\n\n if (isError && this.breakWhenError) {\n this.stopProcessing = true;\n this.items = [];\n }\n\n this.fillSlots();\n\n const idle = this.activeCount === 0 && this.items.length === 0;\n if (this.rollingCompleted.length >= this.batchSize || idle) {\n const completed = this.rollingCompleted;\n this.rollingCompleted = [];\n if (this.onProgress) {\n this.onProgress({\n batchToProcess: this.batchToProcess,\n itemsToProcess: this.items.length,\n completed: completed,\n });\n }\n }\n }\n\n private finalizeJob(index: number, value: any, isError: boolean) {\n this.currentCycleCompleted[index] = value;\n this.activeCount -= 1;\n\n if (isError && this.breakWhenError) {\n this.stopProcessing = true;\n this.items = [];\n }\n\n if (this.activeCount !== 0) {\n return;\n }\n\n const completed = this.currentCycleCompleted.slice();\n this.currentCycleCompleted = [];\n\n if (this.onProgress) {\n this.onProgress({\n batchToProcess: this.batchToProcess,\n itemsToProcess: this.items.length,\n completed: completed,\n });\n }\n\n this.processNext();\n }\n\n terminate() {\n // remove all remaining jobs from queue\n this.items = [];\n }\n}\n\nexport default Qpass;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAEA,MAAM,gBACF,OAAwC,UAAoB;AAEhE,MAAM,QAAN,MAAY;AAAA,IACR,UAAU;AAAA;AAAA,IAEF,QAAmD,CAAC;AAAA;AAAA,IACpD,YAAoB;AAAA;AAAA,IACpB,iBAA0B;AAAA;AAAA,IAC1B,YAAoB;AAAA;AAAA,IACpB;AAAA;AAAA,IAMA,cAAsB;AAAA;AAAA,IACtB,wBAA+B,CAAC;AAAA;AAAA,IAChC,iBAA0B;AAAA;AAAA;AAAA;AAAA;AAAA,IAI1B,UAAmB;AAAA,IACnB,mBAA0B,CAAC;AAAA;AAAA,IAEnC,IAAY,iBAAiB;AAEzB,aAAO,KAAK,KAAK,KAAK,MAAM,SAAS,KAAK,SAAS;AAAA,IACvD;AAAA,IAEA,YAAY,QAST;AACC,WAAK,iBAAiB,CAAC,CAAC,QAAQ;AAChC,WAAK,UAAU,CAAC,CAAC,QAAQ;AACzB,WAAK,YAAY,QAAQ,aAAa;AAEtC,UAAI,OAAO,KAAK,cAAc,YAAY,KAAK,YAAY,GAAG;AAC1D,cAAM,IAAI,MAAM,8BAA8B;AAAA,MAClD;AAEA,UAAI,QAAQ,YAAY;AACpB,YAAI,OAAO,OAAO,eAAe,YAAY;AACzC,eAAK,aAAa,OAAO;AAAA,QAC7B,OAAO;AACH,gBAAM,IAAI,MAAM,+BAA+B;AAAA,QACnD;AAAA,MACJ;AAAA,IACJ;AAAA;AAAA,IAGA,IAAI,MAA+D;AAE/D,YAAM,YAAY,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI;AACpD,YAAM,WAAqB,CAAC;AAG5B,iBAAW,OAAO,WAAW;AACzB,YAAI,OAAO,QAAQ,YAAY;AAC3B,gBAAM,IAAI;AAAA,YACN;AAAA,UACJ;AAAA,QACJ;AAEA,cAAM,KAAK,OAAO,KAAK,WAAW;AAClC,aAAK,MAAM,KAAK,EAAE,IAAI,IAAI,CAAC;AAC3B,iBAAS,KAAK,EAAE;AAAA,MACpB;AAEA,WAAK,YAAY;AACjB,aAAO;AAAA,IACX;AAAA;AAAA,IAGA,aAAa,MAAc;AACvB,UAAI,OAAO,SAAS,YAAY,OAAO,GAAG;AACtC,cAAM,IAAI,MAAM,8BAA8B;AAAA,MAClD;AACA,WAAK,YAAY;AAEjB,UAAI,KAAK,QAAS,MAAK,UAAU;AAAA,IACrC;AAAA;AAAA,IAGA,OAAO,IAAqB;AACxB,YAAM,QAAQ,OAAO,EAAE;AACvB,YAAM,QAAQ,KAAK,MAAM,UAAU,CAAC,SAAS,KAAK,OAAO,KAAK;AAE9D,UAAI,UAAU,IAAI;AACd,eAAO;AAAA,MACX;AAEA,WAAK,MAAM,OAAO,OAAO,CAAC;AAC1B,aAAO;AAAA,IACX;AAAA;AAAA,IAGQ,cAAc;AAClB,UAAI,KAAK,SAAS;AACd,aAAK,UAAU;AACf;AAAA,MACJ;AAEA,UACI,KAAK,kBACL,KAAK,MAAM,WAAW,KACtB,KAAK,cAAc,GACrB;AACE;AAAA,MACJ;AAEA,YAAM,YAAY,KAAK,MAAM,OAAO,GAAG,KAAK,SAAS;AACrD,WAAK,cAAc,UAAU;AAC7B,WAAK,wBAAwB,IAAI,MAAM,UAAU,MAAM;AAEvD,gBAAU,QAAQ,CAAC,MAAM,UAAU;AAC/B,gBAAQ,QAAQ,EACX,KAAK,MAAM,KAAK,IAAI,CAAC,EACrB,KAAK,CAAC,WAAW;AACd,eAAK,YAAY,OAAO,QAAQ,KAAK;AACrC,iBAAO;AAAA,QACX,CAAC,EACA,MAAM,CAAC,QAAQ;AACZ,eAAK,YAAY,OAAO,KAAK,IAAI;AACjC,iBAAO;AAAA,QACX,CAAC;AAAA,MACT,CAAC;AAAA,IACL;AAAA;AAAA,IAGQ,YAAY;AAChB,aACI,CAAC,KAAK,kBACN,KAAK,MAAM,SAAS,KACpB,KAAK,cAAc,KAAK,WAC1B;AACE,cAAM,OAAO,KAAK,MAAM,MAAM;AAC9B,aAAK,eAAe;AACpB,gBAAQ,QAAQ,EACX,KAAK,MAAM,KAAK,IAAI,CAAC,EACrB,KAAK,CAAC,WAAW;AACd,eAAK,gBAAgB,QAAQ,KAAK;AAClC,iBAAO;AAAA,QACX,CAAC,EACA,MAAM,CAAC,QAAQ;AACZ,eAAK,gBAAgB,KAAK,IAAI;AAC9B,iBAAO;AAAA,QACX,CAAC;AAAA,MACT;AAAA,IACJ;AAAA;AAAA;AAAA,IAIQ,gBAAgB,OAAY,SAAkB;AAClD,WAAK,eAAe;AACpB,WAAK,iBAAiB,KAAK,KAAK;AAEhC,UAAI,WAAW,KAAK,gBAAgB;AAChC,aAAK,iBAAiB;AACtB,aAAK,QAAQ,CAAC;AAAA,MAClB;AAEA,WAAK,UAAU;AAEf,YAAM,OAAO,KAAK,gBAAgB,KAAK,KAAK,MAAM,WAAW;AAC7D,UAAI,KAAK,iBAAiB,UAAU,KAAK,aAAa,MAAM;AACxD,cAAM,YAAY,KAAK;AACvB,aAAK,mBAAmB,CAAC;AACzB,YAAI,KAAK,YAAY;AACjB,eAAK,WAAW;AAAA,YACZ,gBAAgB,KAAK;AAAA,YACrB,gBAAgB,KAAK,MAAM;AAAA,YAC3B;AAAA,UACJ,CAAC;AAAA,QACL;AAAA,MACJ;AAAA,IACJ;AAAA,IAEQ,YAAY,OAAe,OAAY,SAAkB;AAC7D,WAAK,sBAAsB,KAAK,IAAI;AACpC,WAAK,eAAe;AAEpB,UAAI,WAAW,KAAK,gBAAgB;AAChC,aAAK,iBAAiB;AACtB,aAAK,QAAQ,CAAC;AAAA,MAClB;AAEA,UAAI,KAAK,gBAAgB,GAAG;AACxB;AAAA,MACJ;AAEA,YAAM,YAAY,KAAK,sBAAsB,MAAM;AACnD,WAAK,wBAAwB,CAAC;AAE9B,UAAI,KAAK,YAAY;AACjB,aAAK,WAAW;AAAA,UACZ,gBAAgB,KAAK;AAAA,UACrB,gBAAgB,KAAK,MAAM;AAAA,UAC3B;AAAA,QACJ,CAAC;AAAA,MACL;AAEA,WAAK,YAAY;AAAA,IACrB;AAAA,IAEA,YAAY;AAER,WAAK,QAAQ,CAAC;AAAA,IAClB;AAAA,EACJ;AAEA,MAAO,gBAAQ;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "qpass",
3
- "version": "1.2.0",
3
+ "version": "1.3.0",
4
4
  "description": "Asynchronous function handler with adjustable concurrency",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.js",