Skip to content

Commit

Permalink
Verbiage
Browse files Browse the repository at this point in the history
  • Loading branch information
compulim committed May 24, 2024
1 parent cb960e3 commit 02b2bb1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,10 @@ Generator has more functionalities than iterator and array. It is not recommende

### When should I use `Iterable`, `IterableIterator` and `Iterator`?

For best compatibility, you should generally follow this pattern. `Iterable` for inputs, and `IterableIterator` for outputs. You should rarely use pure `Iterator`.
For best compatibility, you should generally follow this API signature: use `Iterable` for inputs, and use `IterableIterator` for outputs. You should rarely use pure `Iterator`.

```ts
function transform(iterable: Iterable<T>): IterableIterator<T>;
function transform<T>(iterable: Iterable<T>): IterableIterator<T>;
```

### What is on the roadmap?
Expand Down

0 comments on commit 02b2bb1

Please sign in to comment.