reverse-iterable-array
Advanced tools
A reverse-iterable array implementation based on the built-in Array object
The ReverseIterableArray object is a reverse-iterable array implementation based on the built-in Array object.
Links:
See also:
ReverseIterableMap: reverse-iterable-mapReverseIterableSet: reverse-iterable-setnpm install reverse-iterable-array
import ReverseIterableArray from 'reverse-iterable-array';
const array = new ReverseIterableArray();
For some live usage examples, clone the repository and run the following:
npm install
npm run build
npm start
Then, open localhost:8080/examples in a browser.
In order to run the tests, clone the repository and run the following:
npm install
npm test
A ReverseIterableArray object iterates its elements in insertion or reverse-insertion order — a for...of loop returns the array’s elements for each iteration.
new ReverseIterableArray([iterable])
Parameters:
iterable: An iterable object.Without arguments
const array = new ReverseIterableArray();
//> Array []
With multiple elements
const array = new ReverseIterableArray(1, 2, 3);
//> Array(3) [ 1, 2, 3 ]
With a single length argument
const array = new ReverseIterableArray(7);
//> Array(7) [ <7 empty slots> ]
[Symbol.toStringTag]The ReverseIterableArray[@@toStringTag] property has an initial value of “ReverseIterableArray”.
entries()Returns an iterator containing the [index, element] pairs for each element in the ReverseIterableArray object in insertion order.
An iterator containing the same pairs in reverse-insertion order can be obtained with entries().reverseIterator().
array.entries();
Return value:
A new ReverseIterableArray iterator object.
const array = new ReverseIterableArray(1, 2, 4);
const iterator = array.entries();
iterator.next().value;
//> [0, 1]
iterator.next().value;
//> [1, 2]
iterator.next().value;
//> [2, 4]
iterator.next().value;
//> undefined
forEachReverse()The forEachReverse() method executes a provided function once per each [index, element] pair in the ReverseIterableArray object, in reverse-insertion order.
array.forEachReverse(callback[, thisArg]);
Parameters:
this when executing callback.const array = new ReverseIterableArray('a', 'b', 'c');
array.forEachReverse(value => {
console.log(value);
});
//> c
//> b
//> a
array.forEachReverse(function (value, key, arrayReference) {
console.log(key, value, arrayReference.size);
});
//> 2 c 3
//> 1 b 3
//> 0 a 3
iteratorFor()Returns an iterator containing the [index, element] pairs for each element in the ReverseIterableArray object in insertion order starting with the pair specified by the index parameter.
This allows starting iteration at a specific element in the array.
An iterator containing the same pairs in reverse-insertion order can be obtained with iteratorFor(index).reverseIterator().
array.iteratorFor(index);
Parameters:
Return value:
A new ReverseIterableArray iterator object.
const array = new ReverseIterableArray('a', 'b', 'c');
// Iterator, starting at the element with key 1.
const iterator = array.iteratorFor(1);
iterator.next().value;
//> [1, 'b']
iterator.next().value;
//> [2, 'c']
iterator.next().value;
//> undefined
// Reverse-iterator, starting at the element with key 1.
const reverseIterator = array.iteratorFor(1).reverseIterator();
reverseIterator.next().value;
//> [1, 'c']
reverseIterator.next().value;
//> [0, 'a']
reverseIterator.next().value;
//> undefined
keys()Returns an iterator containing the indices for each element in the ReverseIterableArray object in insertion order.
An iterator containing the same indices in reverse-insertion order can be obtained with keys().reverseIterator().
array.keys();
Return value:
A new ReverseIterableArray iterator object.
const array = new ReverseIterableArray(1, 2, 4);
const iterator = array.keys();
iterator.next().value;
//> 0
iterator.next().value;
//> 1
iterator.next().value;
//> 2
iterator.next().value;
//> undefined
reverseIterator()In theory, following the semantics of [Symbol.iterator](), this should be [Symbol.reverseIterator](). However, as a developer, I cannot define a well-known symbol myself and make use of it. In the future, the a proposal like The ReverseIterable Interface, by Lee Byron might make it’s way into the specification. For the time being, the reverseIterator() function serves the same purpose.
array.reverseIterator();
Return value:
The array reverse-iterator function, which is the values().reverseIterator() function by default.
const array = new ReverseIterableArray(1, 2, 4);
const iterator = array.reverseIterator();
iterator.next().value;
//> [2, 4]
iterator.next().value;
//> [1, 2]
iterator.next().value;
//> [0, 1]
iterator.next().value;
//> undefined
values()Returns an iterator containing the elements in the ReverseIterableArray object in insertion order.
An iterator containing the same elements in reverse-insertion order can be obtained with values().reverseIterator().
array.values();
Return value:
A new ReverseIterableArray iterator object.
const array = new ReverseIterableArray(1, 2, 4);
const iterator = array.values();
iterator.next().value;
//> 1
iterator.next().value;
//> 2
iterator.next().value;
//> 4
iterator.next().value;
//> undefined
[Symbol.iterator]()Returns the array iterator function. By default, this is the values() function.
array[Symbol.iterator]();
Return value:
The array iterator function, which is the entries() function by default.
const array = new ReverseIterableArray(1, 2, 4);
const iterator = array[Symbol.iterator]();
iterator.next().value;
//> 1
iterator.next().value;
//> 2
iterator.next().value;
//> 4
iterator.next().value;
//> undefined
[Symbol.toStringTag]()The well-known symbol Symbol.toStringTag is accessed internally when callig Object.prototype.toString().
const array = new ReverseIterableArray();
Object.prototype.toString.call(array)
//> [object ReverseIterableArray]
6.0.0 (2022-05-01)
import ReverseIterableMap from 'reverse-iterable-array'.FAQs
A reverse-iterable array implementation based on the built-in Array object
The npm package reverse-iterable-array receives a total of 4 weekly downloads. As such, reverse-iterable-array popularity was classified as not popular.
We found that reverse-iterable-array demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.
Research
Security News
Eight new malicious Firefox extensions impersonate games, steal OAuth tokens, hijack sessions, and exploit browser permissions to spy on users.
Security News
The official Go SDK for the Model Context Protocol is in development, with a stable, production-ready release expected by August 2025.