@supercharge/arrays

Arrays

Array utilities for JavaScript and Node.js

Installation · Docs · Usage

Follow @marcuspoehls and @superchargejs for updates!

---

Introduction

The @supercharge/arrays package provides chainable array utilities for Node.js and JavaScript. It’s a wrapper around JavaScript arrays providing useful methods like .isEmpty(), .size(), .flatMap(), .contains(), and many more.

Installation

npm i @supercharge/arrays

Docs

Find all the details for @supercharge/arrays in the extensive Supercharge docs.

Usage

Using @supercharge/arrays is pretty straightforward. The package exports a function wrapping an array or individual items as an argument. You can then fluently chain methods interacting with your data:

const { Arr } = require('@supercharge/arrays')

const hasItemsGreaterTen = Arr([1, 2, 3, 4, 5, 6])
  .map(value => value * 2) // [2, 4, 6, 8, 10, 12]
  .filter(value => value > 10) // [12]
  .isNotEmpty() // true


// Only methods, no properties
Arr([1, 2, 3]).length() // 3


// Supports callbacks for `.includes`:
Arr([1, 2, 3]).includes(value => {
  return value > 2
})

Every method in the chain returns a @supercharge/array instance. This way, you can chain further methods without leaving the fluent interface. Call .all() to retrieve the plain JavaScript array.

Contributing

Do you miss a 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

1.1.0 - 2022-01-10

Added

• at(index) method: returns the item at the given index or undefined if the index exceeds the array
• find(predicate): returns the first item in the array matching the given predicate function, or undefined if no such item was found
• findIndex(predicate): returns the index of the first element in the set where the given predicate function is true. Returns -1 otherwise
• last(predicate?): returns the last array item when called without a predicate function. If you provide a predicate function this method is an alias for findLast
• findLast(predicate): returns the last item in the set matching the given predicate function