Comparing version 0.4.3 to 0.4.4
{ | ||
"name": "qyu", | ||
"version": "0.4.3", | ||
"version": "0.4.4", | ||
"description": "A general-purpose asynchronous job queue for Node.js", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
@@ -53,3 +53,3 @@ # Qyu | ||
##### instance(`fn`[, `options`[, `...args`]]) | ||
#### instance(`fn`[, `options`[, `...args`]]) | ||
*(alias: instance#add)* | ||
@@ -83,3 +83,3 @@ Queues function `fn` on instance with optional `options` and `args`. | ||
##### instance(`iterator`, `mapperFn`[, `options`]) | ||
#### instance(`iterator`, `mapperFn`[, `options`]) | ||
*(alias: instance#map)* | ||
@@ -97,3 +97,3 @@ For each iteration of `iterator`, queues `mapperFn` on instance, injected with the value and the index from that iteration. | ||
##### instance#whenEmpty() | ||
#### instance#whenEmpty() | ||
**Returns**: a promise that resolves if/when an instance has no running or queued jobs. | ||
@@ -107,3 +107,3 @@ Guaranteed to resolve, regardless if one or some jobs resulted in error. | ||
##### instance#whenFree() | ||
#### instance#whenFree() | ||
**Returns**: a promise that resolves if/when number of currently running jobs are below the concurrency limit. | ||
@@ -117,3 +117,3 @@ Guaranteed to resolve, regardless if one or some jobs resulted in error. | ||
##### instance#pause() | ||
#### instance#pause() | ||
Pauses instance's operation, so it effectively stops picking more jobs from queue. | ||
@@ -130,3 +130,3 @@ Jobs currently running at time `instance.pause()` was called keep running until finished. | ||
##### instance#resume() | ||
#### instance#resume() | ||
Resumes instance's operation after a previous call to `instance.pause()`. | ||
@@ -142,3 +142,3 @@ An instance is in "resumed" mode by default when instantiated. | ||
##### instance#empty() | ||
#### instance#empty() | ||
Immediately empties the instance's entire queue from all queued jobs. | ||
@@ -145,0 +145,0 @@ Jobs currently running at the time `instance.empty()` was called keep running until finished. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
24938