Feature: guarantee order of results

[AlbertoMontalesi]

Feature: guarantee order of results

[jpike88]

@rxaviers Ive been using the lib the entire time under the impression that order is preserved. Naive for me to do so, but it's an easy mistake to make. Are you interested in making a preserveOrder flag for how things work out, if so do you have a suggestion for how you feel that's best done?

[rxaviers]

A note for everyone that's already using v1: you don't need to migrate to v2 if you don't need to, because the v1 branch is likely to be maintained too.

The v2 API is different than the v1 API (as the major bump implies).

• v2 provides finer control: thanks to async iteration, it lets each result be returned as soon as it completes
• it's possible to get a v1 API (from the v2 lib) by using the wrapper found on https://github.com/rxaviers/async-pool#migrating-from-1x --- though it needs an update, thank you @AlbertoMontalesi [1]

1: I believe the function below would work. Do you want to test it and let us know? It would also be helpful to update README.md with either it or a better one? Thanks

async function asyncPoolAll(concurrency, iterable, iteratorFn) {
  const results = [];
  const iterableWithIndex = Object.entries({ ...iterable });
  for await (const [i, result] of asyncPool(concurrency, iterableWithIndex, iteratorFn)) {
    result[i] = result;
  }
  return results;
}

[rxaviers]

I'm closing per last comment. We can reopen if there's an action required. Thanks