Modules 101

Introduction to JavaScript Modular Applications






Julián Duque

Developer by Passion
http://about.me/julianduque
@julian_duque


Act I


Module Patterns 

Designing Modules


Object Literal

 var robot = {
name: 'ED-209',
talk: function () {
console.log("I'm " + this.name + ", please put down your weapon. You have twenty seconds to comply.");
},
walk: function () {
console.log("Swooosh, Swooosh!")
},
shoot: function (target) {
target = target || "";
console.log("Pew pew pew " + target);
}
};
Example


Prototype Function

Constructor Pattern

function Robot(opts) {
opts = opts || {
name: 'Sonny',
type: 'NS5'
};
this.name = opts.name;
this.type = opts.type;
}

Robot.prototype.introduce = function () {
console.log('Hello my name is ' + this.name);
return this;
};

Robot.prototype.talk = function () {
console.log('What does this action signify? ;)');
return this;
};

Example


Anonymous Closure

Module Pattern

 var robot = (function () {
var forbbidenActions = ['harm', 'kill', 'injure', 'destroy'];

function followRules(action) {
return forbbidenActions.indexOf(action) < 0;
}

return {
execute: function (action, target) {
if (followRules(action)) {
console.log("I'll " + action + " " + target);
} else {
throw new Error("Must follow the Three Laws!");
}
}
}
})();
Example


Act II


Module Definitions

Organizing Modules


Global

 var BasicMath = {
add: function (a, b) {
return a + b;
},
sub: function (a, b) {
return a - b;
}
};

window.BasicMath = BasicMath;
Example

Works on every browser!


AMD

Asynchronous Module Definition

// Module Definition
define('BasicMath', [], function () {
return {
add: function (a, b) {
return a + b;
},
sub: function (a, b) {
return a - b;
}
}
});
// Module Consumption
require(['BasicMath'], function (BasicMath) {
console.log(BasicMath.add(2,4));
});
Example


CommonJS

// Definition
var BasicMath = {
add: function (a, b) {
return a + b;
},
sub: function (a, b) {
return a - b;
}
};

module.exports = BasicMath; // Consumption var BasicMath = require('basicmath'); BasicMath.add(3, 4); // return 7 :p


Hybrid AMD/CommonJS

define(function (require, exports, module) {

var validate = require('lib/validate');

exports.add = function (a, b) {
if (!validate(a) && !validate(b)) {
throw new Error('Must be real numbers');
}

return a + b;
};

exports.sub = function (a, b) {
return a - b;
};
});


UMD

 (function (define) {
// AMD Style
define('BasicMath', function (require, exports) {

var validate = require('validate');

exports.add = function (a, b) {
if (!validate(a) && !validate(b)) {
throw new Error('Must be real numbers');
}

return a + b;
};
});
}(typeof define === 'function' && define.amd ? define : function (id, factory) {
if (typeof exports !== 'undefined') {
// It's CommonJS
factory(require, exports);
} else {
// Add Global
factory(function(value) {
return window[value];
}, (window[id] = {}));
}
}));


ECMAScript 6

// Define (named)
var add = function (a, b) {/../}

var sub = function (a, b) {/../}

export { add, sub }

// Default
var BasicMath = { add: function (a, b) {/../}, sub: function(a,b ) {/../}  }
export default BasicMath

// Use (named)
import { add, sub } from "basicmath" 

// Use (default)
import BasicMath from "basicmath"



Use it now!


RequireJS


Browserify


es6-module-transpiler


Act III


Package Registries

Distributing Modules



http://npmjs.org



http://bower.io





Thanks! :D

Modules 101

By Julián Duque

Modules 101

Introduction to JavaScript Modules

  • 1,688