Skip to content

Commit

Permalink
Added missing section breaks.
Browse files Browse the repository at this point in the history
  • Loading branch information
T99 authored Sep 14, 2021
1 parent 7aded10 commit 2c5df33
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,8 @@ await Promise.all(scrapingPromises);
// ensuring we're not bombarding some poor webmaster's server!
```

---

### Other Potentially Useful Stuff

#### `semaphore.getLockCount()`
Expand All @@ -286,6 +288,8 @@ await semaphore.getLock();
console.log(semaphore.getLockCount()); //=> 3
```

---

#### `semaphore.getMaximumLockCount()`

`semaphore.getMaximumLockCount()` returns a number representative of the maximum number of locks that can be
Expand All @@ -299,6 +303,8 @@ let semaphore: Semaphore = new Semaphore(42);
console.log(semaphore.getMaximumLockCount()); //=> 42
```

---

#### `lock.getID()`

`lock.getID()` returns the string ID of this lock, uniquely identifying it to it's issuing `Semaphore`.
Expand All @@ -311,6 +317,8 @@ let lock: SemaphoreLock = await (new Semaphore(8)).getLock();
console.log(lock.getID()); //=> '1343ee064f8fd176b797a1ee5b84d862'
```

---

#### `lock.waitForRelease()`

`lock.then(...)` returns a Promise that will resolve to the string ID of this lock once this lock is released.
Expand Down

0 comments on commit 2c5df33

Please sign in to comment.