Compare commits

...

5 Commits

Author SHA1 Message Date
6a4ee22f36 1.0.4 2017-01-21 00:45:14 +01:00
e23f946e50 improve upon smartq 2017-01-21 00:45:11 +01:00
8d62fc6ef1 improve README 2017-01-20 22:01:10 +01:00
e39ad3b19b 1.0.3 2017-01-20 21:58:56 +01:00
7220959662 ad better readme and some more functions 2017-01-20 21:58:53 +01:00
5 changed files with 69 additions and 7 deletions

View File

@ -21,4 +21,40 @@ dropin replacement for q
## Usage ## Usage
Use TypeScript for best in class instellisense. 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'
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();
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)
})
```
[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks) [![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

9
dist/index.d.ts vendored
View File

@ -12,4 +12,11 @@ export declare class Deferred<T> {
constructor(); constructor();
} }
export declare let defer: <T>() => Deferred<T>; 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>;

14
dist/index.js vendored
View File

@ -12,6 +12,16 @@ exports.Deferred = Deferred;
exports.defer = () => { exports.defer = () => {
return new Deferred(); 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);
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBVXZCO0lBSUk7UUFDSSxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksT0FBTyxDQUFJLENBQUMsT0FBTyxFQUFFLE1BQU07WUFDMUMsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUE7WUFDdEIsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUE7UUFDeEIsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDO0NBQ0o7QUFWRCw0QkFVQztBQUVVLFFBQUEsS0FBSyxHQUFHO0lBQ2YsTUFBTSxDQUFDLElBQUksUUFBUSxFQUFLLENBQUE7QUFDNUIsQ0FBQyxDQUFBO0FBRUQ7O0dBRUc7QUFDUSxRQUFBLGVBQWUsR0FBRyxDQUFJLEtBQVM7SUFDdEMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUE7QUFDakMsQ0FBQyxDQUFBO0FBRUQ7O0dBRUc7QUFDUSxRQUFBLGVBQWUsR0FBRyxDQUFDLEdBQUc7SUFDN0IsTUFBTSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUE7QUFDOUIsQ0FBQyxDQUFBIn0=

View File

@ -1,6 +1,6 @@
{ {
"name": "smartq", "name": "smartq",
"version": "1.0.2", "version": "1.0.4",
"description": "dropin replacement for q", "description": "dropin replacement for q",
"main": "dist/index.js", "main": "dist/index.js",
"typings": "dist/index.d.ts", "typings": "dist/index.d.ts",

View File

@ -24,7 +24,16 @@ export let defer = <T>() => {
return new Deferred<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)
} }