index.d.ts 1.0 KB

1234567891011121314151617181920212223242526272829
  1. export interface Limit {
  2. /**
  3. @param fn - Promise-returning/async function.
  4. @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.
  5. @returns The promise returned by calling `fn(...arguments)`.
  6. */
  7. <Arguments extends unknown[], ReturnType>(
  8. fn: (...arguments: Arguments) => PromiseLike<ReturnType> | ReturnType,
  9. ...arguments: Arguments
  10. ): Promise<ReturnType>;
  11. /**
  12. The number of promises that are currently running.
  13. */
  14. readonly activeCount: number;
  15. /**
  16. The number of promises that are waiting to run (i.e. their internal `fn` was not called yet).
  17. */
  18. readonly pendingCount: number;
  19. }
  20. /**
  21. Run multiple promise-returning & async functions with limited concurrency.
  22. @param concurrency - Concurrency limit. Minimum: `1`.
  23. @returns A `limit` function.
  24. */
  25. export default function pLimit(concurrency: number): Limit;