This module allows loading of javascript files that made for the browser as modules for node.js;
by Shimon Doodkin
license: MIT
syntax:
Object context = jsinc( String file1, ... , String fileN, Object context, Function callback )
- the last argument is an optional context object.
- the function returns the resulting global object, after running the script(s)
- basically it loades the javascript files, adds a window object, executes the script and returns to you the global object with all of the functions and variables that ware added by the script.
example:
https://github.com/shimondoodkin/googlediff
npm install jsinc
var jsinc=require('jsinc');
var date=jsinc( 'date.js' );
console.log(date); // see what's there
// linq example:
// download linq from http://codeplex.com/jslinq
var jsinc = require('jsinc');
var jslinq = jsinc(__dirname+'/deps/jslinq/scripts/JSLINQ.js').window.JSLINQ; // wanted function
var jsinc = require('jsinc');
var date = jsinc( 'date.js', 'date2.js' );
if the last argument is an object then it is used as context.
// if you need XMLHttpRequest for example, you can add it to the sand box like:
// install xmlhttp like: npm install xmlhttprequest
var date=jsinc( 'date.js',{XMLHttpRequest:require('xmlhttprequest')} );
// you can do even staff like this (if you know what are you doing):
var date=jsinc('date.js',this);
// the above does a "mixin" but may have problem (nodejs bug)
// if this module exports getters,setter, and nonenumeratable
// read multiple files in steps by reusing the context
var jsinc = require('jsinc');
var context = jsinc( 'date.js' );
context = jsinc( 'date2.js',context );
// Experimental async version:
jsinc( String file1, ... , String fileN, Object context, Function callback(context) )
//example:
var jsincA = require('jsinc').async;
var app={};
jsincA( 'date.js',{XMLHttpRequest:require('xmlhttprequest')}, function (date){ app.date=date; }); // with a callback, the file will be read asynchronously.
//Default Context using getbind function:
var jsincbound=jsinc.getbind( Object context ) // return a function( String file1, ... , String fileN, Object context )
// the getbind method returns a function that checks if there is no context in the arguments then it adds it from getbind's 1st argument
// example:
var jsincthis=require('jsinc').getbind( this ) ;
jsincthis('foo.js')
// a Bound version Inside the Script:
// is avalible for the included script
// if you want to include a script from within the script you can simply call
jsinc('filename.js')
// from within the script to include 'filename.js' to script's global scope
- Use it for modules that are shared with the browser
- Use it as a simple way to write simple modules that do not require to export the module's function
- To bind or to rewrite the function after they loaded
- Put a callback function in the context object and call it
- Put jsinc in the context object, as a way for the script load other scripts, binded with the context object filled in.
- I use this module to do quick migration of browser libs to node.js