1.1.1

Implementation

See merge request !1

README.md

@@ -2,10 +2,10 @@
 dropin replacement for q
 
 ## Availabililty
-[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartq)
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartq)
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartq)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartq/)
+[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartq)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartq)
+[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartq)
+[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartq/)
 
 ## Status for master
 [![build status](https://GitLab.com/pushrocks/smartq/badges/master/build.svg)](https://GitLab.com/pushrocks/smartq/commits/master)
@@ -21,4 +21,66 @@ dropin replacement for q
 ## Usage
 Use TypeScript for best in class instellisense.
 
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
+> 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)
+
+For further information read the linked docs at the top of this README.
+
+> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

dist/index.d.ts

@@ -0,0 +1,25 @@
+import 'typings-global';
+import * as typedPromisify from 'typed-promisify';
+export interface IResolve<T> {
+    (value?: T | Promise<T>): void;
+}
+export interface IReject {
+    (reason?: any): void;
+}
+export declare class Deferred<T> {
+    promise: Promise<T>;
+    resolve: IResolve<T>;
+    reject: IReject;
+    constructor();
+}
+export declare let defer: <T>() => Deferred<T>;
+/**
+ * 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

@@ -0,0 +1,30 @@
+"use strict";
+require("typings-global");
+const typedPromisify = require("typed-promisify");
+class Deferred {
+    constructor() {
+        this.promise = new Promise((resolve, reject) => {
+            this.resolve = resolve;
+            this.reject = reject;
+        });
+    }
+}
+exports.Deferred = Deferred;
+exports.defer = () => {
+    return new Deferred();
+};
+/**
+ * Creates a new resolved promise for the provided value.
+ */
+exports.resolvedPromise = (value) => {
+    return Promise.resolve(value);
+};
+/**
+ * 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.1",
+  "version": "1.1.1",
   "description": "dropin replacement for q",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -16,5 +16,13 @@
   "bugs": {
     "url": "https://gitlab.com/pushrocks/smartq/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/smartq#README"
+  "homepage": "https://gitlab.com/pushrocks/smartq#README",
+  "dependencies": {
+    "typed-promisify": "^0.3.0",
+    "typings-global": "^1.0.14"
+  },
+  "devDependencies": {
+    "smartchai": "^1.0.1",
+    "typings-test": "^1.0.3"
+  }
 }

test/test.d.ts

@@ -0,0 +1 @@
+import 'typings-test';

test/test.js

@@ -0,0 +1,34 @@
+"use strict";
+require("typings-test");
+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 () {
+        let myDeferred = q.defer();
+        let expectPromise = smartchai_1.expect(myDeferred.promise).to.eventually.be.fulfilled;
+        myDeferred.resolve();
+        return expectPromise;
+    });
+    it('should let types flow through the Promise', function () {
+        let myString = 'someString';
+        let myDeferred = q.defer();
+        let expectPromise = smartchai_1.expect(myDeferred.promise).to.eventually.equal('someString');
+        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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUVyQix5Q0FBa0M7QUFDbEMsbUNBQWtDO0FBRWxDLElBQUksVUFBVSxHQUFHLENBQUMsVUFBa0IsRUFBRSxFQUFHO0lBQ3JDLEVBQUUsQ0FBQyxJQUFJLEVBQUUsVUFBVSxDQUFDLENBQUE7QUFDeEIsQ0FBQyxDQUFBO0FBRUQsUUFBUSxDQUFDLFFBQVEsRUFBRTtJQUNmLEVBQUUsQ0FBQyx1Q0FBdUMsRUFBRTtRQUN4QyxJQUFJLFVBQVUsR0FBRyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDMUIsSUFBSSxhQUFhLEdBQUcsa0JBQU0sQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxFQUFFLENBQUMsU0FBUyxDQUFBO1FBQ3pFLFVBQVUsQ0FBQyxPQUFPLEVBQUUsQ0FBQTtRQUNwQixNQUFNLENBQUMsYUFBYSxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBRUYsRUFBRSxDQUFDLDJDQUEyQyxFQUFFO1FBQzVDLElBQUksUUFBUSxHQUFHLFlBQVksQ0FBQTtRQUMzQixJQUFJLFVBQVUsR0FBRyxDQUFDLENBQUMsS0FBSyxFQUFVLENBQUE7UUFDbEMsSUFBSSxhQUFhLEdBQUcsa0JBQU0sQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsWUFBWSxDQUFDLENBQUE7UUFDaEYsVUFBVSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQTtRQUM1QixNQUFNLENBQUMsYUFBYSxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBRUYsRUFBRSxDQUFDLDZCQUE2QixFQUFFO1FBQzlCLElBQUksYUFBYSxHQUFHLENBQUMsQ0FBQyxTQUFTLENBQUMsVUFBVSxDQUFDLENBQUE7UUFDM0MsSUFBSSxhQUFhLEdBQUcsa0JBQU0sQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQTtRQUN6RSxNQUFNLENBQUMsYUFBYSxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBRUYsRUFBRSxDQUFDLHNCQUFzQixFQUFFO1FBQ3ZCLElBQUksVUFBVSxHQUFHLENBQUMsSUFBSSxFQUFFLFNBQVMsQ0FBQyxDQUFBO1FBQ2xDLElBQUksYUFBYSxHQUFHLENBQUMsQ0FBQyxTQUFTLENBQUMsVUFBVSxDQUFDLENBQUE7UUFDM0MsSUFBSSxhQUFhLEdBQUcsa0JBQU0sQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLFVBQVUsRUFBRSxhQUFhLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtRQUNqRyxNQUFNLENBQUMsYUFBYSxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==

test/test.ts

@@ -0,0 +1,38 @@
+import 'typings-test'
+
+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 () {
+        let myDeferred = q.defer()
+        let expectPromise = expect(myDeferred.promise).to.eventually.be.fulfilled
+        myDeferred.resolve()
+        return expectPromise
+    })
+
+    it('should let types flow through the Promise', function () {
+        let myString = 'someString'
+        let myDeferred = q.defer<string>()
+        let expectPromise = expect(myDeferred.promise).to.eventually.equal('someString')
+        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

@@ -0,0 +1,45 @@
+import 'typings-global'
+
+import * as typedPromisify from 'typed-promisify'
+
+export interface IResolve<T> {
+    (value?: T | Promise<T>): void
+}
+
+export interface IReject {
+    (reason?: any): void
+}
+
+export class Deferred<T> {
+    promise: Promise<T>
+    resolve: IResolve<T>
+    reject: IReject
+    constructor() {
+        this.promise = new Promise<T>((resolve, reject) => {
+            this.resolve = resolve
+            this.reject = reject
+        })
+    }
+}
+
+export let defer = <T>() => {
+    return new Deferred<T>()
+}
+
+/**
+ * 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