Skip to content

Commit

Permalink
docs(empty): add docs for empty method
Browse files Browse the repository at this point in the history
  • Loading branch information
blond committed Jul 19, 2016
1 parent f89504d commit 2a7aad8
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,24 @@ for (let item of evenly(set1, set2)) { console.log(item) } // 1 3 2 4 5
API
---

* [empty(...iterators)](#emptyiterators)
* [series(...iterators)](#seriesiterators)
* [evenly(...iterators)](#evenlyiterators)

### empty()

Returns an empty Iterator.

**Example:**

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

const iter = empty();

console.log(iter.next()); // { value: null, done: true }
```

### series(...iterators)

Returns an Iterator, that traverses iterators in series.
Expand Down

0 comments on commit 2a7aad8

Please sign in to comment.