Skip to content

Commit e66d01e

Browse files
committed
docs: update README
1 parent 8483ad3 commit e66d01e

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![codecov](https://codecov.io/github/jsr-core/iterutil/graph/badge.svg?token=pfbLRGU5AM)](https://codecov.io/github/jsr-core/iterutil)
66

77
Iterator / AsyncIterator utility pack for JavaScript and TypeScript. Each module
8-
is designed to work independently, avoiding internal interdependencies as much
8+
is designed to work independently, avoiding internal inter-dependencies as much
99
as possible.
1010

1111
## Usage
@@ -16,7 +16,7 @@ both synchronous and asynchronous iterables (`Iterable` and `AsyncIterable`).
1616

1717
### chain
1818

19-
Chains multiple iterables or async iterables together.
19+
Chains multiple iterables together.
2020

2121
```ts
2222
import { chain } from "@core/iterutil/chain";
@@ -54,7 +54,7 @@ console.log(await toArray(iter)); // [[1, 2], [3, 4], [5]]
5454

5555
### compact
5656

57-
Removes all nullish values from an iterable.
57+
Removes all nullish (`null` or `undefined`) values from an iterable.
5858

5959
```ts
6060
import { compact } from "@core/iterutil/compact";
@@ -73,7 +73,7 @@ console.log(await toArray(iter)); // [1, 2, 3]
7373

7474
### compress
7575

76-
Compress an iterable by selecting elements using a selector iterable.
76+
Compresses an iterable by selecting elements using a selector iterable.
7777

7878
```ts
7979
import { compress } from "@core/iterutil/compress";
@@ -164,7 +164,7 @@ console.log(await toArray(iter)); // [3, 4, 5]
164164

165165
### enumerate
166166

167-
Enumerate an iterable.
167+
Enumerates an iterable.
168168

169169
```ts
170170
import { enumerate } from "@core/iterutil/enumerate";
@@ -318,7 +318,7 @@ await forEach([1, 2, 3], console.log);
318318

319319
### iter
320320

321-
Convert an iterable to an iterator.
321+
Converts an iterable to an iterator.
322322

323323
```ts
324324
import { iter } from "@core/iterutil/iter";
@@ -431,7 +431,7 @@ console.log(odd); // [1, 3, 5]
431431

432432
### range
433433

434-
Generate a range of numbers.
434+
Generates a range of numbers.
435435

436436
```ts
437437
import { range } from "@core/iterutil/range";
@@ -492,7 +492,7 @@ console.log(await some([1, 3, 5], (value) => value % 2 === 0)); // false
492492

493493
### take
494494

495-
Take the first `limit` items from the iterable.
495+
Takes the first `limit` items from the iterable.
496496

497497
```ts
498498
import { take } from "@core/iterutil/take";
@@ -511,7 +511,7 @@ console.log(await toArray(iter)); // [1, 2]
511511

512512
### takeWhile
513513

514-
Take elements from the iterable while the predicate is true.
514+
Takes elements from the iterable while the predicate is true.
515515

516516
```ts
517517
import { takeWhile } from "@core/iterutil/take-while";

0 commit comments

Comments
 (0)