Skip to content

Commit d75a562

Browse files
authored
bare bones README (#2)
1 parent f9baff7 commit d75a562

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# @PROGRAP/iterator
2+
3+
Iterator library for ECMAScript to easily work with the same set of methods from arrays on any kind of iterable.
4+
5+
## Installation
6+
```bash
7+
npm i @prograp/iterator
8+
```
9+
10+
## Usage
11+
```js
12+
import { Iterator } from '@prograp/iterator';
13+
14+
iterator.new(iterable)
15+
.map(...)
16+
.filter(...)
17+
.find(...)
18+
.reduce(...)
19+
.dedupe(...)
20+
.forEach(...)
21+
.flat(...)
22+
.flatMap(...)
23+
.find(...)
24+
.findIndex(...)
25+
.some(...)
26+
.intoArray()
27+
.intoSet()
28+
.intoMap()
29+
```
30+
31+
## Contribution
32+
Feel free to open a new issue if you encounter bugs or have suggestions for improvements,
33+
but make sure to file one before submitting a Pull-Request, as every PR has to have an issue associated with it.

0 commit comments

Comments
 (0)