Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

sync-primitives

fanatid25MIT1.0.1

Synchronization primitives for JavaScript

sync, synchronization, primitives, semaphore, condition, event, barrier

readme

sync-primitives

build status Coverage Status Dependency status Dev Dependency status

NPM js-standard-style

Installation

npm install sync-primitives

API

Semaphore

constructor

  • number [value=1]

acquire

  • Object [opts]
    • boolean [blocking=true]
    • boolean [timeout=-1]

return: Promise.<boolean>

release

withLock

  • function fn
  • Object [opts]
    • boolean [blocking=true]
    • boolean [timeout=-1]

return: Promise.<[boolean, *]>

Condition

...

Event

constructor

isSet

return: boolean

set

clear

wait

  • number timeout

return: Promise.<boolean>

Barrier

...

License

Code released under the MIT license.