Browser-side require() for your node modules and npm packages
Just point a javascript file or two at browserify and it will walk the AST to
read all your require()s recursively. The resulting bundle has everything you
need, including pulling in libraries you might have installed using npm!
-
Relative
require()s work browser-side just as they do in node. -
Coffee script gets automatically compiled and you can register custom compilers of your own!
-
Browser-versions of certain core node modules such as
path,events, andvmare included as necessary automatically.
server.js
var connect = require('connect');
var server = connect.createServer();
server.use(connect.static(__dirname));
server.use(require('browserify')({
require : __dirname + '/js/foo.js',
mount : '/browserify.js'
}));
server.listen(9797);
console.log('Listening on 9797...');js/foo.js
var bar = require('./bar');
var baz = require('./baz');
module.exports = function (x) {
return x * bar.coeff(x) + baz.wowsy(x);
};js/bar.js
exports.coeff = function (x) {
return Math.log(x) / Math.log(2) + 1;
};js/baz.coffee
exports.wowsy = (beans) ->
beans * 3 - 2index.html
<html>
<head>
<script type="text/javascript" src="/browserify.js"></script>
<script type="text/javascript">
var foo = require('./foo');
window.onload = function () {
document.getElementById('result').innerHTML = foo(100);
};
</script>
</head>
<body>
foo =
<span style='font-family: monospace' id="result"></span>
</body>
</html>server.js
var connect = require('connect');
var server = connect.createServer();
server.use(connect.static(__dirname));
server.use(require('browserify')({
mount : '/browserify.js',
require : 'traverse',
}));
server.listen(4040);
console.log('Listening on 4040...');index.html
<html>
<head>
<script type="text/javascript" src="/browserify.js"></script>
<script type="text/javascript">
var Traverse = require('traverse');
var obj = [ 5, 6, -3, [ 7, 8, -2, 1 ], { f : 10, g : -13 } ];
Traverse(obj).forEach(function (x) {
if (x < 0) this.update(x + 128);
});
window.onload = function () {
document.getElementById('result').innerHTML
= JSON.stringify(obj);
};
</script>
</head>
<body>
foo =
<span style='font-family: monospace' id="result"></span>
</body>
</html>var browserify = require('browserify');Return a middleware with attached methods that will host up a browserified
script at opts.mount or "/browserify.js" if unspecified.
opts may also contain these fields:
- require - calls
b.require() - ignore - calls
b.ignore() - entry - calls
b.addEntry() - filter - registers a "post" extension using
b.register() - watch - set watches on files, see below
If opts is a string, it is interpreted as a require value.
Set watches on files and automatically rebundle when a file changes.
This option defaults to false. If opts.watch is set to true, default watch
arguments are assumed or you can pass in an object to pass along as the second
parameter to fs.watchFile().
Return the bundled source as a string.
Require a file or files for inclusion in the bundle.
If file is an array, require each element in it.
If file is a non-array object, map an alias to a package name.
For instance to be able to map require('jquery') to the jquery-browserify
package, you can do:
b.require({ jquery : 'jquery-browserify' })and the same thing in middleware-form:
browserify({ require : { jquery : 'jquery-browserify' } })To mix alias objects with regular requires you could do:
browserify({ require : [ 'seq', { jquery : 'jquery-browserify' }, 'traverse' ])In practice you won't need to b.require() very many files since all the
require()s are read from each file that you require and automatically
included.
Omit a file or files from being included by the AST walk to hunt down
require() statements.
Append a file to the end of the bundle and execute it without having to
require() it.
Specifying an entry point will let you require() other modules without having
to load the entry point in a <script> tag yourself.
If entry is an Array, concatenate these files together and append to the end of the bundle.
b.filter
Register a handler to wrap extensions.
Wrap every file matching the extension ext with the function fn.
For every file included into the bundle fn gets called for matching file
types as fn.call(b, body, file) for the bundle instance b and the file
content string body. fn should return the new wrapped contents.
If ext is unspecified, execute the wrapper for every file.
If ext is 'post', execute the wrapper on the entire bundle.
If ext is 'pre', call the wrapper function with the bundle object before the
source is generated.
If ext is an object, pull the extension from ext.extension and the wrapper
function fn from ext.wrapper. This makes it easy to write plugins like
fileify.
Coffee script support is just implemented internally as a .register()
extension:
b.register('.coffee', function (body) {
return coffee.compile(body);
});Use a middleware plugin, fn. fn is called with the instance object b.
Prepend unwrapped content to the beginning of the bundle.
Append unwrapped content to the end of the bundle.
Alias a package name from another package name.
In order to resolve main files for projects, the package.json "main" field is read.
If a package.json has a "browserify" field, you can override the standard "main" behavior with something special just for browsers.
The "browserify" field can be a string that points to the browser-specific "main" file or it can be an object with a "main" field in it.
Browserify exports a faux process object with these attributes:
- nextTick(fn) - does setTimeout(fn, 0)
- title - set to 'browser' for browser code, 'node' in regular node code
You can require('events').EventEmitter just like in node.js code.
All the goodness of node's require('vm') has been emulated with iframe
trickery and eval() hacks.
The posix functions from the path module have been included except for
exists() and existsSync(). Just require('path')!
The faux directory name, scrubbed of true directory information so as not to expose your filesystem organization.
The faux file path, scrubbed of true path information so as not to expose your filesystem organization.
npm install jquery-browserifyto have npm and browserify handle your jquery deployment!