Skip to content

Commit

Permalink
docs: added explanation of this library
Browse files Browse the repository at this point in the history
  • Loading branch information
CMCDragonkai committed Jun 18, 2023
1 parent 78dc8dc commit 6da8635
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ master:[![pipeline status](https://gitlab.com/MatrixAI/open-source/js-async-lock

Asynchronous lock utilities.

JavaScript exposes the ability to create interleaved execution of asynchronous
operations. When this is done with shared state between asynchronous
overlapping functions that perform partial state transitions, this can lead to
race conditions or data corruption and clobbering, or just invalid pre-condition
or post-condition behaviour.

This library provides multiple synchronization constructs that allow one to
precisely control concurrent operations. These constructs are intended for
pessimistic concurrency control. If you can prefer to use optimistic concurrency
control mechanisms. But that is outside the scope of this library. In many cases
you cannot use optimistic methods, and thus you need this library.

## Installation

```sh
Expand Down

0 comments on commit 6da8635

Please sign in to comment.