sindresorhus / magic-iterable

Call a method on all items in an iterable by calling it on the iterable itself

magic-iterable

Call a method on all items in an iterable by calling it on the iterable itself

Uses the Proxy API.

Install

$ npm install magic-iterable

Usage

import magicIterable from 'magic-iterable';

const x = {
	index: 0,
	increment(value) {
		this.index += value;
		return this.index;
	}
};

const array = [x, x, x, x];
const magicArray = magicIterable(array);

Array.isArray(magicArray);
//=> true

magicArray.increment(2);
//=> [2, 4, 6, 8];

x.index;
//=> 8

import magicIterable from 'magic-iterable';

// Subscribes to click events for all `<a>` elements
magicIterable(document.querySelectorAll('a')).addEventListener('click', () => {
	console.log('Click');
});

API

magicIterable(iterable)

Returns a version of iterable that when you call a method on it, it will call that method on all items in the iterable and return an array with the result.

iterable

Type: Iterable (For example, an Array)

Iterable where all the items has the method you want to call.

Related

• on-change - Watch an object or array for changes (Uses Proxy too)
• negative-array - Negative array index support (Uses Proxy too)
• known - Allow only access to known object properties (Uses Proxy too)

magic-iterable's Issues

Just wanted to be the first issue in a sindresorhus repo :D

Cool idea by the way, always wished for this! Nice clean syntax just like you always have!

It should only call the items' methods to avoid conflicts

Example

const magicIterable = require('magic-iterable');

const array = ['ax', 'b', 'xx', 'x'];
const magicArray = magicIterable(array);
console.log(magicArray.indexOf('x'))

Expected

[ 1, -1, 0, 0 ]

Currently

3

It doesn't work on array of non-objects

Example

const magicIterable = require('magic-iterable');

const array = ['ax', 'b', 'xx', 'x'];
const magicArray = magicIterable(array);
console.log(magicArray.match('x'))

Expected

[ 
  [ 'x', index: 1, input: 'ax' ], // String#match's output
  null,
  [ 'x', index: 0, input: 'xx' ],
  [ 'x', index: 0, input: 'x' ]
]

Currently

magic-iterable/index.js:17
					if (!Reflect.has(item, property)) {
					             ^

TypeError: Reflect.has called on non-object

It only supports methods

Example

const magicIterable = require('magic-iterable');

const magicElements = magicIterable(document.querySelectorAll('a'));
console.log(magicElements.textContent);
console.log(magicElements.classList.add('x'));

Expected

[ 'Home', 'Contacts', 'Click Here', 'Close' ]
[ undefined, undefined, undefined, undefined ]

Currently

function // this is the function you return at line 10
Uncaught TypeError: magicElements.classList.add is not a function