Registry / http-networking / install

install

JSON →
library0.13.0jsnpmunverified

Install.js is a minimal JavaScript module loader designed primarily to deliver CommonJS modules to web browsers, addressing the challenge of synchronous `require` semantics in a browser environment. While it provides a feature-rich, small-footprint solution for its original purpose, its development has been inactive since its last update in 2018 (version 0.13.0). The package offers explicit control over module installation and resolution, including options for file extensions, package.json `mainFields`, and a `fallback` mechanism for unresolved modules. It was created in an era before modern bundlers (like Webpack, Rollup) and native ECMAScript Modules (ESM) became standard practice, making its direct use in new projects less common today.

http-networking
npm install install
github ↗package ↗
INSTALL
IMPORT
SIG · INSTALL
I
install
http-networkingjavascriptv0.13.0
Install
—
Import
—
Disk
—
Pass rate
0/ 6
Env Coverage0 / 6
glibc
18–22
musl
18–22
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18–226 runs
build_error
glibc
node 18–226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

makeInstaller
✓ const install = require('install').makeInstaller;
✗ import { makeInstaller } from 'install';
This package is CommonJS-first. ESM `import` syntax is not directly supported without a transpiler or bundler.
install
✓ const installFn = require('install').makeInstaller({...});
✗ const installFn = require('install');
The primary `install` function is the *return value* of `makeInstaller`, not directly exported by the package.
require (from installed modules)
✓ const localRequire = installFn({...}); localRequire('./my-module');
✗ require('./my-module');
The `require` function within installed modules is local to the `install` function's context, not the global Node.js `require` or browser global. Be careful not to overwrite the global `require` in Node.js.

This quickstart demonstrates how to initialize the `install` module loader, define and install custom CommonJS modules, and then `require` them using the loader's context. It shows the three main steps: `makeInstaller`, `install`, and `require`.

const makeInstaller = require('install').makeInstaller; // Step 1: Create an install function with optional configurations const install = makeInstaller({ extensions: [".js", ".json"], // fallback: (id) => { /* custom resolution logic, e.g., native Node.js require */ }, browser: typeof window !== 'undefined', mainFields: ["browser", "main"] }); // Step 2: Install modules using a nested object tree const localRequire = install({ "main.js"(require, exports, module) { const assert = require("assert"); // Example: requiring a module within the installed context assert.strictEqual( require("package").name, "/node_modules/package/entry.js" ); exports.name = module.id; }, node_modules: { package: { "package.json"(require, exports, module) { exports.name = "package"; exports.version = "0.1.0"; exports.main = "entry.js"; }, "entry.js"(require, exports, module) { exports.name = module.id; } } } }); // Step 3: Require the entry point module(s) to evaluate them console.log(localRequire("./main").name); // Expected output: "/main.js"
Debug
Known issues
breakingThe package's primary purpose—loading CommonJS modules directly in browsers—has been largely superseded by modern JavaScript bundlers (Webpack, Rollup, Parcel) and native ECMAScript Modules (ESM). Using `install` in new projects may introduce unnecessary complexity or reliance on an older module paradigm.
fix
For new projects, consider modern bundlers for CommonJS/ESM compatibility or use native ESM. For legacy CommonJS in browsers, evaluate if a bundler could simplify the build process.
affects: >=0.1.0
gotchaIn a Node.js environment, the `install` package creates its own `require` context. Directly assigning the result of `install()` to a global `require` variable (e.g., `require = install(...)`) can overwrite Node.js's native `require` function, leading to unexpected behavior or breakage for built-in modules.
fix
Always assign the result of `install()` to a locally scoped variable (e.g., `const myRequire = install(...)`) to avoid conflicts with Node.js's native module system.
affects: >=0.1.0
gotchaThe package has not seen updates since 2018 (version 0.13.0). This indicates it is no longer actively maintained. Relying on it for critical applications might pose long-term maintenance or security risks, as it may not receive updates for new JavaScript features, bug fixes, or security vulnerabilities.
fix
Assess the necessity of this package. If possible, migrate to actively maintained alternatives or modern bundling solutions that are compatible with CommonJS for long-term project health.
affects: >=0.13.0
Errors
Common errors & fixes
ReferenceError: require is not defined
Attempting to use `require` in a browser environment without `install.js` being loaded and initialized, or before the `makeInstaller` and `install` steps have provided a local `require` function. CommonJS `require` is not native to browsers.
fix
Ensure `install.js` (or a bundled version) is correctly loaded in your HTML, and that `makeInstaller` and the subsequent `install` calls have been executed to create the `require` function for your modules.
Error: Cannot find module 'some-module'
This error occurs when the `install` loader cannot resolve a module identifier. This could be due to an incorrect path, the module not being explicitly 'installed' via the `install` function's object tree, or misconfiguration of `extensions` or `mainFields` in `makeInstaller`.
fix
Verify the module identifier path is correct relative to the calling module. Ensure the module is present in the object tree passed to `install`. Check `makeInstaller` options, especially `extensions` for implicit file endings and `mainFields` for `package.json` resolution.
module.exports = ... or exports.property = ... is not working as expected with `import` statements.
The `install` package implements a CommonJS-like module system. While it uses `exports` and `module.exports`, these are not directly compatible with native ECMAScript `import` statements without an intermediate bundling or transpilation step.
fix
This package is designed for CommonJS. If you are in an ESM context, you would typically use a bundler (like Webpack) that understands both CJS and ESM to integrate modules handled by `install`. If sticking to `install`, use `require()` within its defined module contexts.
Upgrade
Version history
0.13.0latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
4 hits · last 30 days
node
4
Resources
githubhttps://github.com/benjamn/install ↗
packagehttps://www.npmjs.com/package/install ↗
install — npm install install · libregistry