iterall

What is iterall?

The iterall package provides utilities for creating and manipulating JavaScript iterables and iterators. It allows for easy handling of synchronous iteration patterns, which are part of the ECMAScript 2015 (ES6) specification. The package includes functions to check for iterable objects, create custom iterators, and iterate over collections in a manner that is compatible with both ES6 and legacy JavaScript environments.

What are iterall's main functionalities?

isIterable

Checks if an object is an iterable. This is useful for determining if you can use a `for...of` loop or other iteration mechanisms on an object.

const { isIterable } = require('iterall');

const array = [1, 2, 3];
const isItIterable = isIterable(array); // true

isIterator

Determines if an object is an iterator. This can be used to check if an object conforms to the iterator protocol before attempting to iterate over its values.

const { isIterator } = require('iterall');

const iterator = array[Symbol.iterator]();
const isItIterator = isIterator(iterator); // true

createIterator

Creates an iterator from an iterable object. This function allows you to manually control the iteration process, calling `next()` to get values one at a time.

const { createIterator } = require('iterall');

const array = [1, 2, 3];
const iterator = createIterator(array);
iterator.next(); // { value: 1, done: false }

forEach

Iterates over each value in an iterable, calling a provided function on every element. This is similar to `Array.prototype.forEach` but works with any iterable object.

const { forEach } = require('iterall');

forEach(array, (value) => console.log(value)); // logs 1, 2, 3

getIterator

Retrieves an iterator from an iterable object. This is a convenience function that handles the presence of the `Symbol.iterator` method on the object.

const { getIterator } = require('iterall');

const iterator = getIterator(array);
iterator.next(); // { value: 1, done: false }

getIteratorMethod

Gets the iterator method of an iterable object. This can be used to access the default iterator of an object without directly invoking it.

const { getIteratorMethod } = require('iterall');

const method = getIteratorMethod(array);
const iterator = method.call(array);
iterator.next(); // { value: 1, done: false }

Other packages similar to iterall

lodash

Lodash is a comprehensive utility library that provides a wide range of functions for manipulating arrays, objects, and collections. It includes its own set of iteration methods, such as `_.forEach`, `_.map`, and `_.filter`, which can be used with arrays and objects. While lodash does not focus solely on iterators and iterables, it offers similar iteration capabilities with a broader utility scope.

immutable

Immutable.js offers persistent immutable data structures which are highly optimized using structural sharing. It provides its own iteration methods for its data structures, which can be used in a similar way to iterall's iteration functions. However, Immutable.js is more focused on providing immutable collections rather than just iteration tools.

ramda

Ramda is a functional programming library that emphasizes a purer functional style. It includes a variety of iteration functions like `R.forEach`, `R.map`, and `R.filter` that work with arrays and other data types. Ramda's approach is more functional and compositional compared to iterall's straightforward iteration utilities.

README

The README file is missing