aboutsummaryrefslogtreecommitdiff
path: root/node_modules/throat/index.d.ts
blob: 038ca51838af8e4c1e709097bf0e3dc7fb5fef03 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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;