Skip to content

[RFC] Improve core types for (Async) Iterable/Iterator/Generator #3988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[RFC] Improve core types for (Async) Iterable/Iterator/Generator #3988

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 21 additions & 17 deletions lib/core.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,19 +547,21 @@ type IteratorResult<Yield,Return> =
| { done: true, value?: Return }
| { done: false, value: Yield };

interface $Iterator<+Yield,+Return,-Next> {
@@iterator(): $Iterator<Yield,Return,Next>;
next(value?: Next): IteratorResult<Yield,Return>;
}
type Iterator<+T> = $Iterator<T,void,void>;

interface $Iterable<+Yield,+Return,-Next> {
@@iterator(): $Iterator<Yield,Return,Next>;
}
type Iterable<+T> = $Iterable<T,void,void>;

interface Generator<+Yield,+Return,-Next> {
@@iterator(): $Iterator<Yield,Return,Next>;
interface $Iterator<+Yield,+Return,-Next> implements $Iterable<Yield,Return,Next> {
@@iterator(): this;
next(value?: Next): IteratorResult<Yield,Return>;
return?: <R>(value: R) => IteratorResult<Yield,R|Return>;
throw?: (error?: any) => IteratorResult<Yield,Return>;
}
type Iterator<+T> = $Iterator<T,void,void>;

interface Generator<+Yield,+Return,-Next> implements $Iterator<Yield,Return,Next> {
@@iterator(): this;
next(value?: Next): IteratorResult<Yield,Return>;
return<R>(value: R): IteratorResult<Yield,R|Return>;
throw(error?: any): IteratorResult<Yield,Return>;
Expand All @@ -569,25 +571,27 @@ declare function $iterate<T>(p: Iterable<T>): T;

/* Async Iterable/Iterator/Generator */

interface $AsyncIterator<+Yield,+Return,-Next> {
@@asyncIterator(): $AsyncIterator<Yield,Return,Next>;
next(value?: Next): Promise<IteratorResult<Yield,Return>>;
}
type AsyncIterator<+T> = $AsyncIterator<T,void,void>;

interface $AsyncIterable<+Yield,+Return,-Next> {
@@asyncIterator(): $AsyncIterator<Yield,Return,Next>;
}
type AsyncIterable<+T> = $AsyncIterable<T,void,void>;

interface AsyncGenerator<+Yield,+Return,-Next> {
@@asyncIterator(): $AsyncIterator<Yield,Return,Next>;
interface $AsyncIterator<+Yield,+Return,-Next> implements $AsyncIterable<Yield,Return,Next> {
@@asyncIterator(): this;
next(value?: Next): Promise<IteratorResult<Yield,Return>>;
return?: <R>(value: R) => Promise<IteratorResult<Yield,R|Return>>;
throw? (error?: any) => Promise<IteratorResult<Yield,Return>>;
}
type AsyncIterator<+T> = $AsyncIterator<T,void,void>;

interface AsyncGenerator<+Yield,+Return,-Next> implements $AsyncIterator {
@@asyncIterator(): this;
next(value?: Next): Promise<IteratorResult<Yield,Return>>;
return<R>(value: R): Promise<IteratorResult<Yield,R|Return>>;
throw(error?: any): Promise<IteratorResult<Yield,Return>>;
}

declare function $asyncIterator<T>(p: AsyncIterable<T>): T;
declare function $asyncIterate<T>(p: AsyncIterable<T>): T;

/* Maps and Sets */

Expand Down