Remove unused stuff + fix minor docs error

+ increment minor version
Arrow7000 · Aug 25, 2020 · 21e9520 · 21e9520
1 parent 206e8c0
commit 21e9520
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 2,526 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ A tiny library for queuing and throttling asynchronous functions.
 
 Perfect for managing resource-intensive processes and controlling access to rate-limited APIs.
 
-This project has 0 (zero) dependencies 👌.
+This project has 0 (zero) runtime dependencies 👌.
 
 ![NPM stats](https://nodei.co/npm/qew.png?downloads=true&downloadRank=true&stars=true)
 
@@ -81,7 +81,7 @@ prom
 // `push`'s result can also be `await`ed in an async function like any promise
 const doStuff = async () => {
     const result = await qew.push(asyncFunc);
-    // do stuff with `result`
+    // do something  with `result`
 }
 
 ```
@@ -112,7 +112,7 @@ function callback(err, result) {
 ```typescript
 constructor Qew(maxConcurrent: number = 1, delay: number | (() => number) = 0): Qew;
 
-Qew.push(func: () => Promise<T>, cb: (err: Error, result?: T) => void): this;
+Qew.push(asyncFunc: () => Promise<T>): Promise<T>;
 ```
 
 ## Contributing

diff --git a/jest.config.js b/jest.config.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "qew",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "Queue asynchronous functions",
   "source": "qew.ts",
   "main": "dist/qew.js",
@@ -10,21 +10,23 @@
   "scripts": {
     "start": "microbundle watch",
     "build": "microbundle",
-    "test": "jest",
     "watch": "tsc -w",
     "prepublish": "npm run build"
   },
   "keywords": [
     "queue",
-    "async"
+    "async",
+    "throttle",
+    "promise"
   ],
-  "author": "",
+  "author": {
+    "name": "Aron Adler",
+    "email": "[email protected]",
+    "url": "https://adler.dev/"
+  },
   "license": "MIT",
-  "repository": "Arrow7000/qew",
+  "repository": "github:Arrow7000/qew",
   "devDependencies": {
-    "@types/jest": "^25.1.0",
-    "jest": "^25.1.0",
-    "microbundle": "^0.11.0",
-    "ts-jest": "^25.0.0"
+    "microbundle": "^0.11.0"
   }
 }
diff --git a/qew.test.ts b/qew.test.ts
diff --git a/qew.ts b/qew.ts
@@ -1,6 +1,3 @@
-type AsyncFunc<T> = () => Promise<T>;
-type DelayOrDelayer = number | (() => number);
-
 function makeTriggerablePromise<T>(): [
   Promise<T>,
   (inp: T) => void,
@@ -47,7 +44,7 @@ export class Qew {
    * whenever `asyncFunc` has been run and resolved. Or the Promise will reject
    * if `asyncFunc`'s Promise rejects
    */
-  public push<T>(asyncFunc: AsyncFunc<T>) {
+  public push<T>(asyncFunc: () => Promise<T>) {
     const [prom, resolveProm, rejectProm] = makeTriggerablePromise<T>();
 
     const funcToRun = () => {