Skip to content

link-foundation/use-m

Repository files navigation

npm License

Open in Gitpod Open in GitHub Codespaces

use-m: dynamically import any JavaScript module anywhere

use-m (m stands for module) is a utility for dynamically importing any JavaScript module (npm package) at runtime anywhere (browser or server).

It may be useful for standalone scripts that do not require a package.json. Also it may make your code portable across environments (for example it may require no changes in your code when executed in CommonJS, ES Modules and browser). You can ensure predictable behavior of your code over time by specifying the exact version to import directly in your script, similar to how versions are specified in package.json. You even can import multiple versions of the same library at the same time. You can use use-m when you don't want your package.json to be poluted with optional packages. You may keep your package.json with as little dependencies as needed thanks to use-m.

ray-so-export-2

Table of Contents

Key features

  • Dynamic package loading: In node.js, use-m loads and imports npm packages on-demand with global installation (using npm i -g with separate alias for each version), making them available across projects and reusable without needing to reinstall each time. In case of a browser use-m loads npm packages directly from CDNs (by default esm.sh is used).
  • Version-safe imports: Allows multiple versions of the same library to coexist without conflicts, so you can specify any version for each import (usage) without affecting other scripts or other usages (imports) in the same script.
  • No more require, import, or package.json: With use-m, traditional module loading approaches like require(), import statements, and package.json dependencies become effectively obsolete. You can dynamically load any module at runtime without pre-declaring dependencies in separate file. This enables truly self-contained .mjs files that can effectively replace shell scripts.
  • Built-in modules emulation: Provides emulation for Node.js built-in modules across all environments (browser, Node.js, Bun, Deno), ensuring consistent behavior regardless of the runtime.
  • Relative path resolution: Supports ./ and ../ paths for loading local JavaScript and JSON files relative to the executing file, working seamlessly even in browser environments.

Usage

Universal

Works in CommonJS, ES Modules and browser, and interactive environments.

fetch('https://unpkg.com/use-m/src/use.js')
  .then(async useJs => {
    const { use } = eval(await useJs.text());
    const _ = await use('lodash@4.17.21');
    console.log(`_.add(1, 2) = ${_.add(1, 2)}`);
  });

Universal execution comes at cost of eval usage, that is considered potential security threat. In case of this library only single file is evaled, it short, unminified and has no dependencies, so you can check the contents yourself. Once you have use function instance no more eval function will be executed by this library. If you don't want to use eval you can use await import() in browser or in node.js. In node.js you can also just install the package from npm as usual.

Robust loading (resilient CDN bootstrap)

The minimal one-liner above is convenient, but it trusts the CDN to always return the module source. When a CDN hiccups and responds with an error body — for example the plain text Internal Server Error or an HTML error page — eval() tries to parse that text as JavaScript and throws a cryptic, misleading error:

SyntaxError: Unexpected identifier 'Server'

