Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aliencreations/alien-node-q-utils
Helper functions for Q on NodeJS
https://github.com/aliencreations/alien-node-q-utils
Last synced: 28 days ago
JSON representation
Helper functions for Q on NodeJS
- Host: GitHub
- URL: https://github.com/aliencreations/alien-node-q-utils
- Owner: AlienCreations
- License: mit
- Created: 2015-07-22T23:55:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-09-13T21:23:57.000Z (over 1 year ago)
- Last Synced: 2024-12-06T15:51:45.026Z (about 2 months ago)
- Language: JavaScript
- Size: 25.4 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# alien-node-q-utils
Helper functions for promises with Q on NodeJS. The functions are pure and curried with Ramda.
[](https://travis-ci.org/AlienCreations/alien-node-q-utils) [](https://coveralls.io/github/AlienCreations/alien-node-q-utils?branch=master) [](https://npmjs.org/package/alien-node-q-utils) [](https://david-dm.org/AlienCreations/alien-node-q-utils)
## Install
```
$ npm install alien-node-q-utils --save
```
Run the specs
```
$ npm test
```
## Methods
#### rejectedPromise
A pre-rejected promise that throws the rejection into an expected `catch` block.
```js
it('should pre-reject a promise', function(done) {
rejectedPromise('foo')
.catch(function(err) {
expect(err).toBe('foo');
done();
})
});
```
#### resolvedPromise
A pre-resolved promise that passes the resolution into the expected `then` block.
```js
it('should pre-resolve a promise', function(done) {
resolvedPromise('foo')
.then(function(data) {
expect(data).toBe('foo');
done();
})
});
```
#### rejectOnErrorOrResolve
Given a function signature of `fn(deferred, err, data)` this will reject `deferred` if `err` is provided,
otherwise resolve `deferred` with `data`.
- Don't forget this function is curried, so the arity must be recognized. (If you omit the `data` param, you will get a function that accepts only the `data` param.)
```js
var mockPromiseNoError = function(resolveWith) {
var deferred = Q.defer();
rejectOnErrorOrResolve(deferred, undefined, resolveWith);
return deferred.promise;
};
var mockPromiseWithError = function(err) {
var deferred = Q.defer();
rejectOnErrorOrResolve(deferred, err, undefined);
return deferred.promise;
};
it('should resolve if no error is provided', function(done) {
var deferred = Q.defer();
mockPromiseNoError('foo')
.then(function(data) {
expect(data).toBe('foo');
done();
});
});
it('should reject if error is provided', function(done) {
var deferred = Q.defer();
mockPromiseWithError('foo')
.catch(function(err) {
expect(err).toBe('foo');
done();
});
});
```
## TODO
- Need specs and descriptions for new mapP methods