aboutsummaryrefslogtreecommitdiff
path: root/node_modules/throat/index.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/throat/index.d.ts')
-rw-r--r--node_modules/throat/index.d.ts32
1 files changed, 32 insertions, 0 deletions
diff --git a/node_modules/throat/index.d.ts b/node_modules/throat/index.d.ts
new file mode 100644
index 0000000..038ca51
--- /dev/null
+++ b/node_modules/throat/index.d.ts
@@ -0,0 +1,32 @@
+/**
+ * Throttle the given function to only run `size` times in parallel.
+ * Extra calls will be queued until one of the earlier calls completes.
+ */
+declare function throat<TResult, TArgs extends any[]>(
+ size: number,
+ fn: (...args: TArgs) => Promise<TResult>
+): (...args: TArgs) => Promise<TResult>;
+
+/**
+ * Throttle the given function to only run `size` times in parallel.
+ * Extra calls will be queued until one of the earlier calls completes.
+ */
+declare function throat<TResult, TArgs extends any[]>(
+ fn: (...args: TArgs) => Promise<TResult>,
+ size: number
+): (...args: TArgs) => Promise<TResult>;
+
+/**
+ * Create a throttle that only allows `size` calls in parallel.
+ * Extra calls will be queued until one of the earlier calls completes.
+ *
+ * To create an exclusive lock, just use a `size` of `1`.
+ */
+declare function throat(
+ size: number
+): <TResult, TArgs extends any[] = []>(
+ fn: (...args: TArgs) => Promise<TResult>,
+ ...args: TArgs
+) => Promise<TResult>;
+export default throat;
+