• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*! *****************************************************************************
2Copyright (c) Microsoft Corporation. All rights reserved.
3Licensed under the Apache License, Version 2.0 (the "License"); you may not use
4this file except in compliance with the License. You may obtain a copy of the
5License at http://www.apache.org/licenses/LICENSE-2.0
6
7THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
8KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
9WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
10MERCHANTABLITY OR NON-INFRINGEMENT.
11
12See the Apache Version 2.0 License for specific language governing permissions
13and limitations under the License.
14***************************************************************************** */
15
16
17
18/// <reference no-default-lib="true"/>
19
20
21/// <reference lib="es2015.symbol" />
22/// <reference lib="es2015.iterable" />
23
24interface SymbolConstructor {
25    /**
26     * A method that returns the default async iterator for an object. Called by the semantics of
27     * the for-await-of statement.
28     */
29    readonly asyncIterator: symbol;
30}
31
32interface AsyncIterator<T, TReturn = any, TNext = undefined> {
33    // NOTE: 'next' is defined using a tuple to ensure we report the correct assignability errors in all places.
34    next(...args: [] | [TNext]): Promise<IteratorResult<T, TReturn>>;
35    return?(value?: TReturn | PromiseLike<TReturn>): Promise<IteratorResult<T, TReturn>>;
36    throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
37}
38
39interface AsyncIterable<T> {
40    [Symbol.asyncIterator](): AsyncIterator<T>;
41}
42
43interface AsyncIterableIterator<T> extends AsyncIterator<T> {
44    [Symbol.asyncIterator](): AsyncIterableIterator<T>;
45}