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

asar-bundle-runner

v1.6.0

Published

AsarBundleRunner (abbrev. ABR) is a simple way to extend your program's functionality through plugins with ASAR bundles!

Downloads

95

Readme

Asar Bundle Runner

AsarBundleRunner (abbrev. ABR) is a simple way to extend your program's functionality through plugins with ASAR bundles!

Disclaimer

I am not responsible for any shenanigans or tomfoolery related to your computer being infected with a virus. Don't trust random sources as this code will run and once damage is done, there may be no going back.

Setting up ABR

Your .asar bundle file tree can look any way, as long as it has these core components.

asarbundle:
  - entrypoint.js
  - config.js
  - package.json

These asar bundles are node projects, thus they will have a package.json. This needs to be setup accordingly.

Your package.json's main should be your config.js file.

Inside of config.js you'll want this:

module.exports = {
  entrypoint: 'entrypoint.js' // This can be replaced as long as this file actually exists.
}

There's a little bit of setup with entrypoint.js however. It needs to be a module as well. See example below.

module.exports = {
  exec: () => {
    console.log('Change this and add your own code!')
  }
}

Using ABR

Using ABR is extremely simple. Here's examples of how to use it.

Simple Example:

const abr = require('asar-bundle-runner');

abr.extract('MyCoolBundle.asar'); // This loads the bundle into memory and extracts it.

abr.run('MyCoolBundle.asar'); // This actually *runs* the bundle.

Advanced Example

const abr = require('asar-bundle-runner');

abr.extract('MyCoolBundle.asar'); // This loads the bundle into memory and extracts it.

abr.modules['MyCoolBundle.asar'].exec(); // This accesses the direct `entrypoint.js` contents.

// You could even do something like
abr.modules['MyCoolBundle.asar'].myParameter // this must exist in `entrypoint.js`'s module.exports