Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
alagator
Advanced tools
Readme
Write algorithms that can be re-used for synchronous and asynchronous code using promises and yield
npm install alagator
A fully backwards compatible version of @substack's mkdirp but without writing the algorithm out twice:
var path = require('path')
var fs = require('fs')
var Promise = require('promise')
var alagator = require('alagator')
module.exports = mkdirpFactory(true, Promise.denodeify(fs.mkdir), Promise.denodeify(fs.stat))
module.exports.sync = mkdirpFactory(false, fs.mkdirSync, fs.statSync)
module.exports.mkdirp = module.exports.mkdirP = module.exports
function mkdirpFactory(async, mkdir, stat) {
var rec = alagator(function *(p, mode, made) {
if (mode === undefined) {
mode = 0777 & (~process.umask());
}
if (!made) made = null;
if (typeof mode === 'string') mode = parseInt(mode, 8);
p = path.resolve(p);
try {
yield mkdir(p, mode);
made = made || p;
}
catch (err0) {
switch (err0.code) {
case 'ENOENT' :
made = yield rec(path.dirname(p), mode, made);
yield rec(p, mode, made);
break;
// In the case of any other error, just see if there's a dir
// there already. If so, then hooray! If not, then something
// is borked.
default:
var stat;
try {
stat = yield stat(p);
}
catch (err1) {
throw err0;
}
if (!stat.isDirectory()) throw err0;
break;
}
}
return made;
}, async)
return rec
}
isAsync defaults to true
.
The alagator
method takes a generator function, and then either true
(for async) or false
(for sync). If false
is passed, it makes yield
act as a pass through, so the method runs fully synchronously. If true
is passed, it makes yield
await the resolution of a promise (or array of promises) so that the function becomes async (it also uses Promise.nodeify
to support both callback and promise based use). The above mkdirp example could be used in any of the following 3 ways:
var mkdirp = require('mkdirp')
mkdirp('/foo/bar', function(err) {
if (err) throw err
console.log('/foo/bar exists')
})
//or
mkdirp('/foo/bar')
.then(function() {
console.log('/foo/bar exists')
})
.done()
//or
mkdirp.sync('/foo/bar')
console.log('/foo/bar exists')
Exactly as above, except the function is immediately called with no arguments.
If you want the promise returned from async versions of your algorithms to be of a specific type (other than promise) we've got you covered. Simply pass a wrap function in place of true
:
var Q = require('q')
module.exports = mkdirpFactory(Q, Q.denodeify(fs.mkdir), Q.denodeify(fs.stat))
module.exports.sync = mkdirpFactory(false, fs.mkdirSync, fs.statSync)
This will still make use of the same promise library internally, but externally will exclusively use Q.
MIT
FAQs
Write algorithms that can be re-used for synchronous and asynchronous code
The npm package alagator receives a total of 1 weekly downloads. As such, alagator popularity was classified as not popular.
We found that alagator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.