JavaScript Fundamentals
JavaScript Fundamentals
rusu.marius.gabriel@gmail.com
This is a Leanpub book. Leanpub empowers authors and publishers with the Lean Publishing
process. Lean Publishing is the act of publishing an in-progress ebook using lightweight tools and
many iterations to get reader feedback, pivot until you have the right book and build traction once
you do.
2013 - 2014 Azat Mardan
Contents
1. JavaScript FUNdamentals: The Powerful and Misunderstood Language of The Web
1.1 Expressiveness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2 Loose Typing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3 Object Literal Notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5 Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.6 Prototypal Nature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7 Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8 No Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9 Immediately-Invoked Function Expressions (IIFEs) . . . . . . . . . . . . . . . . . .
1.10 Keyword this . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.11 Pitfalls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.12 Further Learning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
2
2
3
3
4
6
6
7
8
8
9
9
10
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
11
11
13
14
15
17
20
20
22
24
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
25
26
26
27
31
38
44
53
53
CONTENTS
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
54
55
56
56
57
57
59
59
59
60
60
61
61
62
62
63
63
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
65
65
65
66
67
67
67
68
68
69
70
7. Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
72
8. Errata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
73
9. Contact Us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
74
CONTENTS
console.log('Hello World')
http://en.wikipedia.org/wiki/Expressive_power
http://stackoverflow.com/questions/638881/what-does-expressive-mean-when-referring-to-programming-languages
1
2
3
<script>
document.write('Hello World')
</script>
JavaScript allows programmers to focus on the solution/problem rather than to jump through hoops
and API docs.
String
Number (both integer and real)
Boolean
Undefined
Null
Everything else is an object, i.e., mutable keyed collections. Read Stackoverflow on What does
immutable mean?
Also, in JavaScript there are String, Number and Boolean objects which contain helpers for the
primitives:
1
but
1
or
1
1
2
3
4
5
6
7
var obj = {
color: "green",
type: "suv",
owner: {
...
}
}
1.4 Functions
Functions are first-class citizens, and we treat them as variables, because they are objects! Yes,
functions can even have properties/attributes.
var f = function f () {
console.log('Hi');
return true;
}
or
1
2
3
4
function f () {
console.log('Hi');
return true;
}
Function with a property (remember functions are just objects that can be invoked, i.e. initialized):
1
2
3
4
Note: the return keyword is optional. In case its omitted, the function will return undefined upon
invocation.
function f () {};
f();
Function expression always returns something, because it resolves to some value which could be a
number, a string, an object or a boolean:
1
2
1.5 Arrays
Arrays are also objects which have some special methods inherited from Array.prototype global
object. Nevertheless, JavaScript Arrays are not real arrays. Instead, they are objects with unique
integer (usually 0-based) keys.
1
2
3
4
var
var
var
var
arr = [];
arr2 = [1, "Hi", {a:2}, function () {console.log('boo');}];
arr3 = new Array();
arr4 = new Array(1,"Hi", {a:2}, function () {console.log('boo');});
1.7 Conventions
Most of these conventions (with semi-colons being an exception) are stylistic, and highly preferential
and dont impact the execution.
1.7.1 Semi-Colons
Optional semi-colons, except for two cases:
1. In for loop construction: for (var i=0; i++; i<n)
2. When a new line starts with parentheses, e.g., Immediately-Invoked Function Expression
(IIFE): ;(function(){...}())
1.7.2 camelCase
camelCase, except for class names which are CapitalCamelCase, e.g.,
1
2
1.7.3 Naming
_,$ are perfectly legitimate characters for the literals (jQuery and Underscore libraries use them a
lot).
Private methods and attributes start with _ (does nothing by itself!).
1.7.4 Commas
Comma-first approach
1
2
3
4
1.7.5 Indentation
Usually its either tab, 4 or 2 space indentation with their supporters camps being almost religiously
split between the options.
1.8 No Modules
At least until ES6, everything is in the global scope, a.k.a. window and included via <script> tags.
However, there are external libraries that allow for workarounds:
CommonJS
AMD and Require.js
Node.js uses CommonJS-like syntax and has built-in support for modules.
To hide your code from global scope, make private attributes/methods use closures and immediatelyinvoked function expressions (or IIFEs).
(function () {
window.yourModule = {
...
};
}());
This snippet shows an example of an object with private attribute and method:
https://wiki.mozilla.org/ES6_plans
http://www.commonjs.org/
http://requirejs.org/
http://en.wikipedia.org/wiki/Immediately-invoked_function_expression
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
(function () {
window.boo = function() {
var _a = 1;
var inc = function () {
_a++;
console.log(_a);
return _a;
};
return {
increment: inc
};
}
}());
var b = window.boo();
b.increment();
b.increment();
b.increment();
b.increment();
1.11 Pitfalls
JS is the only language that programmers think they shouldnt learn. Things like === vs. ==, global
scope leakage, DOM, etc. might lead to problems down the road. This is why its important to
understand the language or use something like CoffeeScript, that takes way most of the issues.
10
1
2
3
4
5
6
7
8
9
10
11
12
13
14
12
a =
x: 1
y: -20
z: () ->
console.log a.x+a.y
a.z()
b = [
1,
2,
x: 10
y: 20
]
var a, b;
a = {
x: 1,
y: -20,
z: function() {
return console.log(a.x + a.y);
}
};
a.z();
b = [
1, 2, {
x: 10,
y: 20
}
];
As you might have noticed, the logical blocks curly braces that we use to write code for functions
(i.e., {}) are also replaced by indentation. Lets not forget that functions are just objects in JavaScript.
:-)
13
2.2 Vars
CoffeeScript automatically inserts var keywords for us and prohibits manual usage of var. For
example, a,b, and c variable declarations will have the var in the JavaScript code:
1
2
3
a = 10
b = 'x'
c = [1,2,3]
JavaScript code:
1
2
3
4
5
6
7
var a, b, c;
a = 10;
b = 'x';
c = [1, 2, 3];
CoffeeScript always puts vars at the top of the scope where this particular variable is encountered
first. The scope is defined by the function or window. For example, the anonymous function d will
have e scoped to it, because CoffeeScript first saw e inside of the function:
1
2
3
4
5
6
7
8
a = 10
b = 'x'
c = [1,2,3]
d = () ->
e = a
console.log e
d()
JavaScript output:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
var a, b, c, d;
a = 10;
b = 'x';
c = [1, 2, 3];
d = function() {
var e;
e = a;
return console.log(e);
};
d();
2.3 Conditions
Conditions are more readable by humans (English-like?) in CoffeeScript:
1
2
3
4
5
a = b = c = d = 1
if a is b or b isnt c and not c is d
console.log 'true'
else
console.log 'false'
1
2
3
4
5
6
7
8
9
var a, b, c, d;
a = b = c = d = 1;
if (a === b || b !== c && !c === d) {
console.log('true');
} else {
console.log('false');
}
14
1
2
3
4
15
2.4 Functions
Functions in CoffeeScript are defined with arrows ()-> and fat arrows ()=> (more on this later):
1
2
JavaScript code:
1
2
3
4
5
6
7
var a;
a = function(x, y) {
return console.log(x + y);
};
a(10, -5);
Longer expressions can be on multiple lines using indentation, while the default values can be
assigned right in the function signature (i.e., (name=value)):
1
2
3
4
1
2
3
4
5
6
7
8
9
10
11
12
16
var a;
a = function(x, y, z) {
var sum;
if (z == null) {
z = 15;
}
sum = x + y + z;
return console.log(sum);
};
a(10, -5);
So back to the far arrow, it does two things: 1. Defines a function 2. Binds the new functions scope
to the current value of this
Remember that this is dynamically scoped, i.e., its meaning changes based on where it is situated
in the code (whats the scope). For example, if we have a jQuery event handler click, we might
want to use this as the object in which we defined the handler, not as the DOM element to which
the handler is bound.
For example, this CoffeeScript code will return window object both times (thats what we want):
1
2
3
console.log @
$('div').click ()=>
console.log @
console.log(this);
$('div').click((function(_this) {
return function() {
return console.log(_this);
};
})(this));
However, with skinny (single) arrows its back to the DOM scope for the event handler, (this might
be bad if unexpected):
1
2
3
console.log @
$('div').click ()->
console.log @
1
2
3
4
5
console.log(this);
17
$('div').click(function() {
return console.log(this);
});
Traditionally for the snippet above, without the CoffeeScripts far arrows, you would see workarounds
like these which use interim variables like that, self, or _this:
1
2
3
4
5
console.log(this);
var that = this;
$('div').click(function() {
return console.log(that);
});
2.5 Classes
Classes are probably the yummiest and the most complex and confusing feature in CoffeeScript. In
JavaScript classes are absent! We use prototypes instead, so the objects inherit from other objects.
We can also use factories, i.e., the functions that create objects.
However, if a developer wants to implement a class, it could be really tricky and often requires a
good understanding of pseudo-classical instantiation patterns. This is not the case with CoffeeScript,
which introduces class keyword. Inside of the class we can use constructor method and super
call, for the initialization logic and the invocation of the parents methods correspondingly.
For example, we have a parent class Vehicle from which we extend two classes, Compact and Suv.
In these classes, we write custom move methods with the super call, that allows us to re-use the logic
from the parent class Vehicle.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
18
class Vehicle
constructor: (@name) ->
move: (meters) ->
console.log @name + " moved #{meters} miles."
class Compact extends Vehicle
move: ->
console.log "Cruising..."
super 5
class Suv extends Vehicle
move: ->
console.log "Speeding..."
super 45
camry = new Compact "Camry"
caddi = new Suv "Cadillac"
camry.move()
caddi.move()
Cruising...
Camry moved 5 miles.
Speeding...
Cadillac moved 45 miles.
The JavaScript output is quite lengthy, so no wonder developers often prefer functional or other
patterns:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
}
Vehicle.prototype.move = function(meters) {
return console.log(this.name + (" moved " + meters + " miles."));
};
return Vehicle;
})();
Compact = (function(_super) {
__extends(Compact, _super);
function Compact() {
return Compact.__super__.constructor.apply(this, arguments);
}
Compact.prototype.move = function() {
console.log("Cruising...");
return Compact.__super__.move.call(this, 5);
};
return Compact;
})(Vehicle);
Suv = (function(_super) {
__extends(Suv, _super);
function Suv() {
return Suv.__super__.constructor.apply(this, arguments);
}
Suv.prototype.move = function() {
console.log("Speeding...");
return Suv.__super__.move.call(this, 45);
};
return Suv;
})(Vehicle);
19
53
54
55
56
57
58
59
20
arr = [1..10]
slicedArr = arr[2..4]
console.log arr, slicedArr
1
2
3
4
5
6
7
Trivia fact: for array declarations with 20+ items (e.g., range of [0..20] and larger), CoffeeScript
compiler will switch to the for loop.
2.7 Splats
Splats is a better way of using a variable number of arguments and arguments object (from native
JavaScript):
1
2
3
4
5
1
2
3
4
5
6
7
8
9
10
11
12
13
14
21
a = (x...) ->
sum = 0
x.forEach (item) -> sum += item
console.log sum
a(10,-5, 15)
var a,
__slice = [].slice;
a = function() {
var sum, x;
x = 1 <= arguments.length ? __slice.call(arguments, 0) : [];
sum = 0;
x.forEach(function(item) {
return sum += item;
});
return console.log(sum);
};
a(10, -5, 15);
Spats work with invocations too. For example, our sum function from the previous example needs
to treat the array not as a first element, but as all arguments:
1
2
3
4
5
6
a = (x...) ->
sum = 0
x.forEach (item) -> sum += item
console.log sum
a [-5..50]...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
22
2.8 Comprehensions
The last but not least topic is comprehensions. They are probably the most used feature in
CoffeeScript and replace (or at least try to replace) all loops.
For example, a simple iteration over an array:
1
2
3
4
5
6
7
8
arr = [
'x',
'y',
'z'
]
for a in arr
console.log a
x
y
z
1
2
3
4
5
6
7
8
23
As is the case with conditions, comprehensions might be reversed in order, e.g., console.log a for
a in arr. Then, we can get an index which will be the second parameter, e.g., console.log a, i
for a, i in arr outputs:
1
2
3
x 0
y 1
z 2
The when clause acts like a filter method; in other words, we can apply a test to the iterator:
1
2
x 0
z 2
To step with an increment we can use by: evens = (x for x in [0..10] by 2). In addition, for
iterating over objects we can use of:
1
2
3
4
5
6
7
8
obj =
'x': 10
'y':-2
'z': 50
coordinates = for key, value of obj
"coordinate #{key} is #{value}pt"
console.log coordinates
24
2.9 Conclusion
This CoffeeScript FUNdamentals is a concise overview that should highlight major pros of this
language, which has many more useful features. We hope that classes, arrow function declaration,
comprehensions, splats, and the clean syntax were enough to spark interest and lead to more
exploration and experimentation with CoffeeScript.
Heres the list of further CoffeeScirpt reading:
CoffeeScript Quirks
The Little Book on CoffeeScript
CoffeeScript Cookbook
Smooth CoffeeScript
CoffeeScript Ristretto
http://webapplog.com/coffeescript-quirks/
http://arcturo.github.io/library/coffeescript/
http://coffeescriptcookbook.com/
http://autotelicum.github.io/Smooth-CoffeeScript/
https://leanpub.com/coffeescript-ristretto/read
http://spinejs.com/
http://knockoutjs.com/
http://emberjs.com/
https://angularjs.org/
https://twitter.com/jashkenas
http://todomvc.com/
26
A typical Backbone.js app will have the main Router class. From that class all the routes (URL paths)
will be defined. The router can create and call methods of other classes such as Views, Collections,
and Models. For example, for path /books well render books view.
The recommended usage is that Views usually have one Collection or one Model. A Collection is
just a list of Models. However, this is not written in stone. Backbone.js is very flexible and should be
used according to the specific needs. For example, an application can have a Model that has Views
and each View that has collections.
In our concise example, well have one main Router that has Views. These Views will have models
and collections.
index.html: the main file and all the applications JavaScript code
jquery.js: jQuery library
underscore.js: Underscore.js library
backbone.js: Backbone.js library
A full source code for the Hello World app is available at GitHub under github.com/azatco/rpjs/backbone/hello-world.
jQuery, Underscore are required dependencies for Backbone.js.
https://github.com/azat-co/rpjs/tree/master/backbone/hello-world
27
<!DOCTYPE>
<html>
<head>
<script src="jquery.js"></script>
<script src="underscore.js"></script>
<script src="backbone.js"></script>
<script>
//TODO write some awesome JS code!
</script>
</head>
<body>
</body>
</html>
Note
We can also put <script> tags right after the </body> tag in the end of the file. This will
change the order in which scripts and the rest of HTML are loaded and impact performance
in large files.
Some developers shy away from using Backbone Router (its an optional class/component), but we
always find that Router brings more benefits and clarity. In a way, it serves as a starting point of
your application and helps to understand the foundation and how all the pieces fit together such as
views, models, etc. So, lets define a simple Backbone.js Router inside of a <script> tag:
http://code.jquery.com/jquery-1.9.0.js
http://underscorejs.org/underscore.js
http://backbonejs.org/backbone.js
https://developers.google.com/speed/libraries/devguide
1
2
3
4
28
...
var router = Backbone.Router.extend({
});
...
Note
For now, to Keep It Simple Stupid (KISS), well be putting all of our JavaScript code right
into the index.html file. This is not a good idea for a real development or production code.
Well refactor it later.
The Backbone.js routes property needs to be in the following format: 'path/:param': 'action'
which will result in the filename#path/param URL triggering a function named action (defined in
the Router object). For now, well add a single home route:
1
2
3
4
5
This is good, but now we need to add a home function (the right part of the route: action key-value
pair):
1
2
3
4
5
6
7
8
Well come back to the home function later to add more logic for creating and rendering of a View.
Right now, we should define our homeView:
1
2
29
Does it look familiar to you? Right, Backbone.js uses similar syntax for all of its components,
such as Backbone.View, Backbone.Router, Backbone.Model and Backbone.Collection. The class
is followed by the extend function and a JSON object as a parameter to it. This object often contains
some initialization options or attributes of the class.
There are multiple ways to proceed from now on, but the best practice is to use the el and template
properties, which are magical, i.e., special in Backbone.js, because they allow us to do two things:
1. el: attach the Backbone View object to a Document Object Model (DOM) element
2. template: store the Underscore (in this case we use Underscore but it can be changed to
another library) template
Heres the code for the home view:
1
2
3
4
The property el is just a string that holds the jQuery selector (you can use class name with . and id
name with #). The template property has been assigned an Underscore.js function template with
just a plain text Hello World.
To render our homeView we use this.$el which is a compiled jQuery object referencing element
in an el property, and the jQuery .html() function to replace HTML with this.template() value.
Here is what the full code for our home Backbone.js View looks like:
1
2
3
4
5
6
7
Now, if we go back to the router we can add these two lines to the home function:
1
2
3
4
5
6
7
8
9
10
11
12
30
The first line will create the homeView object and assign it to the homeView property of the router.
The second line will call the render() method in the homeView object, triggering the Hello World
output.
Finally, to start a Backbone app, we call new Router inside of a document-ready wrapper to make
sure that the files DOM is fully loaded. The app variable is made global in this sense, this helps to
access some Router properties (its a good idea to use a prefix specific to your application):
1
2
3
4
5
var app;
$(document).ready(function(){
app = new router;
Backbone.history.start();
})
Confused so far? Dont be because here is the full code of the index.html file:
1
2
3
4
5
6
7
8
9
10
11
12
13
<!DOCTYPE>
<html>
<head>
<script src="jquery.js"></script>
<script src="underscore.js"></script>
<script src="backbone.js"></script>
<script>
var app;
var router = Backbone.Router.extend({
routes: {
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
31
'': 'home'
},
initialize: function(){
//some code to execute
//when the object is instantiated
},
home: function(){
this.homeView = new homeView;
this.homeView.render();
}
});
var homeView = Backbone.View.extend({
el: 'body',
template: _.template('Hello World'),
render: function(){
this.$el.html(this.template({}));
}
});
$(document).ready(function(){
app = new router;
Backbone.history.start();
})
</script>
</head>
<body>
<div></div>
</body>
</html>
Open index.html in the browser to see if it works, i.e., the Hello World message should be on the
page.
32
The full source code of Backbone Collections example is under the GitHubs rpjs/backbone/collections.
This example is about Backbone Collections, and its built on top of the previous Hello World
example from the Setting up Backbone.js App from Scratch which is available for download at
rpjs/backbone/hello-world.
We should add some data to play around with and to hydrate our views. To do this, add this right
after the script tag and before the other code:
1
2
3
4
5
6
7
8
9
10
var appleData = [
{
name: "fuji",
url: "img/fuji.jpg"
},
{
name: "gala",
url: "img/gala.jpg"
}
];
Grab the images of Fuji (Figure 3-2) and Gala (Figure 3-3) from GitHub: https://github.com/azatco/rpjs/tree/master/backbone/collections/img, or add your own.
33
This is our apple database. :-) Or to be more accurate, our REST API endpoint-substitute, which
provides us with names and image URLs of the apples (data models). If you want some real-world
servers, you can use:
Parse.com: back-end-as-a-service provider
Node.js and MongoDB REST API: a free-JSON API built with Node.js, Express.js and
MongoDB
Note
This mock dataset can be easily substituted by assigning REST API endpoints of your backend to url properties in Backbone.js Collections and/or Models, and calling the fetch()
method on them.
Now to make the User Experience (UX) a little bit better, we can add a new route to the routes
object in the Backbone Route:
1
2
3
4
5
6
...
routes: {
'': 'home',
'apples/:appleName': 'loadApple'
},
...
This will allow users to go to index.html#apples/SOMENAME and expect to see some information
about an apple. This information will be fetched and rendered by the loadApple function in the
Backbone Router definition:
http://parse.com
http://webapplog.com/express-js-4-node-js-and-mongodb-rest-api-tutorial/
1
2
3
34
loadApple: function(appleName){
this.appleView.render(appleName);
}
Have you noticed an appleName variable? Its exactly the same name as the one that weve used
in route. This is how we can access query string parameters (e.g., ?param=value&q=search) in
Backbone.js.
Now well need to refactor some more code to create a Backbone Collection, populate it with data
in our appleData variable, and to pass the collection to homeView and appleView. Conveniently
enough, we do it all in the Router constructor method initialize:
1
2
3
4
5
6
initialize: function(){
var apples = new Apples();
apples.reset(appleData);
this.homeView = new homeView({collection: apples});
this.appleView = new appleView({collection: apples});
},
At this point, were pretty much done with the Router class, and it should look like this:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
1
2
3
4
5
6
7
8
9
35
For now, we just output the string representation of the JSON object in the browser. This is not
user-friendly at all, but later well improve it by using a list and subviews.
So far, our apple Backbone Collection is very clean and simple:
1
2
Note
Backbone automatically creates models inside of a collection when we use the fetch() or
reset() functions.
Apple view is not any more complex; it has only two properties: template and render. In a template,
we want to display figure, img and figcaption tags with specific values. The Underscore.js template
engine is handy at this task:
1
2
3
4
5
6
7
8
To make a JavaScript string, which has HTML tags in it, more readable we can use the backslash
line breaker escape (\) symbol, or close strings and concatenate them with a plus sign (+). This is an
example of appleView above, which is refactored using the latter approach:
1
2
3
4
5
6
7
36
Please note the <%= and %> symbols; they are the instructions for Undescore.js to print values in
properties url and name of the attributes object.
Finally, were adding the render function to the appleView class.
1
2
3
4
5
render: function(appleName){
var appleModel = this.collection.where({name:appleName})[0];
var appleHtml = this.template(appleModel);
$('body').html(appleHtml);
}
We find a model within the collection via where() method and use [] to pick the first element.
Right now, the render function is responsible for both loading the data and rendering it. Later well
refactor the function to separate these two functionalities into different methods.
The whole app, which is in the rpjs/backbone/collections/index.html folder, looks like this:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!DOCTYPE>
<html>
<head>
<script src="jquery.js"></script>
<script src="underscore.js"></script>
<script src="backbone.js"></script>
<script>
var appleData = [
{
name: "fuji",
url: "img/fuji.jpg"
},
{
name: "gala",
url: "img/gala.jpg"
https://github.com/azat-co/rpjs/tree/master/backbone/collections
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
}
];
var app;
var router = Backbone.Router.extend({
routes: {
"": "home",
"apples/:appleName": "loadApple"
},
initialize: function(){
var apples = new Apples();
apples.reset(appleData);
this.homeView = new homeView({collection: apples});
this.appleView = new appleView({collection: apples});
},
home: function(){
this.homeView.render();
},
loadApple: function(appleName){
this.appleView.render(appleName);
}
});
var homeView = Backbone.View.extend({
el: 'body',
template: _.template('Apple data: <%= data %>'),
render: function(){
this.$el.html(this.template({
data: JSON.stringify(this.collection.models)
}));
}
//TODO subviews
});
var Apples = Backbone.Collection.extend({
});
var appleView = Backbone.View.extend({
template: _.template('<figure>\
<img src="<%= attributes.url %>"/>\
<figcaption><%= attributes.name %></figcaption>\
</figure>'),
//TODO re-write with load apple and event binding
37
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
38
render: function(appleName){
var appleModel = this.collection.where({
name:appleName
})[0];
var appleHtml = this.template(appleModel);
$('body').html(appleHtml);
}
});
$(document).ready(function(){
app = new router;
Backbone.history.start();
})
</script>
</head>
<body>
<div></div>
</body>
</html>
Open collections/index.html file in your browser. You should see the data from our database,
i.e., Apple data: [{"name":"fuji","url":"img/fuji.jpg"},{"name":"gala","url":"img/gala.jpg"}].
Now, let go to collections/index.html#apples/fuji or collections/index.html#apples/gala
in your browser. We expect to see an image with a caption. Its a detailed view of an item, which in
this case is an apple. Nice work!
Its a good thing that we have event binding in Backbone. The event binding is not an exclusive
to Backbone feature, because it is part of jQuery. But without Backbone organization and code
39
structure, things tend to end up messier (with plain jQuery). For example, well have to pass a
function that renders HTML as a callback to the data loading function, to make sure that the
rendering function is not executed before we have the actual data to display.
Therefore, when a user goes to detailed view (apples/:id) we only call the function that loads the
data. Then, with the proper event listeners, our view will automagically (this is not a typo) update
itself; when there is a new data (or on a data change, Backbone.js supports multiple and even custom
events).
Lets change the code in the router:
1
2
3
4
5
...
loadApple: function(appleName){
this.appleView.loadApple(appleName);
}
...
Everything else remains the same until we get to the appleView class. Well need to add a constructor
or an initialize method, which is a special word/property in the Backbone.js framework. Its called
each time we create an instance of an object, i.e., var someObj = new SomeObject(). We can also
pass extra parameters to the initialize function, as we did with our views (we passed an object
with the key collection and the value of apples Backbone Collection). Read more on Backbone.js
constructors at backbonejs.org/#View-constructor.
1
2
3
4
5
6
...
var appleView = Backbone.View.extend({
initialize: function(){
//TODO: create and setup model (aka an apple)
},
...
Great, we have our initialize function. Now we need to create a model which will represent a
single apple and set up proper event listeners on the model. Well use two types of events, change and
a custom event called spinner. To do that, we are going to use the on() function, which takes these
properties: on(event, actions, context) read more about it at backbonejs.org/#Events-on:
http://backbonejs.org/#View-constructor
http://backbonejs.org/#Events-on
1
2
3
4
5
6
7
40
...
var appleView = Backbone.View.extend({
this.model = new (Backbone.Model.extend({}));
this.model.bind('change', this.render, this);
this.bind('spinner',this.showSpinner, this);
},
...
...
templateSpinner: '<img src="img/spinner.gif" width="30"/>',
...
Remember the loadApple call in the router? This is how we can implement the function in
appleView:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
...
loadApple:function(appleName){
this.trigger('spinner');
//show spinner GIF image
var view = this;
//we'll need to access that inside of a closure
setTimeout(function(){
//simulates real time lag when
//fetching data from the remote server
view.model.set(view.collection.where({
name:appleName
})[0].attributes);
},1000);
},
...
The first line will trigger the spinner event (the function for which we still have to write).
41
The second line is just for scoping issues (so we can use appleView inside of the closure).
The setTimeout function is simulating a time lag of a real remote server response. Inside of it, we
assign attributes of a selected model to our views model by using a model.set() function and a
model.attributes property (which returns the properties of a model).
Now we can remove an extra code from the render method and implement the showSpinner
function:
1
2
3
4
5
6
7
8
render: function(appleName){
var appleHtml = this.template(this.model);
$('body').html(appleHtml);
},
showSpinner: function(){
$('body').html(this.templateSpinner);
}
...
<!DOCTYPE>
<html>
<head>
<script src="jquery.js"></script>
<script src="underscore.js"></script>
<script src="backbone.js"></script>
<script>
var appleData = [
{
name: "fuji",
url: "img/fuji.jpg"
},
{
name: "gala",
url: "img/gala.jpg"
}
];
var app;
var router = Backbone.Router.extend({
routes: {
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
"": "home",
"apples/:appleName": "loadApple"
},
initialize: function(){
var apples = new Apples();
apples.reset(appleData);
this.homeView = new homeView({collection: apples});
this.appleView = new appleView({collection: apples});
},
home: function(){
this.homeView.render();
},
loadApple: function(appleName){
this.appleView.loadApple(appleName);
}
});
var homeView = Backbone.View.extend({
el: 'body',
template: _.template('Apple data: <%= data %>'),
render: function(){
this.$el.html(this.template({
data: JSON.stringify(this.collection.models)
}));
}
//TODO subviews
});
var Apples = Backbone.Collection.extend({
});
var appleView = Backbone.View.extend({
initialize: function(){
this.model = new (Backbone.Model.extend({}));
this.model.on('change', this.render, this);
this.on('spinner',this.showSpinner, this);
},
template: _.template('<figure>\
<img src="<%= attributes.url %>"/>\
<figcaption><%= attributes.name %></figcaption>\
</figure>'),
42
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
43
44
...
var appleItemView = Backbone.View.extend({
tagName: 'li',
template: _.template(''
+'<a href="#apples/<%=name%>" target="_blank">'
+'<%=name%>'
+'</a> <a class="add-to-cart" href="#">buy</a>'),
events: {
'click .add-to-cart': 'addToCart'
},
render: function() {
this.$el.html(this.template(this.model.attributes));
},
addToCart: function(){
this.model.collection.trigger('addToCart', this.model);
}
});
...
Now we can populate the object with tagName, template, events, render and addToCart properties/methods.
https://github.com/azat-co/rpjs/tree/master/backbone/subview
1
2
3
45
...
tagName: 'li',
...
tagName automatically allows Backbone.js to create an HTML element with the specified tag name,
in this case <li> list item. This will be a representation of a single apple, a row in our list.
1
2
3
4
5
6
...
template: _.template(''
+'<a href="#apples/<%=name%>" target="_blank">'
+'<%=name%>'
+'</a> <a class="add-to-cart" href="#">buy</a>'),
...
The template is just a string with Undescore.js instructions. They are wrapped in <% and %> symbols.
<%= simply means print a value. The same code can be written with backslash escapes:
1
2
3
4
5
6
7
...
template: _.template('\
<a href="#apples/<%=name%>" target="_blank">\
<%=name%>\
</a> <a class="add-to-cart" href="#">buy</a>\
'),
...
Each <li> will have two anchor elements (<a>), links to a detailed apple view (#apples/:appleName)
and a buy button. Now were going to attach an event listener to the buy button:
1
2
3
4
5
...
events: {
'click .add-to-cart': 'addToCart'
},
...
Both the key and the value (right and left parts separated by the colon) are strings. For example:
46
or
1
To render each item in the list, well use the jQuery html() function on the this.$el jQuery object,
which is the <li> HTML element based on our tagName attribute:
1
2
3
4
5
...
render: function() {
this.$el.html(this.template(this.model.attributes));
},
...
The addToCart method will use the trigger() function to notify the collection that this particular
model (apple) is up for the purchase by the user:
1
2
3
4
5
...
addToCart: function(){
this.model.collection.trigger('addToCart', this.model);
}
...
...
var appleItemView = Backbone.View.extend({
tagName: 'li',
template: _.template(''
+'<a href="#apples/<%=name%>" target="_blank">'
+'<%=name%>'
+'</a> <a class="add-to-cart" href="#">buy</a>'),
events: {
'click .add-to-cart': 'addToCart'
},
render: function() {
this.$el.html(this.template(this.model.attributes));
},
addToCart: function(){
this.model.collection.trigger('addToCart', this.model);
}
});
...
47
Easy peasy! But what about the master view, which is supposed to render all of our items (apples)
and provide a wrapper <ul> container for <li> HTML elements? We need to modify and enhance
our homeView.
To begin with, we can add extra properties of string type understandable by jQuery as selectors to
homeView:
1
2
3
4
5
...
el: 'body',
listEl: '.apples-list',
cartEl: '.cart-box',
...
We can use properties from above in the template, or just hard-code them (well refactor our code
later) in homeView:
1
2
3
4
5
6
...
template: _.template('Apple data: \
<ul class="apples-list">\
</ul>\
<div class="cart-box"></div>'),
...
The initialize function will be called when homeView is created (new homeView()) in it we
render our template (with our favorite by now html() function), and attach an event listener to the
collection (which is a set of apple models):
1
2
3
4
5
6
...
initialize: function() {
this.$el.html(this.template);
this.collection.on('addToCart', this.showCart, this);
},
...
The syntax for the binding event is covered in the previous section. In essence, it is calling the
showCart() function of homeView. In this function, we append appleName to the cart (along with a
line break, a <br/> element):
1
2
3
4
5
48
...
showCart: function(appleModel) {
$(this.cartEl).append(appleModel.attributes.name+'<br/>');
},
...
Finally, here is our long-awaited render() method, in which we iterate through each model in the
collection (each apple), create an appleItemView for each apple, create an <li> element for each
apple, and append that element to view.listEl <ul> element with a class apples-list in the DOM:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
...
render: function(){
view = this;
//so we can use view inside of closure
this.collection.each(function(apple){
var appleSubView = new appleItemView({model:apple});
// creates subview with model apple
appleSubView.render();
// compiles template and single apple data
$(view.listEl).append(appleSubView.$el);
//append jQuery object from single
//apple to apples-list DOM element
});
}
...
Lets make sure we didnt miss anything in the homeView Backbone View:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
...
var homeView = Backbone.View.extend({
el: 'body',
listEl: '.apples-list',
cartEl: '.cart-box',
template: _.template('Apple data: \
<ul class="apples-list">\
</ul>\
<div class="cart-box"></div>'),
initialize: function() {
this.$el.html(this.template);
this.collection.on('addToCart', this.showCart, this);
},
showCart: function(appleModel) {
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
49
$(this.cartEl).append(appleModel.attributes.name+'<br/>');
},
render: function(){
view = this; //so we can use view inside of closure
this.collection.each(function(apple){
var appleSubView = new appleItemView({model:apple});
// create subview with model apple
appleSubView.render();
// compiles template and single apple data
$(view.listEl).append(appleSubView.$el);
//append jQuery object from single apple
//to apples-list DOM element
});
}
});
...
You should be able to click on the buy, and the cart will populate with the apples of your choice.
Looking at an individual apple does not require typing its name in the URL address bar of the browser
anymore. We can click on the name, and it opens a new window with a detailed view as illustrated
in Figure 3-1.
By using subviews, we reused the template for all of the items (apples) and attached a specific event
to each of them. Those events are smart enough to pass the information about the model to other
objects: views and collections.
Just in case, here is the full code for the subviews example, which is also available at rpjs/backbone/-
subview/index.html:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<!DOCTYPE>
<html>
<head>
<script src="jquery.js"></script>
<script src="underscore.js"></script>
<script src="backbone.js"></script>
<script>
var appleData = [
{
name: "fuji",
url: "img/fuji.jpg"
},
{
name: "gala",
url: "img/gala.jpg"
}
];
var app;
var router = Backbone.Router.extend({
routes: {
"": "home",
"apples/:appleName": "loadApple"
},
initialize: function(){
var apples = new Apples();
apples.reset(appleData);
this.homeView = new homeView({collection: apples});
this.appleView = new appleView({collection: apples});
},
home: function(){
this.homeView.render();
},
loadApple: function(appleName){
this.appleView.loadApple(appleName);
}
});
var appleItemView = Backbone.View.extend({
https://github.com/azat-co/rpjs/blob/master/backbone/subview/index.html
50
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
tagName: 'li',
// template: _.template(''
//
+'<a href="#apples/<%=name%>" target="_blank">'
//
+'<%=name%>'
//
+'</a> <a class="add-to-cart" href="#">buy</a>'),
template: _.template('\
<a href="#apples/<%=name%>" target="_blank">\
<%=name%>\
</a> <a class="add-to-cart" href="#">buy</a>\
'),
events: {
'click .add-to-cart': 'addToCart'
},
render: function() {
this.$el.html(this.template(this.model.attributes));
},
addToCart: function(){
this.model.collection.trigger('addToCart', this.model);
}
});
var homeView = Backbone.View.extend({
el: 'body',
listEl: '.apples-list',
cartEl: '.cart-box',
template: _.template('Apple data: \
<ul class="apples-list">\
</ul>\
<div class="cart-box"></div>'),
initialize: function() {
this.$el.html(this.template);
this.collection.on('addToCart', this.showCart, this);
},
showCart: function(appleModel) {
$(this.cartEl).append(appleModel.attributes.name+'<br/>');
},
render: function(){
view = this; //so we can use view inside of closure
this.collection.each(function(apple){
var appleSubView = new appleItemView({model:apple});
// create subview with model apple
51
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
appleSubView.render();
// compiles tempalte and single apple data
$(view.listEl).append(appleSubView.$el);
//append jQuery object from
//single apple to apples-list DOM element
});
}
});
var Apples = Backbone.Collection.extend({
});
var appleView = Backbone.View.extend({
initialize: function(){
this.model = new (Backbone.Model.extend({}));
this.model.on('change', this.render, this);
this.on('spinner',this.showSpinner, this);
},
template: _.template('<figure>\
<img src="<%= attributes.url %>"/>\
<figcaption><%= attributes.name %></figcaption>\
</figure>'),
templateSpinner: '<img src="img/spinner.gif" width="30"/>',
loadApple:function(appleName){
this.trigger('spinner');
var view = this;
//we'll need to access that inside of a closure
setTimeout(function(){
//simulates real time lag when fetching data
// from the remote server
view.model.set(view.collection.where({
name:appleName
})[0].attributes);
},1000);
},
render: function(appleName){
var appleHtml = this.template(this.model);
$('body').html(appleHtml);
},
showSpinner: function(){
$('body').html(this.templateSpinner);
}
52
124
125
126
127
128
129
130
131
132
133
134
135
136
53
});
$(document).ready(function(){
app = new router;
Backbone.history.start();
})
</script>
</head>
<body>
<div></div>
</body>
</html>
3.8 Conclusion
The already-mentioned in this chapter, and reputable Addys TodoMVC resource contains a lot
of browser JavaScript MV* frameworks with tutorials and examples. I often get asked What do
you think of X or Y? The main point is not to get into analysis paralysis when choosing a front-end
framework. Learn the foundation with Backbone.js, just because its not so bloated and complicated,
yet so widely-used and powerful in the right hands. Then pick a few newer and shinier libraries (e.g.,
React.js, Angular.js) and see how they fit the particular goals of project at hand.
https://github.com/azat-co/super-simple-backbone-starter-kit
http://azat.co
http://backboneboilerplate.com/
http://coenraets.org/blog/2012/02/sample-app-with-backbone-js-and-twitter-bootstrap/
https://github.com/documentcloud/backbone/wiki/Tutorials%2C-blog-posts-and-example-sites
https://github.com/addyosmani
http://todomvc.com/
55
56
So as you see, we can write JavaScript in the console all day long, but sometime we can to save script
so we can run them later.
57
58
management. CommonJS and RequireJS solve this problem with AJAX-y approach. Node.js
borrowed many things from the CommonJS concept.
To export an object in Node.js, use exports.name = object;, e.g.,
1
2
3
4
5
6
7
8
9
10
var messages = {
find: function(req, res, next) {
...
},
add: function(req, res, next) {
...
},
format: 'title | date | author'
}
exports.messages = messages;
While in the file where we import aforementioned script (assuming the path and the file name is
route/messages.js):
1
However, sometime its more fitting to invoke a constructor, e.g., when we attach properties
to Express.js app (more on Express.js in Express.js FUNdamentals: An Essential Overview of
Express.js). In this case module.exports is needed:
1
2
3
4
5
6
module.exports = function(app) {
app.set('port', process.env.PORT || 3000);
app.set('views', __dirname + '/views');
app.set('view engine', 'jade');
return app;
}
http://www.commonjs.org/
http://requirejs.org/
http://webapplog.com/express-js-fundamentals/
1
2
3
4
5
59
...
var app = express();
var config = require('./config/index.js');
app = config(app);
...
In addition, for the latter category its possible to use a longer looking statements with __dirname
and path.join(), e.g., require(path.join(__dirname, ,routes, messages));
If require() points to a folder, Node.js will attempt to read index.js file in that folder.
is an absolute path to the process that runs this script. The latter might not be the same as the former
if we started the program from a different folder, e.g., $ node ./code/program.js.
60
URL
Crypto
Path
String Decoder
The method that we use in this tutorials is path.join and it concatenates path using an appropriate
folder separator (/ or \\).
var fs = require('fs');
var path = require('path');
fs.readFile(path.join(__dirname, '/data/customers.csv'), {encoding: 'utf-8'}, fu\
nction (err, data) {
if (err) throw err;
console.log(data);
});
var fs = require('fs');
fs.writeFile('message.txt', 'Hello World!', function (err) {
if (err) throw err;
console.log('Writing is done.');
});
1
2
61
var fs = require('fs');
fs.createReadStream('./data/customers.csv').pipe(process.stdout);
http://npmjs.org/stream-adventure
https://github.com/substack/stream-handbook
https://npmjs.org/doc/files/npm-folders.html
http://npmjs.org/doc/misc/npm-faq.html#Is-it-npm-or-NPM-or-Npm
1
2
3
4
5
6
62
The req and res parameters have all the information about a given HTTP request and response
correspondingly. In addition, req and res can be used as streams (look in the previous section).
14
15
16
17
18
19
20
21
22
23
24
25
63
Theres nothing to be afraid of here as long as two-space indentation is used. ;-) However, callback
code can be re-write with the use of event emitters, promises or by utilizing the async library.
64
http://expressjsguide.com
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
var
var
var
var
var
66
express = require('express');
routes = require('./routes');
user = require('./routes/user');
http = require('http');
path = require('path');
...
app.get('/', routes.index);
app.get('/users', user.list);
...
The first one is basically takes care of all the requests to the home page, e.g., http://localhost:3000/
and the latter of requests to /users, such as http://localhost:3000/users. Both of the routes
process URLs case insensitively and in a same manner as with trailing slashes.
67
The request handler itself (index.js in this case) is straightforward: everything from the HTTP
request is in req and write results to the response in res:
1
2
3
app.use(express.favicon());
app.use(express.logger('dev'));
app.use(express.bodyParser());
app.use(express.methodOverride());
app.use(app.router);
app.use(express.static(path.join(__dirname, 'public')));
The middleware is a pass thru functions that add something useful to the request as it travels along
each of them, for example req.body or req.cookie. For more middleware writings check out Intro
to Express.js: Parameters, Error Handling and Other Middleware.
An ordinary settings involves a name (e.g., views) and a value (e.g., path to the folder where out
templates/views live). There is more than one way to define a certain settings, e.g, app.enable for
boolean flags.
1
2
3
4
5
6
7
68
doctype 5
html
head
title= title
link(rel='stylesheet', href='/stylesheets/style.css')
body
block content
Other than that, its possible to utilize full-blown JavaScript code inside of Jade templates.
5.8 ExpressWorks
After youve mastered Node.js and Express.js basics in this book, you might want to consider
working on ExpressWorks(Figure 5-1). This is an interactive class about the Express.js framework
which is as of today is the most popular module on NPM.
http://webapplog.com/tutorial-node-js-and-mongodb-json-rest-api-server-with-mongoskin-and-express-js/
http://webapplog.com/intro-to-express-js-simple-rest-api-app-with-monk-and-mongodb/
http://expressjs.com/api.html
http://www.senchalabs.org/connect/
http://expressjsguide.com
http://webapplog.com/expressworks
http://webapplog.com/expressworks
69
5.9 Update
For migrating from Express.js 3.x to 4.x take a look at this guide: Migrating Express.js 3.x to 4.x:
Middleware, Route and Other Changes.
Share on Twitter with ClickToTweet link: http://clicktotweet.com/HDUx0, or just click:
Ive finished JavaScript and Node.js FUNdamentals: A Collection of Essential Basics
by @azat_co #nodejs https://leanpub.com/jsfun
http://webapplog.com/migrating-express-js-3-x-to-4-x-middleware-route-and-other-changes/
http://ctt.ec/VQcEb
Azat Mardan has over 12 years of experience in web, mobile and software development. With a
Bachelors Degree in Informatics and a Master of Science in Information Systems Technology
degree, Azat possesses deep academic knowledge as well as extensive practical experience.
Currently, Azat works as a Software Engineer Team Lead at DocuSign, where his team rebuilds 50
million user product (DocuSign web app) using the tech stack of Node.js, Express.js, Backbone.js,
CoffeeScript, Jade, Stylus and Redis.
Recently, he worked as an engineer at the curated social media news aggregator website Storify.com
(acquired by LiveFyre). Before that, Azat worked as a CTO/co-founder at Gizmo an enterprise
cloud platform for mobile marketing campaigns, and he has undertaken the prestigious 500
Startups business accelerator program. Previously, he was developing mission-critical applications
for government agencies in Washington, DC: National Institutes of Health, National Center for
Biotechnology Information, Federal Deposit Insurance Corporation, and Lockheed Martin. Azat
is a frequent attendee at Bay Area tech meet-ups and hackathons (AngelHack, and was a hackathon
2012 finalist with team FashionMetric.com).
http://docusign.com
http://storify.com
http://livefyre.com
http://www.crunchbase.com/company/gizmo
http://500.co/
http://nih.gov
http://ncbi.nlm.nih.gov
http://fdic.gov
http://lockheedmartin.com
http://angelhack.com
http://fashionmetric.com
71
In addition, Azat teaches technical classes at General Assembly and Hack Reactor, pariSOMA
and Marakana (acquired by Twitter) to much acclaim.
In his spare time, he writes about technology on his blog: webAppLog.com which is number one
in express.js tutorial Google search results. Azat is also the author of Express.js Guide, Rapid
Prototyping with JS and Oh My JS.
http://generalassemb.ly
http://hackreactor.com
http://parisoma.com
http://marakana.com
http://webapplog.com
http://expressjsguide.com/assets/img/expressjs-tutorial.png
http://expressjsguide.com
http://rpjs.co
http://leanpub.com/ohmyjs
7. Review
If you liked this book (or not), please leave your review on the Amazom page.
http://amzn.to/19qbVzn
8. Errata
Please help us make this book better by submitting issues via other means of communication listed
below in the Contact Us section.
9. Contact Us
Lets be friends on the Internet!
Tweet Node.js question on Twitter: @azat_co
Follow Azat on Facebook: facebook.com/profile.php?id=1640484994
GitHub: github.com/azat-co
Other Ways to Reach Us
https://twitter.com/azat_co
https://www.facebook.com/profile.php?id=1640484994
https://github.com/azat-co
mailto:hi@azat.co
mailto:rpjs@googlegroups.com
http://webapplog.com
http://hackhall.com
http://ctt.ec/VQcEb