npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vm-jumpstart

v0.0.0

Published

Easily initialize a JS VM with a set of js files in addition to the initSandbox

Downloads

4

Readme

vm-jumpstart

Easily initialize a JavaScript VM with a set of (asynchronously read) js files in addition to the initSandbox.

Dependencies/Libraries

Node.js - server-side JS platform (vers. >= 0.10.x should work fine)

bluebird - JavaScript Promises library

Why?

Node's javascript VMs probably need to be loaded up with js from a bunch of files on disk often enough.

Some might find dealing with the asynchronous parts of reading multiple files from disk and loading them into a VM via vm.runInContext(code, context, [filename]) after running vm.createContext([initSandbox]) slightly tedious. Since synchronous filereads are evil (block the entire application while they're happening), this small library streamlines doing it asynchronously.

Caveats

This library's functionality is asynchronous. That's a good thing, but it means you'll need to receive the generated VM in a callback function.

Installation and Usage

Enter your existing node project's directory.

Install the node module as a dependency (and save the dependency to package.json):

npm install vm-jumpstart --save

In your code, you'll need to require vm-jumpstart. You'll want create a config object that meets your needs. You'll also want some callback to access to vmContext you're generating.

var jumpstartVM = require('vm-jumpstart').jumpstart;

var vmConfig = {
        initSandbox: { //optional - defaults to {}
            // setup your vm sandbox
            // http://nodejs.org/api/vm.html#vm_vm_createcontext_initsandbox
        },
        srcFilepaths: [
            // insert absolute filepaths for your code, in the order in which they should be loaded into the vm
            // e.g. "/home/usr/blah/blah/bah/srcfileA.js",
            //      "/home/usr/blah/blah/bah/srcfileB.js"
        ],
        stacktraceFileNamer: function(filepath) { //optional - defaults to showing just the filename and extension
          // function to detemine how each filepath for loaded code is formatted in any errors in the vm
          return filepath; //e.g. show full filepath
    	}
    }
};

jumpstartVM(vmConfig, function callback(err, vmObj) {
	// if there were no errors:
	//   vmObj.vmConfig should contain the vmConfig that was passed to jumpstart (with some normalization)
	//   vmObj.vmContext should contain the vm context that was generated -- which you probably want to interract with

	// you're on your own with what you want to do with the vm
});

Testing

There's not a lot happening in the tests, but they can serve as a mini-demo, if nothing else. You can run them by going to the node_module directory for vm_jumpstart and running:

npm test

License

MIT