1.0.3 • Published 10 years ago

nsp-audit-shrinkwrap v1.0.3

Weekly downloads
41
License
MIT
Repository
github
Last release
10 years ago

nsp-audit-shrinkwrap

nsp-audit-shrinkwrap offers a simple library to audit your shrinkwrap or a stream of shrinkwraps.

Badgers

NPM

Dependency StatusGitter(https://badges.gitter.im/Join Chat.svg)

Single npm-shrinkwrap.json

var nspShrinkwrap  = require('nsp-audit-shrinkwrap');
var shrinkwrapPath = '/path/to/npm-shrinkwrap.json'
var shrinkwrapFile = fs.readFileSync(shrinkwrapPath);


nspShrinkwrap.audit(shrinkwrapFile, function (err, results){
    console.log(results);
};

nspShrinkwrap.auditByPath(shrinkwrapPath, function (err, results){
    console.log(results);
};

Stream of npm-shrinkwrap.json

var auditStream = nspShrinkwrap.auditStream();
var results = [];

auditStream.shrinkwrap.write(shrinkwrap1);
auditStream.shrinkwrap.write(shrinkwrap2);
//... how many shrinkwraps you want

setTimeout(function(){
    auditStream.shrinkwrap.end(); // you close the stream whenever you want :)
}, 3000);

auditStream.results.on('_data', function (data){
    results.push(data);
});

auditStream.results.on('_end', function (){
    console.log(results);
});