Skip to content

kawanet/promisen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

promisen.js npm version Build Status

promisen.js creates promise-returning functions. ready for ES6 Promise.

Usage

var promisen = require("promisen");

var joinedTask = promisen(func, promise, thenable, object);

joinedTask(initialValue).then(function(result) {...});

Functions

Following functions are available to create promise-returning functions. See documentation for more details.

// Basic functions
promisen(...task);
promisen.if(condTask, trueTask, falseTask);
promisen.while(condTask, ...runTask);
promisen.throttle(task, concurrency, timeout);
promisen.timeout(task, msec);
promisen.wait(msec);

// Async.js-style functions
promisen.waterfall(tasks);
promisen.parallel(tasks);
promisen.series(tasks);
promisen.each(arrayTask, iteratorTask);
promisen.eachSeries(arrayTask, iteratorTask);
promisen.memoize(task, expire, hasher);

// Node-style callback from/to Promise-style
promisen.nodeify(task);
promisen.denodeify(task);

// Array manipulation
promisen.pop(array);
promisen.push(array);

// Counter
promisen.incr(array);
promisen.decr(array);

// Console output
promisen.log(prefix);
promisen.warn(prefix);

// Promise proxy
promisen.resolve(value);
promisen.reject(reason);

For Node.js

npm install --save promisen

For Browser

Minified version promisen.min.js does NOT include es6-promise.min.js. It is required for most browsers which do NOT implement Promise yet.

<script src="https://raw.githubusercontent.com/jakearchibald/es6-promise/master/dist/es6-promise.min.js"></script>
<script src="https://raw.githubusercontent.com/kawanet/promisen/master/dist/promisen.min.js"></script>

Repository

See Also

License

The MIT License (MIT)

Copyright (c) 2015 Yusuke Kawasaki

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

promisen.js creates promise-returning functions. ready for ES6 Promise.

Resources

License

Stars

Watchers

Forks

Packages

No packages published