hilts-vaughan / node-xport

a module export (simplifier?) utility package for node.js

node-xport

###Using node-xport v0.2.0 or later ###Using node-xport v0.1.1 or earlier

v0.2.0+ Reference _^Top

node-xport v0.2.0+ supports two different types of module export, partial exports and full/combined exports. Full/combined exports are done by exporting some object and then making partial exports afterwards, as you can see below. If you do a full export after making partial exports, it will wipe out the partial exports.

Note: v0.2.x is backwards compatible with v0.1.1 and earlier.

DEVELOPERS: Tests can be run from the command line by executing npm test. No output indicates everything passed _{^{(or node secretly hates you)}}.

Examples

• Class exports (Full)
• Function exports (Full)
• Object exports (Full)
• Partial exports (Partial)
• Combined exports

Class export _{^{Examples Top}}

var xport = require('node-xport')(module);

var classExport = (function() {
    function MyClass(name) {
        this.name = (name || "DefaultName");
    }

    MyClass.prototype.hello = function() {
        return ("Hello my name is " + this.name);
    };

    MyClass.sayHello = function(myInstance) {
        return myInstance.hello();
    };

    return MyClass;
})();

xport(classExport);

Function export _{^{Examples Top}}

var xport = require('node-xport')(module);

var functionExport = function(num, str) {
    return "A string: '" + str + "' and a number: '" + num + "'.";
};

xport(functionExport);

Object export _{^{Examples Top}}

var xport = require('node-xport')(module);

var objectExport = {
    'somenumber': 99,
    'somestring': "a string",
    'someobject': {
        'myname': "An Object"
    }
};

xport(objectExport);

Partial export _{^{Examples Top}}

var xport = require('node-xport')(module);

var whatAmI = function() {
    return "I am another partial export";
};

xport('myClass', classExport);
xport('myFunction', functionExport);
xport('myObject', objectExport);
xport('whatAmI', whatAmI);

Combined export _{^{Examples Top}}

var xport = require('node-xport')(module);

var combined = (function() {
    function Combined() {}

    Combined.saySomething = function() {
        return "Something? :D"
    };

    return Combined;
})();

xport(combined);

var whatAmI = function() {
    return "I am another partial export";
};

xport('myClass', classExport);
xport('myFunction', functionExport);
xport('myObject', objectExport);
xport('whatAmI', whatAmI);

Example for v0.1.1 and earlier _^Top

var xport = require('node-xport');

var myExports = {};

xport(module, myExports);