lib.es2022.sharedmemory.d.ts 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839
  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 Atomics {
  15. /**
  16. * A non-blocking, asynchronous version of wait which is usable on the main thread.
  17. * Waits asynchronously on a shared memory location and returns a Promise
  18. * @param typedArray A shared Int32Array or BigInt64Array.
  19. * @param index The position in the typedArray to wait on.
  20. * @param value The expected value to test.
  21. * @param [timeout] The expected value to test.
  22. */
  23. waitAsync(typedArray: Int32Array, index: number, value: number, timeout?: number): { async: false; value: "not-equal" | "timed-out"; } | { async: true; value: Promise<"ok" | "timed-out">; };
  24. /**
  25. * A non-blocking, asynchronous version of wait which is usable on the main thread.
  26. * Waits asynchronously on a shared memory location and returns a Promise
  27. * @param typedArray A shared Int32Array or BigInt64Array.
  28. * @param index The position in the typedArray to wait on.
  29. * @param value The expected value to test.
  30. * @param [timeout] The expected value to test.
  31. */
  32. waitAsync(typedArray: BigInt64Array, index: number, value: bigint, timeout?: number): { async: false; value: "not-equal" | "timed-out"; } | { async: true; value: Promise<"ok" | "timed-out">; };
  33. }