The error points at the eval line with no hint that the real cause is a transient network/CDN failure (see #58). For long-running scripts, CI jobs, or anything you want to be resilient, use a loader that validates each response before eval(), retries, and falls back across multiple CDN mirrors.

Option 1 — the packaged helper (use-m/load). When use-m is installed, import the loader that ships with the package:

import { loadUseM } from 'use-m/load';        // ES Modules
// const { loadUseM } = require('use-m/load'); // CommonJS

const { use } = await loadUseM();
const _ = await use('lodash@4.17.21');
console.log(`_.add(1, 2) = ${_.add(1, 2)}`);

loadUseM() validates the HTTP status and the response body before evaluating it, retries each source, falls back across unpkgjsDelivresm.sh, and — when every mirror fails — throws a clear error listing every attempt instead of a SyntaxError. It accepts options to customize the behavior:

const { use } = await loadUseM({
  sources: ['https://unpkg.com/use-m/src/use.js', 'https://cdn.jsdelivr.net/npm/use-m/src/use.js'],
  maxAttemptsPerSource: 3,  // attempts per mirror before moving on
  retryDelayMs: 250,        // linear backoff between attempts
  timeoutMs: 10000,         // per-attempt timeout (0 disables)
});

Option 2 — self-contained snippet (no install). For standalone scripts that fetch use-m directly, drop in this dependency-free loader. It does the same validation and mirror fallback inline:

async function loadUse(sources = [
  'https://unpkg.com/use-m/src/use.js',
  'https://cdn.jsdelivr.net/npm/use-m/src/use.js',
  'https://esm.sh/use-m/src/use.js',
]) {
  const failures = [];
  for (const url of sources) {
    try {
      const response = await fetch(url);
      if (!response.ok) throw new Error(`HTTP ${response.status} ${response.statusText || ''}`.trim());
      const source = await response.text();
      // Guard against CDN error bodies (HTML pages, "Internal Server Error", …)
      // that eval() would choke on. The real module is large and references `use`.
      if (source.length < 256 || source.trimStart().startsWith('<') || !source.includes('use')) {
        throw new Error(`unexpected response body: "${source.slice(0, 80).replace(/\s+/g, ' ').trim()}"`);
      }
      const exported = eval(source);
      if (!exported || typeof exported.use !== 'function') throw new Error('module did not export a `use` function');
      return exported.use;
    } catch (error) {
      failures.push(`${url}: ${error.message}`);
    }
  }
  throw new Error('Failed to load use-m from every CDN mirror:\n  - ' + failures.join('\n  - '));
}

const use = await loadUse();
const _ = await use('lodash@4.17.21');
console.log(`_.add(1, 2) = ${_.add(1, 2)}`);

Runnable versions of both options live in examples/load.

Resilient package loading (shared fallback engine)

The resilience above is not limited to bootstrapping use-m itself — once you have a use function, the packages you load are resilient too. When use() fetches a package over the network (in the browser, in Deno, or from an http(s) entry point) it now tries a chain of independent CDN hosts and falls back automatically, so a single CDN outage no longer breaks use():

Runtime / entry point Mirror chain tried in order
Browser / http(s) script esm.shjspm.devcdn.skypack.dev
Deno esm.sh (deno target) → jspm.devcdn.skypack.dev
Node.js (npm i -g), Bun unchanged — single local resolver, no network fallback

If every mirror fails, use() throws one clear, aggregated error listing each attempt instead of the cryptic error from a single failing host:

Failed to import 'left-pad@1.3.0' from any CDN mirror.
Attempts:
  - esm (attempt 1/1): <reason>
  - jspm (attempt 1/1): <reason>
  - skypack (attempt 1/1): <reason>

You can override the chain (or inject a custom resolver) per use instance:

import { makeUse } from 'use-m';        // ES Modules
// const { makeUse } = require('use-m'); // CommonJS

const use = await makeUse({
  // Try these resolvers in order, falling back on failure. Entries are resolver
  // names (built-ins: 'esm', 'jspm', 'skypack', 'jsdelivr', 'unpkg', 'deno', …)
  // or your own `(specifier, pathResolver) => url` functions.
  specifierResolvers: ['esm', 'jspm', 'skypack'],
});

One mechanism, reused everywhere. Both the use-m/load bootstrap and per-package loading are powered by the same generic loadWithFallback engine — "try each source in order, optionally retry, and fail with one aggregated error." It is exported so you can reuse it for your own resilient loading:

import { loadWithFallback } from 'use-m';

const data = await loadWithFallback(
  ['https://primary.example/api', 'https://backup.example/api'],
  async (url) => {
    const response = await fetch(url);
    if (!response.ok) throw new Error(`HTTP ${response.status}`);
    return response.json();
  },
  {
    maxAttemptsPerSource: 3,  // attempts per source before moving on
    retryDelayMs: 250,        // linear backoff between attempts (0 disables)
    label: 'fetch config from any endpoint',
    hint: 'Check your network connection and try again.',
  },
);

A runnable, dependency-free demonstration lives in examples/load/shared-fallback-engine.mjs.

Interactive shell in Node.js environment

  1. Get the use function from use-m package:

    Single line version:

    const { use } = eval(await (await fetch('https://unpkg.com/use-m/src/use.js')).text());

    This minimal form is fine for an interactive REPL. For scripts that should survive a flaky CDN, prefer the resilient loader from Robust loading — otherwise a CDN error body makes eval() throw a cryptic SyntaxError (#58).

    Screenshot 2025-07-25 at 2 21 28 AM

    Formatted multiple version:

    const { use } = eval(
      await (
        await fetch(
          'https://unpkg.com/use-m/src/use.js'
        )
      ).text()
    );
  2. Import your favorite NPM package from the registry (for example lodash):

    const _ = await use('lodash@4.17.21');
  3. Use your favorite function from dynamically imported package (for example add):

    _.add(1, 2)

Your output should be similar to the next screenshot.

Screenshot 2025-02-19 at 1 58 57 AM

Browser

If you don't want to use eval in the browser, you can import use-m like this:

const { use } = await import("https://esm.sh/use-m");
const _ = await use('lodash@4.17.21');
console.log(`_.add(1, 2) = ${_.add(1, 2)}`);

Only 2 lines and now have an interactive playground for JavaScript and almost any NPM library directly in your browser's console. No more cloud based sandboxes required. Sorry VSCode, you don't have such super powers yet.

Deno

use-m works seamlessly with Deno! It automatically detects the Deno runtime and uses esm.sh as the default CDN.

// Import use-m from CDN
const { use } = await import('https://esm.sh/use-m');

// Use any npm package
const _ = await use('lodash@4.17.21');
console.log(`_.add(1, 2) = ${_.add(1, 2)}`);

// Import multiple packages
const [lodash3, lodash4] = await use.all('lodash@3', 'lodash@4');

Run with Deno:

deno run --allow-net example.mjs

Bun

use-m works seamlessly with Bun! It automatically detects the Bun runtime and provides optimized module loading.

// Import use-m from CDN
const { use } = await import('https://esm.sh/use-m');

// Use any npm package
const _ = await use('lodash@4.17.21');
console.log(`_.add(1, 2) = ${_.add(1, 2)}`);

// Import multiple packages
const [lodash3, lodash4] = await use.all('lodash@3', 'lodash@4');

Run with Bun:

bun run example.mjs

Network imports

It is possible to use --experimental-network-imports to enable the same style of imports as in browser version. See the example.

  1. Create file named example.mjs:

    const { use } = await import('https://unpkg.com/use-m/src/use.mjs');
    const _ = await use('lodash@4.17.21');
    console.log(`_.add(1, 2) = ${_.add(1, 2)}`);
  2. Execute the script using --experimental-network-imports option:

    node --experimental-network-imports example.mjs

Independent Scripts

If you need to use use-m without adding it to a project locally, you can load it directly from unpkg using fetch. This is particularly useful for creating self-contained scripts without any package.json, node_modules, etc.

use-m and command-stream

command-stream is a modern shell utility library with streaming, async iteration, and EventEmitter support. It provides the most advanced command execution capabilities including virtual commands, built-in cross-platform commands, and real-time streaming.

  1. Create a file named example.mjs:

    const { use } = eval(
      await fetch('https://unpkg.com/use-m/src/use.js').then(u => u.text())
    );
    
    const { $ } = await use('command-stream');
    const _ = await use('lodash');
    
    // Use command-stream's advanced features
    for await (const chunk of $`ls -la`.stream()) {
      if (chunk.type === 'stdout') {
        const files = chunk.data.toString();
        console.log('Files:', _.filter(files.split('\n'), f => f.includes('.js')));
      }
    }
    
    // Built-in cross-platform commands
    await $`mkdir -p build`;
    await $`echo "Build complete" > build/status.txt`;
  2. Execute:

    node example.mjs

use-m and Bun.$

Bun provides a built-in $ shell API that works seamlessly with use-m:

  1. Create a file named example.mjs:

     #!/usr/bin/env bun
    
    const { use } = eval(
      await fetch('https://unpkg.com/use-m/src/use.js').then(u => u.text())
    );
    
    const _ = await use('lodash');
    
    // Use Bun's built-in $ directly
    const { stdout } = await $`ls`.pipe($`grep js`);
    const files = _.filter(
      _.split(stdout.toString(), '\n'),
      (item) => !_.isEmpty(item)
    );
    console.log(files);
  2. Execute with Bun:

    bun run example.mjs

use-m and zx

  1. Install zx globally

    npm install -g zx
  2. Create a file named example.mjs:

    #!/usr/bin/env zx --verbose
    
    const { use } = eval(
      await fetch('https://unpkg.com/use-m/src/use.js').then(u => u.text())
    );
     
    const _ = await use('lodash@latest');
    
    const { stdout } = await $`ls`.pipe`grep js`;
    const files = _.filter(
      _.split(stdout, '\n'),
      (item) => !_.isEmpty(item)
    );
    console.log(files);
  3. Give execution permissions

    chmod +x example.mjs
  4. Execute:

    ./example.mjs

use-m and execa

  1. Create a file named example.mjs:

    #!/usr/bin/env node
    
    const { use } = eval(
      await fetch('https://unpkg.com/use-m/src/use.js').then(u => u.text())
    ); 
    
    const _ = await use('lodash');
    const { $: $$ } = await use('execa');
    const $ = $$({ verbose: 'full' }); 
    
    const { stdout } = await $`ls`.pipe`grep js`;
    const files = _.filter(
      _.split(stdout, '\n'),
      (item) => !_.isEmpty(item)
    );
    console.log(files);

Note: in ES Module environments where __filename and require are not defined, you may need to add meta option into use function constructor, as it is not possible to access import.meta inside eval.

  1. Execute:

    node example.mjs

Standard Import

You can still install and import use-m in node.js as usual. For example if you don't want to use eval in node.js.

Installation

Add use-m to your project with Yarn:

yarn add use-m

Or NPM:

npm i use-m

Load use-m to dynamically import the lodash package from npm:

CommonJS

const { use } = require('use-m');

(async () => {
  const _ = await use('lodash@4.17.21');
  console.log(`_.add(1, 2) = ${_.add(1, 2)}`);
})();

or

import('use-m')
  .then(async ({ use }) => {
    const _ = await use('lodash@4.17.21');
    console.log(`_.add(1, 2) = ${_.add(1, 2)}`);
  });

ES Modules

import { use } from 'use-m';

const _ = await use('lodash@4.17.21');
console.log(`_.add(1, 2) = ${_.add(1, 2)}`);

or

const { use } = await import('use-m');

const _ = await use('lodash@4.17.21');
console.log(`_.add(1, 2) = ${_.add(1, 2)}`);

Security Considerations

Arbitrary Code Execution

Important: When using use-m with npm/bun resolvers in Node.js or Bun environments, packages are installed globally using npm install -g or bun add -g. This means:

  • Install scripts are executed: npm packages can run arbitrary code during installation via install scripts
  • Trust required: Only use packages from trusted sources
  • Malicious packages: A compromised or malicious package could execute harmful code on your system

Best Practices

  1. Pin versions: Always specify exact versions instead of using latest:

    // Good - specific version
    const _ = await use('lodash@4.17.21');
    
    // Risky - could download new, potentially compromised version
    const _ = await use('lodash@latest');
  2. Trust your dependencies: Only import packages from trusted maintainers and npm organizations

  3. Use CDN resolver in untrusted environments: For browser or Deno environments, packages are loaded from CDNs without running install scripts:

    // Browser - loads from CDN, no install scripts
    const { use } = await import("https://unpkg.com/use-m/src/use.mjs");
    const _ = await use('lodash@4.17.21');
  4. Review package contents: Check package source code before using, especially for critical applications

  5. Use in development/scripts: use-m is ideal for development scripts, exploratory coding, and rapid prototyping where convenience outweighs strict security requirements

CDN Security

When using CDN resolvers (browser, Deno), be aware that:

  • CDN compromise: If a CDN is compromised, malicious code could be served
  • No integrity checking: By default, there's no Subresource Integrity (SRI) verification
  • Network dependency: Your application depends on CDN availability

Eval Security

Some examples use eval() for convenience in interactive shells and browsers. Be aware:

  • eval() executes arbitrary code
  • Only use with trusted sources
  • The use-m library code is short, unminified, and has no dependencies - you can review it yourself
  • For production code, prefer standard imports without eval()

Recommendations by Use Case

Use Case Recommendation Security Level
Development scripts ✅ Safe to use Medium
Rapid prototyping ✅ Safe to use Medium
Interactive shell/REPL ✅ Safe to use Medium
Production applications ⚠️ Use with caution Low-Medium
Security-critical apps ❌ Not recommended Low

Examples

You can check out usage examples source code. You can also explore our tests to get even more examples.

Questions and issues

If you have any questions or issues, please write us on GitHub. Together we can ensure this package will have highest quality possible. Your feedback is valuable and helps improve the project.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for detailed guidelines on:

  • Setting up the development environment
  • Running tests across different runtimes
  • Code style and standards
  • Submitting pull requests

For quick contributions, feel free to open a Pull Request with your suggested changes.

License

This project is licensed under the Unlicense (public domain). That means you are absolutely free to use this library, there is no conditions or limitations on how this library and its code can be used.

About

use-m: dynamically download & import any JavaScript module

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors