1.1.0

README.md

@@ -21,4 +21,62 @@ dropin replacement for q
 ## Usage
 Use TypeScript for best in class instellisense.
 
+> Note: smartq uses native ES6 promises
+> smartq does not repeat any native functions, so for things like .all() simply use Promise.all()
+
+```javascript
+import * as q from 'smartq'
+
+// Deferred
+// -----------------------------------------------
+let myAsyncFunction = (): Promise<string> => {
+    let done = q.defer<string>() // returns your typical Deferred object
+    setTimeout(() => {
+        done.resolve('hi') // will throw type error for other types than string as argument ;)
+    },6000)
+    return done.promise
+}
+
+let myAsyncFunction2 = async () => {
+    let aString = await myAsyncFunction()
+    console.log(aString) // will log 'hi' to console
+}
+
+myAsyncFunction2();
+
+
+// Resolved and Rejected promises
+// ------------------------------------------------
+q.resolvedPromise(`I'll get logged to console soon`)
+    .then(x => {
+        console.log(x)
+    })
+
+q.rejectedPromise(`what a lovely error message`)
+    .then(() => {
+        console.log('This never makes it to console')
+    }/*, alternatively put a reject function here */)
+    .catch(err => {
+        console.log(err)
+    })
+
+// Promisify (typed)
+// ------------------------------------------------
+
+let myCallbackedFunction = (someString: string, someNumber: number, cb) => {
+    cb(null, someString)
+}
+
+let myPromisedFunction = q.promisify(myCallbackFunction)
+myPromisedFunction('helloThere', 2).then(x => {
+    console.log(x) // will log 'helloThere' to console
+})
+
+```
+
+## Dependency Credits:
+who | made what
+-- | --
+[notenoughneon](https://www.npmjs.com/~notenoughneon) | [typed-promisify](https://www.npmjs.com/package/typed-promisify)
+
 [![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

dist/index.d.ts

@@ -1,4 +1,5 @@
 import 'typings-global';
+import * as typedPromisify from 'typed-promisify';
 export interface IResolve<T> {
     (value?: T | Promise<T>): void;
 }
@@ -12,4 +13,13 @@ export declare class Deferred<T> {
     constructor();
 }
 export declare let defer: <T>() => Deferred<T>;
-export declare let all: () => void;
+/**
+ * Creates a new resolved promise for the provided value.
+ */
+export declare let resolvedPromise: <T>(value?: T) => Promise<T>;
+/**
+ * Creates a new rejected promise for the provided reason.
+ */
+export declare let rejectedPromise: (err: any) => Promise<never>;
+export declare let promisify: typeof typedPromisify.promisify;
+export declare let map: typeof typedPromisify.map;

dist/index.js

@@ -1,5 +1,6 @@
 "use strict";
 require("typings-global");
+const typedPromisify = require("typed-promisify");
 class Deferred {
     constructor() {
         this.promise = new Promise((resolve, reject) => {
@@ -12,6 +13,18 @@ exports.Deferred = Deferred;
 exports.defer = () => {
     return new Deferred();
 };
-exports.all = () => {
+/**
+ * Creates a new resolved promise for the provided value.
+ */
+exports.resolvedPromise = (value) => {
+    return Promise.resolve(value);
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBVXZCO0lBSUk7UUFDSSxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksT0FBTyxDQUFJLENBQUMsT0FBTyxFQUFFLE1BQU07WUFDMUMsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUE7WUFDdEIsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUE7UUFDeEIsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDO0NBQ0o7QUFWRCw0QkFVQztBQUVVLFFBQUEsS0FBSyxHQUFHO0lBQ2YsTUFBTSxDQUFDLElBQUksUUFBUSxFQUFLLENBQUE7QUFDNUIsQ0FBQyxDQUFBO0FBR1UsUUFBQSxHQUFHLEdBQUc7QUFFakIsQ0FBQyxDQUFBIn0=
+/**
+ * Creates a new rejected promise for the provided reason.
+ */
+exports.rejectedPromise = (err) => {
+    return Promise.reject(err);
+};
+exports.promisify = typedPromisify.promisify;
+exports.map = typedPromisify.map;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBRXZCLGtEQUFpRDtBQVVqRDtJQUlJO1FBQ0ksSUFBSSxDQUFDLE9BQU8sR0FBRyxJQUFJLE9BQU8sQ0FBSSxDQUFDLE9BQU8sRUFBRSxNQUFNO1lBQzFDLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFBO1lBQ3RCLElBQUksQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFBO1FBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBQ04sQ0FBQztDQUNKO0FBVkQsNEJBVUM7QUFFVSxRQUFBLEtBQUssR0FBRztJQUNmLE1BQU0sQ0FBQyxJQUFJLFFBQVEsRUFBSyxDQUFBO0FBQzVCLENBQUMsQ0FBQTtBQUVEOztHQUVHO0FBQ1EsUUFBQSxlQUFlLEdBQUcsQ0FBSSxLQUFTO0lBQ3RDLE1BQU0sQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFBO0FBQ2pDLENBQUMsQ0FBQTtBQUVEOztHQUVHO0FBQ1EsUUFBQSxlQUFlLEdBQUcsQ0FBQyxHQUFHO0lBQzdCLE1BQU0sQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFBO0FBQzlCLENBQUMsQ0FBQTtBQUVVLFFBQUEsU0FBUyxHQUFHLGNBQWMsQ0FBQyxTQUFTLENBQUE7QUFDcEMsUUFBQSxHQUFHLEdBQUcsY0FBYyxDQUFDLEdBQUcsQ0FBQSJ9

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartq",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "dropin replacement for q",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -18,11 +18,11 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartq#README",
   "dependencies": {
+    "typed-promisify": "^0.3.0",
     "typings-global": "^1.0.14"
   },
   "devDependencies": {
-    "@types/should": "^8.1.30",
+    "smartchai": "^1.0.1",
-    "should": "^11.1.2",
     "typings-test": "^1.0.3"
   }
 }

test/test.js

@@ -1,23 +1,34 @@
 "use strict";
 require("typings-test");
-const should = require("should");
+const smartchai_1 = require("smartchai");
 const q = require("../dist/index");
+let myCallback = (someValue1, cb) => {
+    cb(null, someValue1);
+};
 describe('smartq', function () {
-    it('should return a Deferred for .defer()', function (done) {
+    it('should return a Deferred for .defer()', function () {
         let myDeferred = q.defer();
-        myDeferred.promise.then(() => {
+        let expectPromise = smartchai_1.expect(myDeferred.promise).to.eventually.be.fulfilled;
-            done();
-        });
         myDeferred.resolve();
+        return expectPromise;
     });
-    it('should let types flow through the Promise', function (done) {
+    it('should let types flow through the Promise', function () {
         let myString = 'someString';
         let myDeferred = q.defer();
-        myDeferred.promise.then(x => {
+        let expectPromise = smartchai_1.expect(myDeferred.promise).to.eventually.equal('someString');
-            should(x).equal('someString');
-            done();
-        });
         myDeferred.resolve(myString);
+        return expectPromise;
+    });
+    it('should promisify a callback', function () {
+        let myPromisified = q.promisify(myCallback);
+        let expectPromise = smartchai_1.expect(myPromisified('hi')).to.eventually.equal('hi');
+        return expectPromise;
+    });
+    it('should map callbacks', function () {
+        let inputArray = ['hi', 'awesome'];
+        let myPromisified = q.promisify(myCallback);
+        let expectPromise = smartchai_1.expect(q.map(inputArray, myPromisified)).to.eventually.deep.equal(inputArray);
+        return expectPromise;
     });
 });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUVyQixpQ0FBZ0M7QUFDaEMsbUNBQWtDO0FBRWxDLFFBQVEsQ0FBQyxRQUFRLEVBQUU7SUFDZixFQUFFLENBQUMsdUNBQXVDLEVBQUUsVUFBUyxJQUFJO1FBQ3JELElBQUksVUFBVSxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtRQUMxQixVQUFVLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQztZQUNwQixJQUFJLEVBQUUsQ0FBQTtRQUNWLENBQUMsQ0FBQyxDQUFBO1FBQ0YsVUFBVSxDQUFDLE9BQU8sRUFBRSxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBRUYsRUFBRSxDQUFDLDJDQUEyQyxFQUFFLFVBQVMsSUFBSTtRQUN6RCxJQUFJLFFBQVEsR0FBRyxZQUFZLENBQUE7UUFDM0IsSUFBSSxVQUFVLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBVSxDQUFBO1FBQ2xDLFVBQVUsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDckIsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxZQUFZLENBQUMsQ0FBQTtZQUM3QixJQUFJLEVBQUUsQ0FBQTtRQUNWLENBQUMsQ0FBQyxDQUFBO1FBQ0YsVUFBVSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQTtJQUNoQyxDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUVyQix5Q0FBa0M7QUFDbEMsbUNBQWtDO0FBRWxDLElBQUksVUFBVSxHQUFHLENBQUMsVUFBa0IsRUFBRSxFQUFHO0lBQ3JDLEVBQUUsQ0FBQyxJQUFJLEVBQUUsVUFBVSxDQUFDLENBQUE7QUFDeEIsQ0FBQyxDQUFBO0FBRUQsUUFBUSxDQUFDLFFBQVEsRUFBRTtJQUNmLEVBQUUsQ0FBQyx1Q0FBdUMsRUFBRTtRQUN4QyxJQUFJLFVBQVUsR0FBRyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDMUIsSUFBSSxhQUFhLEdBQUcsa0JBQU0sQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxFQUFFLENBQUMsU0FBUyxDQUFBO1FBQ3pFLFVBQVUsQ0FBQyxPQUFPLEVBQUUsQ0FBQTtRQUNwQixNQUFNLENBQUMsYUFBYSxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBRUYsRUFBRSxDQUFDLDJDQUEyQyxFQUFFO1FBQzVDLElBQUksUUFBUSxHQUFHLFlBQVksQ0FBQTtRQUMzQixJQUFJLFVBQVUsR0FBRyxDQUFDLENBQUMsS0FBSyxFQUFVLENBQUE7UUFDbEMsSUFBSSxhQUFhLEdBQUcsa0JBQU0sQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsWUFBWSxDQUFDLENBQUE7UUFDaEYsVUFBVSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQTtRQUM1QixNQUFNLENBQUMsYUFBYSxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBRUYsRUFBRSxDQUFDLDZCQUE2QixFQUFFO1FBQzlCLElBQUksYUFBYSxHQUFHLENBQUMsQ0FBQyxTQUFTLENBQUMsVUFBVSxDQUFDLENBQUE7UUFDM0MsSUFBSSxhQUFhLEdBQUcsa0JBQU0sQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQTtRQUN6RSxNQUFNLENBQUMsYUFBYSxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBRUYsRUFBRSxDQUFDLHNCQUFzQixFQUFFO1FBQ3ZCLElBQUksVUFBVSxHQUFHLENBQUMsSUFBSSxFQUFFLFNBQVMsQ0FBQyxDQUFBO1FBQ2xDLElBQUksYUFBYSxHQUFHLENBQUMsQ0FBQyxTQUFTLENBQUMsVUFBVSxDQUFDLENBQUE7UUFDM0MsSUFBSSxhQUFhLEdBQUcsa0JBQU0sQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLFVBQVUsRUFBRSxhQUFhLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtRQUNqRyxNQUFNLENBQUMsYUFBYSxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==

test/test.ts

@@ -1,24 +1,38 @@
 import 'typings-test'
 
-import * as should from 'should'
+import { expect } from 'smartchai'
 import * as q from '../dist/index'
 
+let myCallback = (someValue1: string, cb?) => {
+    cb(null, someValue1)
+}
+
 describe('smartq', function () {
-    it('should return a Deferred for .defer()', function(done) {
+    it('should return a Deferred for .defer()', function () {
         let myDeferred = q.defer()
-        myDeferred.promise.then(() => {
+        let expectPromise = expect(myDeferred.promise).to.eventually.be.fulfilled
-            done()
-        })
         myDeferred.resolve()
+        return expectPromise
     })
 
-    it('should let types flow through the Promise', function(done) {
+    it('should let types flow through the Promise', function () {
         let myString = 'someString'
         let myDeferred = q.defer<string>()
-        myDeferred.promise.then(x => {
+        let expectPromise = expect(myDeferred.promise).to.eventually.equal('someString')
-            should(x).equal('someString')
-            done()
-        })
         myDeferred.resolve(myString)
+        return expectPromise
+    })
+
+    it('should promisify a callback', function () {
+        let myPromisified = q.promisify(myCallback)
+        let expectPromise = expect(myPromisified('hi')).to.eventually.equal('hi')
+        return expectPromise
+    })
+
+    it('should map callbacks', function() {
+        let inputArray = ['hi', 'awesome']
+        let myPromisified = q.promisify(myCallback)
+        let expectPromise = expect(q.map(inputArray, myPromisified)).to.eventually.deep.equal(inputArray)
+        return expectPromise
     })
 })

ts/index.ts

@@ -1,5 +1,7 @@
 import 'typings-global'
 
+import * as typedPromisify from 'typed-promisify'
+
 export interface IResolve<T> {
     (value?: T | Promise<T>): void
 }
@@ -24,7 +26,20 @@ export let defer = <T>() => {
     return new Deferred<T>()
 }
 
-
+/**
-export let all = () => {
+ * Creates a new resolved promise for the provided value.
-
+ */
+export let resolvedPromise = <T>(value?: T): Promise<T> => {
+    return Promise.resolve(value)
 }
+
+/**
+ * Creates a new rejected promise for the provided reason.
+ */
+export let rejectedPromise = (err) => {
+    return Promise.reject(err)
+}
+
+export let promisify = typedPromisify.promisify
+export let map = typedPromisify.map
+export let _try = typedPromisify._try