aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@calebboyd/semaphore/README.md
blob: cdee8bf9c7b7b94d328edbea5921616930bb4fc5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
## Semaphore

Naive resource management / concurrency primitive

`npm i @calebboyd/semaphore`

### Example
```javascript
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: 

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

## License

MIT