gulp-expose
Expose module.exports to a global object, like window
in the browser envrionment.
install
npm install --save-dev gulp-expose
usage
number.js:
module.exports = 1;
var expose = require('gulp-expose');
gulp.src('number.js')
.pipe(expose('window', 'One'))
.pipe(gulp.dest('dist'));
OR
var expose = require('gulp-expose');
gulp.src('number.js')
.pipe(expose('window.MyFavNumber', 'One'))
.pipe(gulp.dest('dist'));
And json can be exposed, too:
config.json:
{
"name": "gulp-expose"
}
var expose = require('gulp-expose');
var gulp = require('gulp-rename');
gulp.src('test/src/config.json')
.pipe(expose('window', 'PKG'))
.pipe(rename('config.js'))
.pipe(gulp.dest('test/dist'))
// window.PKG = { name: 'gulp-expose' }
expose(host, expose)
- host. String. The object that will have the exposed api. It can be any valid expression that can be evaluated as an object.
- expose. String. The property name that will be added to
host
, with the exposed api.
If host
is a function, it receives a vinyl file
object, and should return the expose info object { host: host, expose: expose }
.
example
build
var gulp = require('gulp');
var expose = require('gulp-expose');
gulp.src('number.js')
.pipe(expose('window', 'One'))
.pipe(gulp.dest('dist'));
dist/number.js
(function (host, expose) {
var module = { exports: {} };
var exports = module.exports;
module.exports = 1;
;(
function copy(src, target, obj) {
obj[target] = obj[target] || {};
if (src && typeof src === 'object') {
for (var k in src) {
if (src.hasOwnProperty(k)) {
obj[target][k] = src[k];
}
}
} else {
obj[target] = src;
}
}
).call(null, module.exports, expose, host);
}).call(window, window, "One");
Now in browser:
window.One === 1; // true