lib.esnext.promise.d.ts 1.4 KB

1234567891011121314151617181920212223242526272829303132333435
  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. interface PromiseWithResolvers<T> {
  15. promise: Promise<T>;
  16. resolve: (value: T | PromiseLike<T>) => void;
  17. reject: (reason?: any) => void;
  18. }
  19. interface PromiseConstructor {
  20. /**
  21. * Creates a new Promise and returns it in an object, along with its resolve and reject functions.
  22. * @returns An object with the properties `promise`, `resolve`, and `reject`.
  23. *
  24. * ```ts
  25. * const { promise, resolve, reject } = Promise.withResolvers<T>();
  26. * ```
  27. */
  28. withResolvers<T>(): PromiseWithResolvers<T>;
  29. }