Mutex.d.ts 1.1 KB

1234567891011121314151617181920212223242526272829
  1. /**
  2. * Copyright 2023 Google LLC.
  3. * Copyright (c) Microsoft Corporation.
  4. * Copyright 2022 The Chromium Authors.
  5. *
  6. * Licensed under the Apache License, Version 2.0 (the "License");
  7. * you may not use this file except in compliance with the License.
  8. * You may obtain a copy of the License at
  9. *
  10. * http://www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing, software
  13. * distributed under the License is distributed on an "AS IS" BASIS,
  14. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. * See the License for the specific language governing permissions and
  16. * limitations under the License.
  17. */
  18. export type ReleaseFunction = () => void;
  19. /**
  20. * Use Mutex class to coordinate local concurrent operations.
  21. * Once `acquire` promise resolves, you hold the lock and must
  22. * call `release` function returned by `acquire` to release the
  23. * lock. Failing to `release` the lock may lead to deadlocks.
  24. */
  25. export declare class Mutex {
  26. #private;
  27. acquire(): Promise<ReleaseFunction>;
  28. run<T>(action: () => Promise<T>): Promise<T>;
  29. }