Skip to content

Commit 69ca09f

Browse files
committed
Improve documentation
1 parent 495f57c commit 69ca09f

File tree

1 file changed

+0
-10
lines changed

1 file changed

+0
-10
lines changed

README.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -135,16 +135,6 @@ npm install bounded-queue
135135

136136
# API Documentation
137137

138-
### Producer
139-
140-
The producer returns (produces) a [promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) which resolves the batched item tp be placed on the queue.
141-
`null` can be returns to indicate end of the production.
142-
143-
### Consumer
144-
145-
The consumer will be called with the first batch item available on the queue.
146-
It returns a [promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), and when resolves, it indicates it can handle the next batch item.
147-
148138
## BoundedQueue class
149139

150140
### Constructor

0 commit comments

Comments
 (0)