Registry / web-framework / expose-loader

expose-loader

JSON →
library5.0.1jsnpmunverified

A webpack loader that exposes a module (in whole or in part) to the global object (window/global/self). Current stable version is 5.0.1, with regular maintenance releases. It is part of the webpack-contrib org and the recommended shimming solution for exposing third-party libraries to global scope. Key differentiators: supports granular exposure of specific exports, multiple global names, and override control. Alternative approaches like ProvidePlugin only add variables to modules, while this loader actually attaches to the global object for browser compatibility.

web-framework
npm install expose-loader
github ↗package ↗
INSTALL
IMPORT
SIG · EXPOSE-LOADER
E
expose-loader
web-frameworkjavascriptv5.0.1
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.

expose-loader
✓ import $ from "expose-loader?exposes=$,jQuery!jquery"
✗ require("expose-loader?exposes=$,jQuery!jquery")
Inline syntax is ESM-import based; CommonJS require may not work as expected because the loader returns the exposed module.
Loader usage in webpack config
✓ module.exports = { module: { rules: [ { test: require.resolve('jquery'), loader: 'expose-loader', options: { exposes: ['$', 'jQuery'] } } ] } }
✗ Using 'expose-loader' without require.resolve or with incorrect test pattern
Use require.resolve to target a specific module path; avoid generic regex tests like /node_modules/.
exposes option with moduleLocalName
✓ import { map } from "expose-loader?exposes=_.map|map!underscore"
✗ import * as underscore from "expose-loader?exposes=_.map!underscore"
The | syntax separates globalName and moduleLocalName. Use named import for specific exports.

Configure expose-loader in webpack config to expose jQuery as $ and jQuery globally, then import jquery in entry point.

// webpack.config.js const path = require('path'); module.exports = { entry: './src/index.js', output: { path: path.resolve(__dirname, 'dist'), filename: 'bundle.js', }, module: { rules: [ { test: require.resolve('jquery'), loader: 'expose-loader', options: { exposes: ['$', 'jQuery'], }, }, ], }, }; // src/index.js import $ from 'jquery'; // Now $ and jQuery are globally available console.log(window.$); // jQuery function
Debug
Known issues
breakingInline syntax changed in v2.0.0: `[]` is no longer supported, use `,` comma separator (e.g., `?exposes=$,jQuery` instead of `?exposes[]=$&exposes[]=jQuery`).
fix
Update inline query to use comma-separated values: `exposes=$,jQuery`
affects: ^2.0.0
breakingMinimum supported Node.js version is 18.12.0 as of v5.0.0.
fix
Upgrade Node.js to >=18.12.0 or pin expose-loader to v4.x.
affects: >=5.0.0
breakingMinimum supported webpack version is 5 as of v2.0.0.
fix
Use webpack 5 or later; if on webpack 4, use expose-loader@1.
affects: >=2.0.0
gotchaSpaces in inline syntax must be encoded as %20, not actual spaces.
fix
Use %20 for spaces in URLs: e.g., `exposes=_.map|map` (no spaces) vs `exposes=_.reduce|reduce` (no spaces).
affects: *
gotchaThe loader must be used with require.resolve in webpack config to target the exact module; otherwise, it may expose the wrong module.
fix
Use `test: require.resolve('module-name')` to precisely match the module path.
affects: *
Errors
Common errors & fixes
Module not found: Error: Can't resolve 'expose-loader'
expose-loader not installed as devDependency.
fix
Run `npm install --save-dev expose-loader`.
You may need an appropriate loader to handle this file type, currently no loaders are configured to process this file.
Webpack rule for expose-loader is not matching the import or the loader config is missing.
fix
Ensure webpack config has a rule with `test: require.resolve('your-module')` and `loader: 'expose-loader'`.
Invalid configuration object. Webpack has been initialised using a configuration object that does not match the API schema.
Options passed to expose-loader have an invalid structure, e.g., wrong type for `exposes`.
fix
Check the `exposes` option: it should be a string, object, or array of those, not a number or boolean.
Upgrade
Version history
5.0.1latest on npm
Audit
Dependencies
webpackrequiredpeer dependency: webpack ^5.0.0 required for loader usage
Agent activity
2 hits · last 30 days
node
2
Resources
githubhttps://github.com/webpack-contrib/expose-loader ↗
packagehttps://www.npmjs.com/package/expose-loader ↗
expose-loader — npm install expose-loader · libregistry