loc

lock

lock asynchronous resources

Showing:

Popularity

Downloads/wk

407K

GitHub Stars

43

Maintenance

Last Commit

4yrs ago

Contributors

6

Package

Dependencies

0

Size (min+gzip)

0.5KB

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

lock

lock asynchronous resources.

Simple Example

var Lock = require('lock').Lock
var lock = Lock()

lock('key', function (release) { //called when resource is available.

  //do an async operation, and wrap the callback with release.
  someAsyncOperation(args,..., release(function (err) {
    //'key' is now unlocked!
  })
})

Multiple Locks at Once.

var Lock = require('lock').Lock
var lock = Lock()

lock(['A', 'B', 'C'], function (release) { //called, when ALL
                                           //resources are available.

  //do an async operation, and wrap the callback with release(cb)
  someAsyncOperation(args,..., release(function (err) {
    //A, B & C are now unlocked!
  })
})

Lock with optional callback.

var Lock = require('lock').Lock
var lock = Lock()

lock('cache', function(release) { //called when no one is writing to cache
    //we do not care if this fails since its a cache so no callback needed
    fs.writeFile(fileCache, ... , release())
})

used in level-update

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial