lib.es2018.asynciterable.d.ts 1.7 KB

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