From 1b1351fffa2b4bf74896c71ecec5433f0159b5ea Mon Sep 17 00:00:00 2001
From: DarkWiiPlayer <darkwiiplayer@hotmail.com>
Date: Fri, 1 Jul 2022 10:02:03 +0200
Subject: [PATCH] Document pqueue (somewhat)

---
 pqueue.js | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/pqueue.js b/pqueue.js
index fb15b0c..a9d750c 100644
--- a/pqueue.js
+++ b/pqueue.js
@@ -1,3 +1,14 @@
+// Promise Queue
+// Wraps promises to make sure they resolve in the order they were wrapped.
+// 
+// Usage example:
+// - Some asynchronous process starts fetching pages from a server in order
+// - New requests may start before previous ones are finished
+// - With some bad luck, page M may load before page N < M
+// This means you can't just append pages as they arrive.
+// PQueue will make sure promise M never resolves before promise N.
+
+// Wrap a promise to make its state queryable
 const queryable = promise => {
 	let result = promise.then(result => {
 		q.result = result
@@ -9,6 +20,7 @@ const queryable = promise => {
 	return result
 }
 
+// Integer => Promise => Promise
 export default (parallel = 1) => {
 	const running = []
 	const waiting = []