@supercharge/collections

Collections

async/await-ready array & collection utilities for Node.js

Installation · Docs · Usage

Follow @marcuspoehls and @superchargejs for updates!

---

Installation

npm i @supercharge/collections

Docs

Find all the details and available methods in the extensive Supercharge docs.

Usage

The package exports a function accepting an array as a parameter. From there, you can chain all collection methods.

The package is async/await-ready and supports async functions for most of the methods.

const User = require('models/user')
const Collect = require('@supercharge/collections')

const users = await Collect(
    await User.all()
  )
  .filter(async user => {
    return user.notSubscribedToNewsletter()
  })
  .map(async user => {
    await user.subscribeToNewsletter()

    return user
  })

// users = [ <list of newly-subscribed users> ]

You can directly await the result for methods returning a definite value. The function returns a new instance of the collection without altering the original input array:

await Collect([ 1, 2, 3 ])
  .map(item => item * 100)
  .reduce((carry, item) => {
    return carry + item
  }, 0)

// result: 600

Contributing

Do you miss a collection function? We very much appreciate your contribution! Please send in a pull request 😊

1. Create a fork
2. Create your feature branch: git checkout -b my-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request 🚀

License

MIT © Supercharge

---

superchargejs.com  ·  GitHub @supercharge  ·  Twitter @superchargejs

Changelog

2.0.0 - 2020-05-21

Added

• TypeScript typings
• collection pipelines are now awaitable: no need to call .all() to retrieve the result
  • before: await Collect([1, 2, 3]).map(...).filter().all()
  • now: await Collect([1, 2, 3]).map(...).filter()

Updated

• bump dependencies
• moved code base to TypeScript to automatically generate type definitions

Breaking Changes

• all xSeries methods become the default and were removed
  • for example: mapSeries becomes map and the mapSeries method was removed
  • the methods running async functions in parallel were removed in favor of the sequence versions
  • I found myself defaulting to the xSeries methods because I typically don’t want to handle the side-effects of parallel processing on a large collections. That’s why the methods iterating over the items in sequence are the new default.

Note: there are no new xParallel methods to fill the gap for the missing methods processing async tasks in parallel. If you need the parallel methods, I’m happy to support you on a pull request.