aboutsummaryrefslogtreecommitdiff
path: root/node_modules/p-limit/index.d.ts
diff options
context:
space:
mode:
authorJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
committerJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
commit5d309ff52cd399a6b71968a6b9a70c8ac0b98981 (patch)
tree360f7eb50f956e2367ef38fa1fc6ac7ac5258042 /node_modules/p-limit/index.d.ts
parentb500a50f1b97d93c98b36ed9a980f8188d648147 (diff)
downloadLYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.tar.gz
LYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.zip
Added node_modules for the updating to work properly.
Diffstat (limited to 'node_modules/p-limit/index.d.ts')
-rw-r--r--node_modules/p-limit/index.d.ts38
1 files changed, 38 insertions, 0 deletions
diff --git a/node_modules/p-limit/index.d.ts b/node_modules/p-limit/index.d.ts
new file mode 100644
index 0000000..6bbfad4
--- /dev/null
+++ b/node_modules/p-limit/index.d.ts
@@ -0,0 +1,38 @@
+export interface Limit {
+ /**
+ @param fn - Promise-returning/async function.
+ @param arguments - Any arguments to pass through to `fn`. Support for passing arguments on to the `fn` is provided in order to be able to avoid creating unnecessary closures. You probably don't need this optimization unless you're pushing a lot of functions.
+ @returns The promise returned by calling `fn(...arguments)`.
+ */
+ <Arguments extends unknown[], ReturnType>(
+ fn: (...arguments: Arguments) => PromiseLike<ReturnType> | ReturnType,
+ ...arguments: Arguments
+ ): Promise<ReturnType>;
+
+ /**
+ The number of promises that are currently running.
+ */
+ readonly activeCount: number;
+
+ /**
+ The number of promises that are waiting to run (i.e. their internal `fn` was not called yet).
+ */
+ readonly pendingCount: number;
+
+ /**
+ Discard pending promises that are waiting to run.
+
+ This might be useful if you want to teardown the queue at the end of your program's lifecycle or discard any function calls referencing an intermediary state of your app.
+
+ Note: This does not cancel promises that are already running.
+ */
+ clearQueue(): void;
+}
+
+/**
+Run multiple promise-returning & async functions with limited concurrency.
+
+@param concurrency - Concurrency limit. Minimum: `1`.
+@returns A `limit` function.
+*/
+export default function pLimit(concurrency: number): Limit;