@calebboyd/semaphore

Simple promise based counting semaphore

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@calebboyd/semaphore
Minified + gzip package size for @calebboyd/semaphore in KB

Readme

Semaphore

Naive resource management / concurrency primitive

npm i @calebboyd/semaphore

Example

import { Semaphore } from '@calebboyd/semaphore'
import { something } from './somewhere'

function doSomeWork () {
  const lock = new Semaphore(10)
  while(something.isTrue) {
    lock.acquire().then(x => () => {
      something.work().then(lock.release)
    })    
  }
}

The semaphore will only allow 10 locks to be aquired at a time. This limits the concurrency of the asyncronous function something.work to 10

API:

export class Semaphore {
  constructor (count: number) {}
  acquire(): Promise<void>
  release(): void
}

License

MIT

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.