Skip to content

Commit

Permalink
docs(reverse): add docs for reverse() method
Browse files Browse the repository at this point in the history
  • Loading branch information
blond committed Aug 12, 2016
1 parent da56fcb commit e9f0ae5
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Helpers:
* [isIterator(iterator)](#isiteratoriterator)
* [series(...iterables)](#seriesiterators)
* [evenly(...iterables)](#evenlyiterators)
* [reverse(iterable)](#reverseiterable)

### hoi(iterable)

Expand Down Expand Up @@ -322,6 +323,7 @@ Use [hoi.value(value)](#valuevalue) to create iterator with one value.
* [isIterator(iterator)](#isiteratoriterator)
* [series(...iterables)](#seriesiterators)
* [evenly(...iterables)](#evenlyiterators)
* [reverse(iterable)](#reverseiterable)

#### value(value)

Expand Down Expand Up @@ -426,6 +428,35 @@ for (let item of evenly(set1, set2)) {
// ➜ 1 3 2 4
```

### reverse(iterator)

Returns an reversed Iterator.

**Important:** don't use infinite iterator, reverse method fall into endless loop.

This is reminiscent of the reversing of array

**Example:**

```js
const reverse = require('ho-iter').reverse;

const arr = [1, 2, 3, 4];
const set = new Set([1, 2, 3, 4]);

for (let i = lenght; i > 0; i--) {
console.log(arr[i]);
}

// ➜ 4 3 2 1

for (let item of reverse(set)) {
console.log(item);
}

// ➜ 4 3 2 1
```

License
-------

Expand Down

0 comments on commit e9f0ae5

Please sign in to comment.