Documentation API update (typescript notation)

Arrow7000 · May 15, 2017 · 2797e7d · 2797e7d
1 parent db1022d
commit 2797e7d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -129,6 +129,15 @@ qew.push(['d', 'e', 'f'].map(makeFunc), arrayCallback);
 qew.push(['g', 'h', 'i'].map(makeFunc), arrayCallback);
 ```
 
+## API
+
+```typescript
+Qew.push(func: () => Promise<any>, cb: (err: Error, result?: any) => void): this;
+Qew.push(funcs: (() => Promise<any>)[], cb: (resultArray: { result: any, error: Error }}[]) => void): this;
+
+Qew.pushProm(func: () => Promise<any>): Promise<any>;
+Qew.pushProm(funcs:( () => Promise<any>)[]): Promise<{ result: any, error: Error }}[]>;
+```
 
 ## Contributing
 

diff --git a/src/qew.ts b/src/qew.ts
@@ -262,4 +262,5 @@ export = Qew;
  * qew.pushProm(asyncFunc[]): Promise<({ error, result })[]>;
  *
  */
+
 // const q = new Qew(2, 100)
-Original file line number
+Diff line change
@@ Expand Up / @@ -262,4 +262,5 @@ export = Qew; @@
      * qew.pushProm(asyncFunc[]): Promise<({ error, result })[]>;
      *
      */
     // const q = new Qew(2, 100)