Skip to content

Commit

Permalink
Add signature section
Browse files Browse the repository at this point in the history
  • Loading branch information
compulim committed May 24, 2024
1 parent 890c9dc commit cb960e3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,14 @@ Generator has more functionalities than iterator and array. It is not recommende
- `generator.next('something')`, the feedback can be assigned to variable via `const feedback = yield;`
- For-loop cannot send feedbacks to generator

### 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`.

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

### What is on the roadmap?

We are planning to bring iterables and alikes together. This includes:
Expand Down

0 comments on commit cb960e3

Please sign in to comment.