Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
RobTheFiveNine committed Jul 17, 2021
1 parent 2cb3998 commit e3dedbb
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# mutex.js [![](https://github.com/RobTheFiveNine/mutex.js/actions/workflows/test.yml/badge.svg?branch=stable)](https://github.com/RobTheFiveNine/mutex.js/actions/workflows/test.yml) [![](https://coveralls.io/repos/github/RobTheFiveNine/mutex.js/badge.svg?branch=stable)](https://coveralls.io/github/RobTheFiveNine/mutex.js?branch=stable)
# mutex.js [![](https://github.com/RobTheFiveNine/mutex.js/actions/workflows/test.yml/badge.svg?branch=stable)](https://github.com/RobTheFiveNine/mutex.js/actions/workflows/test.yml) [![](https://coveralls.io/repos/github/RobTheFiveNine/mutex.js/badge.svg?branch=stable)](https://coveralls.io/github/RobTheFiveNine/mutex.js?branch=stable) ![npm downloads](https://img.shields.io/npm/dt/@robthefivenine/mutex.js) ![npm (scoped)](https://img.shields.io/npm/v/@robthefivenine/mutex.js)

Install
-------
Expand Down Expand Up @@ -95,6 +95,15 @@ Gets the globally registered mutex corresponding to `name`. If a mutex has not a

This is the preferred method to create mutexes when they must be shared in a global context.

#### Mutex.getAllMutexes()
Returns all globally registered mutexes created using `Mutex.getMutex`.

#### Mutex.remove(name)
Release and remove a globally registered mutex created using `Mutex.getMutex` with a matching `name`.

#### Mutex.removeAll()
Release and remove all globally registered mutexes created using `Mutex.getMutex`.

### Instance Properties

#### instance.name
Expand Down

0 comments on commit e3dedbb

Please sign in to comment.