2009-12-21 16:41:45 +00:00
2009-12-20 03:55:58 +00:00
<!DOCTYPE html>
< html >
< head >
< meta http-equiv = "content-type" content = "text/html;charset=UTF-8" / >
2009-12-24 01:24:55 +00:00
< title > CoffeeScript< / title >
2009-12-21 16:41:45 +00:00
< link rel = "stylesheet" type = "text/css" href = "documentation/css/docs.css" / >
< link rel = "stylesheet" type = "text/css" href = "documentation/css/idle.css" / >
2009-12-20 03:55:58 +00:00
< / head >
< body >
< div class = "container" >
2009-12-21 16:41:45 +00:00
< h1 > < sub style = "font-size: 100px;" > ☕ < / sub > CoffeeScript< / h1 >
2009-12-20 03:55:58 +00:00
< p >
CoffeeScript is a little language that compiles into JavaScript. Think
2009-12-24 00:42:18 +00:00
of it as JavaScript's less ostentatious kid brother — the same genes,
2009-12-24 08:12:07 +00:00
roughly the same height, but a different sense of style. Apart from a handful of
2009-12-24 01:24:55 +00:00
bonus goodies, statements in CoffeeScript correspond one-to-one with their
2009-12-24 00:42:18 +00:00
equivalent in JavaScript, it's just another way of saying it.
2009-12-21 16:41:45 +00:00
< / p >
< p >
2009-12-22 17:18:27 +00:00
< b > Disclaimer:< / b >
2009-12-24 06:22:41 +00:00
CoffeeScript is just for fun and seriously alpha. I'm sure that there are still
2009-12-24 07:01:39 +00:00
plenty of holes in the lexer and leaks in the syntax. < i > There is no guarantee,
2009-12-24 00:42:18 +00:00
explicit or implied, of its suitability for any purpose.< / i > That said,
it compiles into clean JavaScript (the good parts) that can use existing
2009-12-24 07:01:39 +00:00
JavaScript libraries seamlessly, and passes through
2009-12-24 00:42:18 +00:00
< a href = "http://www.jslint.com/" > JSLint< / a > without warnings. The compiled
2009-12-24 01:57:35 +00:00
output is quite readable — pretty-printed, with comments
2009-12-24 00:42:18 +00:00
preserved intact.
2009-12-21 16:41:45 +00:00
< / p >
2010-01-05 03:19:45 +00:00
2010-01-05 00:15:24 +00:00
< p >
< b > Latest Version:< / b >
2010-01-10 19:45:44 +00:00
< a href = "http://gemcutter.org/gems/coffee-script" > 0.2.2< / a >
2010-01-05 00:15:24 +00:00
< / p >
2009-12-21 16:41:45 +00:00
< h2 > Table of Contents< / h2 >
< p >
2009-12-24 00:42:18 +00:00
< a href = "#overview" > Mini Overview< / a > < br / >
< a href = "#installation" > Installation and Usage< / a > < br / >
2010-01-05 03:19:45 +00:00
< a href = "#whitespace" > Significant Whitespace< / a > < br / >
2009-12-21 16:41:45 +00:00
< a href = "#functions" > Functions and Invocation< / a > < br / >
< a href = "#assignment" > Assignment< / a > < br / >
2009-12-24 00:42:18 +00:00
< a href = "#objects_and_arrays" > Objects and Arrays< / a > < br / >
2009-12-21 16:41:45 +00:00
< a href = "#lexical_scope" > Lexical Scoping and Variable Safety< / a > < br / >
< a href = "#conditionals" > Conditionals, Ternaries, and Conditional Assignment< / a > < br / >
2010-01-05 03:19:45 +00:00
< a href = "#existence" > The Existence Operator< / a > < br / >
2009-12-24 07:01:39 +00:00
< a href = "#aliases" > Aliases< / a > < br / >
2010-01-06 02:40:36 +00:00
< a href = "#splats" > Splats...< / a > < br / >
2010-01-05 14:29:10 +00:00
< a href = "#arguments" > Arguments are Arrays< / a > < br / >
2009-12-21 16:41:45 +00:00
< a href = "#while" > While Loops< / a > < br / >
2010-01-05 03:19:45 +00:00
< a href = "#comprehensions" > Comprehensions (Arrays, Objects, and Ranges)< / a > < br / >
< a href = "#slice_splice" > Array Slicing and Splicing with Ranges< / a > < br / >
2010-01-05 03:51:02 +00:00
< a href = "#expressions" > Everything is an Expression< / a > < br / >
2009-12-25 00:49:23 +00:00
< a href = "#inheritance" > Inheritance, and Calling Super from a Subclass< / a > < br / >
2010-01-05 04:26:27 +00:00
< a href = "#blocks" > Blocks< / a > < br / >
2009-12-21 16:41:45 +00:00
< a href = "#embedded" > Embedded JavaScript< / a > < br / >
2009-12-24 09:33:59 +00:00
< a href = "#switch" > Switch/When/Else< / a > < br / >
2009-12-21 16:41:45 +00:00
< a href = "#try" > Try/Catch/Finally< / a > < br / >
< a href = "#strings" > Multiline Strings< / a > < br / >
2009-12-26 17:05:57 +00:00
< a href = "#resources" > Resources< / a > < br / >
2009-12-24 17:54:12 +00:00
< a href = "#contributing" > Contributing< / a > < br / >
2009-12-24 08:12:07 +00:00
< a href = "#change_log" > Change Log< / a > < br / >
2009-12-21 16:41:45 +00:00
< / p >
2009-12-31 18:01:10 +00:00
2009-12-24 00:42:18 +00:00
< h2 id = "overview" > Mini Overview< / h2 >
< p > < i > CoffeeScript on the left, compiled JavaScript output on the right.< / i > < / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > < span class = "Comment" > < span class = "Comment" > #< / span > Assignment:< / span >
number< span class = "Keyword" > :< / span > < span class = "Number" > 42< / span >
opposite_day< span class = "Keyword" > :< / span > < span class = "BuiltInConstant" > true< / span >
2009-12-24 00:42:18 +00:00
2009-12-31 18:01:10 +00:00
< span class = "Comment" > < span class = "Comment" > #< / span > Conditions:< / span >
number< span class = "Keyword" > :< / span > < span class = "Keyword" > -< / span > < span class = "Number" > 42< / span > < span class = "Keyword" > if< / span > opposite_day
2009-12-24 00:42:18 +00:00
2009-12-31 18:01:10 +00:00
< span class = "Comment" > < span class = "Comment" > #< / span > Functions:< / span >
< span class = "FunctionName" > square< / span > < span class = "Keyword" > :< / span > < span class = "FunctionArgument" > x< / span > < span class = "Storage" > => < / span > x < span class = "Keyword" > *< / span > x
2009-12-24 00:42:18 +00:00
2009-12-31 18:01:10 +00:00
< span class = "Comment" > < span class = "Comment" > #< / span > Arrays:< / span >
list< span class = "Keyword" > :< / span > [< span class = "Number" > 1< / span > , < span class = "Number" > 2< / span > , < span class = "Number" > 3< / span > , < span class = "Number" > 4< / span > , < span class = "Number" > 5< / span > ]
2009-12-24 00:42:18 +00:00
2009-12-31 18:01:10 +00:00
< span class = "Comment" > < span class = "Comment" > #< / span > Objects:< / span >
math< span class = "Keyword" > :< / span > {
root< span class = "Keyword" > :< / span > Math.sqrt
square< span class = "Keyword" > :< / span > square
< span class = "FunctionName" > cube< / span > < span class = "Keyword" > :< / span > < span class = "FunctionArgument" > x< / span > < span class = "Storage" > => < / span > x < span class = "Keyword" > *< / span > square(x)
2009-12-24 00:42:18 +00:00
}
2010-01-05 05:34:18 +00:00
< span class = "Comment" > < span class = "Comment" > #< / span > Splats:< / span >
2010-01-06 02:40:36 +00:00
race< span class = "Keyword" > :< / span > < span class = "FunctionArgument" > winner, runners... < / span > < span class = "Storage" > => < / span >
2010-01-05 05:34:18 +00:00
print(winner, runners)
< span class = "Comment" > < span class = "Comment" > #< / span > Existence:< / span >
alert(< span class = "String" > < span class = "String" > " < / span > I knew it!< span class = "String" > " < / span > < / span > ) < span class = "Keyword" > if< / span > elvis< span class = "Keyword" > ?< / span >
2009-12-31 18:01:10 +00:00
< span class = "Comment" > < span class = "Comment" > #< / span > Array comprehensions:< / span >
cubed_list< span class = "Keyword" > :< / span > math.cube(num) < span class = "Keyword" > for< / span > num < span class = "Keyword" > in< / span > list
2010-01-10 20:52:23 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > __a, __b, __c, cubed_list, list, math, num, number, opposite_day, race, square;
2009-12-24 00:42:18 +00:00
< span class = "Comment" > < span class = "Comment" > //< / span > Assignment:< / span >
2009-12-26 07:17:34 +00:00
number < span class = "Keyword" > =< / span > < span class = "Number" > 42< / span > ;
opposite_day < span class = "Keyword" > =< / span > < span class = "BuiltInConstant" > true< / span > ;
2009-12-24 00:42:18 +00:00
< span class = "Comment" > < span class = "Comment" > //< / span > Conditions:< / span >
< span class = "Keyword" > if< / span > (opposite_day) {
number < span class = "Keyword" > =< / span > < span class = "Keyword" > -< / span > < span class = "Number" > 42< / span > ;
}
< span class = "Comment" > < span class = "Comment" > //< / span > Functions:< / span >
2009-12-31 04:43:55 +00:00
square < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > square< / span > (< span class = "FunctionArgument" > x< / span > ) {
2009-12-24 00:42:18 +00:00
< span class = "Keyword" > return< / span > x < span class = "Keyword" > *< / span > x;
};
< span class = "Comment" > < span class = "Comment" > //< / span > Arrays:< / span >
2009-12-26 07:17:34 +00:00
list < span class = "Keyword" > =< / span > [< span class = "Number" > 1< / span > , < span class = "Number" > 2< / span > , < span class = "Number" > 3< / span > , < span class = "Number" > 4< / span > , < span class = "Number" > 5< / span > ];
2009-12-24 00:42:18 +00:00
< span class = "Comment" > < span class = "Comment" > //< / span > Objects:< / span >
2009-12-26 07:17:34 +00:00
math < span class = "Keyword" > =< / span > {
2009-12-24 00:42:18 +00:00
root: < span class = "LibraryClassType" > Math< / span > .sqrt,
square: square,
2009-12-31 04:43:55 +00:00
cube: < span class = "Storage" > function< / span > < span class = "FunctionName" > cube< / span > (< span class = "FunctionArgument" > x< / span > ) {
2009-12-24 00:42:18 +00:00
< span class = "Keyword" > return< / span > x < span class = "Keyword" > *< / span > square(x);
}
};
2010-01-05 05:34:18 +00:00
< span class = "Comment" > < span class = "Comment" > //< / span > Splats:< / span >
race < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > race< / span > (< span class = "FunctionArgument" > winner< / span > ) {
< span class = "Storage" > var< / span > runners;
runners < span class = "Keyword" > =< / span > < span class = "LibraryClassType" > Array< / span > .< span class = "LibraryConstant" > prototype< / span > .slice.< span class = "LibraryFunction" > call< / span > (arguments, < span class = "Number" > 1< / span > );
< span class = "Keyword" > return< / span > < span class = "LibraryFunction" > print< / span > (winner, runners);
};
< span class = "Comment" > < span class = "Comment" > //< / span > Existence:< / span >
< span class = "Keyword" > if< / span > ((< span class = "Keyword" > typeof< / span > elvis < span class = "Keyword" > !< / span > < span class = "Keyword" > ==< / span > < span class = "String" > < span class = "String" > " < / span > undefined< span class = "String" > " < / span > < / span > < span class = "Keyword" > & < / span > < span class = "Keyword" > & < / span > elvis < span class = "Keyword" > !< / span > < span class = "Keyword" > ==< / span > < span class = "BuiltInConstant" > null< / span > )) {
< span class = "LibraryFunction" > alert< / span > (< span class = "String" > < span class = "String" > " < / span > I knew it!< span class = "String" > " < / span > < / span > );
}
2009-12-24 00:42:18 +00:00
< span class = "Comment" > < span class = "Comment" > //< / span > Array comprehensions:< / span >
2010-01-05 00:15:24 +00:00
cubed_list < span class = "Keyword" > =< / span > (< span class = "Storage" > function< / span > () {
2010-01-10 19:45:44 +00:00
__c < span class = "Keyword" > =< / span > []; __a < span class = "Keyword" > =< / span > list;
< span class = "Keyword" > for< / span > (__b< span class = "Keyword" > =< / span > < span class = "Number" > 0< / span > ; __b< span class = "Keyword" > < < / span > __a.< span class = "LibraryConstant" > length< / span > ; __b< span class = "Keyword" > ++< / span > ) {
num < span class = "Keyword" > =< / span > __a[__b];
__c.< span class = "LibraryFunction" > push< / span > (math.cube(num));
2009-12-31 21:50:46 +00:00
}
2010-01-05 00:15:24 +00:00
< span class = "Keyword" > return< / span > __c;
})();
2010-01-10 20:52:23 +00:00
< / pre > < button onclick = 'javascript: var __a , __b , __c , cubed_list , list , math , num , number , opposite_day , race , square ;
2009-12-24 00:42:18 +00:00
// Assignment:
2009-12-26 07:17:34 +00:00
number = 42;
opposite_day = true;
2009-12-24 00:42:18 +00:00
// Conditions:
if (opposite_day) {
number = -42;
}
// Functions:
2009-12-31 04:43:55 +00:00
square = function square(x) {
2009-12-24 00:42:18 +00:00
return x * x;
};
// Arrays:
2009-12-26 07:17:34 +00:00
list = [1, 2, 3, 4, 5];
2009-12-24 00:42:18 +00:00
// Objects:
2009-12-26 07:17:34 +00:00
math = {
2009-12-24 00:42:18 +00:00
root: Math.sqrt,
square: square,
2009-12-31 04:43:55 +00:00
cube: function cube(x) {
2009-12-24 00:42:18 +00:00
return x * square(x);
}
};
2010-01-05 05:34:18 +00:00
// Splats:
race = function race(winner) {
var runners;
runners = Array.prototype.slice.call(arguments, 1);
return print(winner, runners);
};
// Existence:
if ((typeof elvis !== "undefined" & & elvis !== null)) {
alert("I knew it!");
}
2009-12-24 00:42:18 +00:00
// Array comprehensions:
2010-01-05 00:15:24 +00:00
cubed_list = (function() {
2010-01-10 19:45:44 +00:00
__c = []; __a = list;
for (__b=0; __b< __a.length ; __b + + ) {
num = __a[__b];
__c.push(math.cube(num));
2009-12-31 21:50:46 +00:00
}
2010-01-05 00:15:24 +00:00
return __c;
})();
2009-12-24 00:42:18 +00:00
;alert(cubed_list);'>run: cubed_list< / button > < br class = 'clear' / > < / div >
2010-01-05 04:26:27 +00:00
2010-01-05 03:51:02 +00:00
< p >
2010-01-05 04:26:27 +00:00
For a longer CoffeeScript example, check out
2010-01-05 03:51:02 +00:00
< a href = "documentation/underscore.html" > Underscore.coffee< / a > , a port
of < a href = "http://documentcloud.github.com/underscore/" > Underscore.js< / a >
2010-01-05 05:34:18 +00:00
to CoffeeScript, which, when compiled, can pass the complete Underscore test suite.
2010-01-05 14:29:10 +00:00
Or, clone the source and take a look in the
2010-01-05 05:45:04 +00:00
< a href = "http://github.com/jashkenas/coffee-script/tree/master/examples/" > examples< / a > folder.
2010-01-05 03:51:02 +00:00
< / p >
2009-12-24 00:42:18 +00:00
< h2 id = "installation" > Installation and Usage< / h2 >
2009-12-25 08:16:56 +00:00
2009-12-24 08:12:07 +00:00
< p >
The CoffeeScript compiler is written in pure Ruby, and is available
as a Ruby Gem.
< / p >
2009-12-24 00:42:18 +00:00
< pre >
2009-12-24 08:12:07 +00:00
gem install coffee-script< / pre >
2009-12-24 00:42:18 +00:00
< p >
2009-12-26 16:57:13 +00:00
Installing the gem provides the < tt > coffee< / tt > command, which can
2009-12-25 22:18:05 +00:00
be used to compile CoffeeScript < tt > .coffee< / tt > files into JavaScript, as
well as debug them. In conjunction with
2009-12-26 16:57:13 +00:00
< a href = "http://narwhaljs.org/" > Narwhal< / a > , the < tt > coffee< / tt >
2009-12-25 22:18:05 +00:00
command also provides direct evaluation and an interactive REPL.
2009-12-26 16:57:13 +00:00
When compiling to JavaScript, < tt > coffee< / tt > writes the output
2009-12-25 08:16:56 +00:00
as < tt > .js< / tt > files in the same directory by default, but output
2009-12-24 00:42:18 +00:00
can be customized with the following options:
< / p >
< table >
< tr >
2009-12-25 08:16:56 +00:00
< td width = "25%" > < code > -i, --interactive< / code > < / td >
< td >
2009-12-25 22:18:05 +00:00
Launch an interactive CoffeeScript session.
2009-12-25 08:16:56 +00:00
Requires < a href = "http://narwhaljs.org/" > Narwhal< / a > .
< / td >
< / tr >
< tr >
< td > < code > -r, --run< / code > < / td >
< td >
2010-01-05 04:26:27 +00:00
Compile and execute scripts without saving the intermediate
2009-12-25 08:16:56 +00:00
JavaScript. Requires < a href = "http://narwhaljs.org/" > Narwhal< / a > .
< / td >
< / tr >
< tr >
< td > < code > -o, --output [DIR]< / code > < / td >
2009-12-24 00:42:18 +00:00
< td >
Write out all compiled JavaScript files into the specified directory.
< / td >
< / tr >
< tr >
< td > < code > -w, --watch< / code > < / td >
< td >
2009-12-24 07:01:39 +00:00
Watch the modification times of the coffee-scripts, recompiling as
2009-12-24 00:42:18 +00:00
soon as a change occurs.
< / td >
< / tr >
< tr >
< td > < code > -p, --print< / code > < / td >
< td >
Instead of writing out the JavaScript as a file, print it
directly to < b > stdout< / b > .
< / td >
< / tr >
< tr >
< td > < code > -l, --lint< / code > < / td >
< td >
If the < tt > jsl< / tt > (JavaScript Lint) command is installed, use it
2009-12-25 08:16:56 +00:00
to check the compilation of a CoffeeScript file. (Handy in
2009-12-24 07:01:39 +00:00
conjunction with < tt > --watch< / tt > )
2009-12-24 00:42:18 +00:00
< / td >
< / tr >
< tr >
< td > < code > -e, --eval< / code > < / td >
< td >
Compile and print a little snippet of CoffeeScript directly from the
2010-01-05 04:26:27 +00:00
command line (or from < b > stdin< / b > ). For example:< br / > < tt > coffee -e "square: x => x * x"< / tt >
2009-12-24 00:42:18 +00:00
< / td >
< / tr >
< tr >
< td > < code > -t, --tokens< / code > < / td >
< td >
Instead of parsing the CoffeeScript, just lex it, and print out the
token stream: < tt > [:IDENTIFIER, "square"], [":", ":"], [:PARAM, "x"]< / tt > ...
< / td >
< / tr >
< tr >
< td > < code > -v, --verbose< / code > < / td >
< td >
As the JavaScript is being generated, print out every step of code
generation, including lexical scope and the node in the
AST.
< / td >
< / tr >
2009-12-25 01:37:24 +00:00
< tr >
< td > < code > -n, --no-wrap< / code > < / td >
< td >
Compile the JavaScript without the top-level function safety wrapper
or var declarations, for situations where you want to add every
variable to global scope.
< / td >
< / tr >
2009-12-24 07:01:39 +00:00
< tr >
< td > < code > --install-bundle< / code > < / td >
< td >
Install the TextMate bundle for CoffeeScript syntax highlighting.
< / td >
< / tr >
2009-12-24 00:42:18 +00:00
< / table >
< p >
< b > Examples:< / b >
< / p >
< pre >
2009-12-26 16:57:13 +00:00
coffee path/to/script.coffee
coffee --interactive
coffee --watch --lint experimental.coffee
coffee --print app/scripts/*.coffee > concatenation.js< / pre >
2009-12-24 00:42:18 +00:00
< h2 > Language Reference< / h2 >
2009-12-21 16:41:45 +00:00
< p >
2009-12-24 00:42:18 +00:00
< i >
2009-12-24 17:56:44 +00:00
This reference is structured so that it can be read from top to bottom,
2009-12-24 00:42:18 +00:00
if you like. Later sections use ideas and syntax previously introduced.
2009-12-24 07:01:39 +00:00
Familiarity with JavaScript is assumed.
2009-12-24 00:42:18 +00:00
In all of the following examples, the source CoffeeScript is provided on
the left, and the direct compilation into JavaScript is on the right.
< / i >
2009-12-21 16:41:45 +00:00
< / p >
2010-01-05 03:19:45 +00:00
< p id = "whitespace" >
< b class = "header" > Significant Whitespace< / b >
CoffeeScript uses Python-style significant whitespace: You don't need to
use semicolons < tt > ;< / tt > to terminate expressions, ending
the line will do just as well. Semicolons can still be used to fit
multiple expressions onto a single line. Instead of using curly braces
2010-01-05 05:19:22 +00:00
< tt > { }< / tt > to delimit blocks of code (like < a href = "#functions" > functions< / a > ,
2009-12-25 08:16:56 +00:00
< a href = "#conditionals" > if-statements< / a > ,
2010-01-05 03:19:45 +00:00
< a href = "#switch" > switch< / a > , and < a href = "#try" > try/catch< / a > ),
use indentation.
2009-12-24 00:42:18 +00:00
< / p >
2010-01-06 02:40:36 +00:00
< p >
You can use newlines to break up your expression into smaller pieces,
2010-01-10 19:45:44 +00:00
as long as CoffeeScript can tell that the line hasn't finished
2010-01-06 02:40:36 +00:00
(similar to how Ruby handles it). For example,
if the line ends in an operator, dot, or keyword.
< / p >
2009-12-24 00:42:18 +00:00
< p id = "functions" >
< b class = "header" > Functions and Invocation< / b >
2009-12-25 08:16:56 +00:00
Functions are defined by a list of parameters, an arrow, and the
2010-01-05 04:26:27 +00:00
function body. The empty function looks like this: < tt > =>< / tt > . All
functions in CoffeeScript are named, for the benefit of debug messages.
2009-12-24 00:42:18 +00:00
< / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > < span class = "FunctionName" > square< / span > < span class = "Keyword" > :< / span > < span class = "FunctionArgument" > x< / span > < span class = "Storage" > => < / span > x < span class = "Keyword" > *< / span > x
< span class = "FunctionName" > cube< / span > < span class = "Keyword" > :< / span > < span class = "FunctionArgument" > x< / span > < span class = "Storage" > => < / span > square(x) < span class = "Keyword" > *< / span > x
2009-12-26 07:17:34 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > cube, square;
2009-12-31 04:43:55 +00:00
square < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > square< / span > (< span class = "FunctionArgument" > x< / span > ) {
2009-12-21 16:41:45 +00:00
< span class = "Keyword" > return< / span > x < span class = "Keyword" > *< / span > x;
};
2009-12-31 04:43:55 +00:00
cube < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > cube< / span > (< span class = "FunctionArgument" > x< / span > ) {
2009-12-21 16:41:45 +00:00
< span class = "Keyword" > return< / span > square(x) < span class = "Keyword" > *< / span > x;
};
2009-12-26 07:17:34 +00:00
< / pre > < button onclick = 'javascript: var cube , square ;
2009-12-31 04:43:55 +00:00
square = function square(x) {
2009-12-21 16:41:45 +00:00
return x * x;
};
2009-12-31 04:43:55 +00:00
cube = function cube(x) {
2009-12-21 16:41:45 +00:00
return square(x) * x;
};
;alert(cube(5));'>run: cube(5)< / button > < br class = 'clear' / > < / div >
2009-12-24 00:42:18 +00:00
< p id = "assignment" >
< b class = "header" > Assignment< / b >
Use a colon < tt > :< / tt > to assign, as in
< a href = "http://json.org" > JSON< / a > . Equal signs are only needed for
mathy things.
< / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > greeting< span class = "Keyword" > :< / span > < span class = "String" > < span class = "String" > " < / span > Hello CoffeeScript< span class = "String" > " < / span > < / span >
difficulty< span class = "Keyword" > :< / span > < span class = "Number" > 0.5< / span >
2009-12-26 07:17:34 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > difficulty, greeting;
greeting < span class = "Keyword" > =< / span > < span class = "String" > < span class = "String" > " < / span > Hello CoffeeScript< span class = "String" > " < / span > < / span > ;
difficulty < span class = "Keyword" > =< / span > < span class = "Number" > 0.5< / span > ;
< / pre > < button onclick = 'javascript: var difficulty , greeting ;
greeting = "Hello CoffeeScript";
difficulty = 0.5;
2009-12-24 00:42:18 +00:00
;alert(greeting);'>run: greeting< / button > < br class = 'clear' / > < / div >
2009-12-26 07:17:34 +00:00
< p >
2010-01-05 03:19:45 +00:00
Declarations of new variables are pushed up to the top of the nearest
2010-01-05 04:26:27 +00:00
lexical scope, so that assignment may always be performed within expressions.
2009-12-26 07:17:34 +00:00
< / p >
2009-12-24 00:42:18 +00:00
< p id = "objects_and_arrays" >
< b class = "header" > Objects and Arrays< / b >
Object and Array literals look very similar to their JavaScript cousins.
When you spread out each assignment on a separate line, the commas are
optional. In this way, assigning object properties looks the same as
2010-01-05 03:19:45 +00:00
assigning local variables, and can be moved around freely. You can mix
and match the two styles.
2009-12-24 00:42:18 +00:00
< / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > song< span class = "Keyword" > :< / span > [< span class = "String" > < span class = "String" > " < / span > do< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > re< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > mi< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > fa< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > so< span class = "String" > " < / span > < / span > ]
2010-01-05 03:19:45 +00:00
2009-12-31 18:01:10 +00:00
ages< span class = "Keyword" > :< / span > {
max< span class = "Keyword" > :< / span > < span class = "Number" > 10< / span >
ida< span class = "Keyword" > :< / span > < span class = "Number" > 9< / span >
tim< span class = "Keyword" > :< / span > < span class = "Number" > 11< / span >
2009-12-21 16:41:45 +00:00
}
2010-01-05 03:19:45 +00:00
matrix< span class = "Keyword" > :< / span > [
< span class = "Number" > 1< / span > , < span class = "Number" > 0< / span > , < span class = "Number" > 1< / span >
< span class = "Number" > 0< / span > , < span class = "Number" > 0< / span > , < span class = "Number" > 1< / span >
< span class = "Number" > 1< / span > , < span class = "Number" > 1< / span > , < span class = "Number" > 0< / span >
]
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > ages, matrix, song;
2009-12-26 07:17:34 +00:00
song < span class = "Keyword" > =< / span > [< span class = "String" > < span class = "String" > " < / span > do< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > re< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > mi< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > fa< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > so< span class = "String" > " < / span > < / span > ];
ages < span class = "Keyword" > =< / span > {
2009-12-21 16:41:45 +00:00
max: < span class = "Number" > 10< / span > ,
ida: < span class = "Number" > 9< / span > ,
tim: < span class = "Number" > 11< / span >
};
2010-01-05 03:19:45 +00:00
matrix < span class = "Keyword" > =< / span > [< span class = "Number" > 1< / span > , < span class = "Number" > 0< / span > , < span class = "Number" > 1< / span > , < span class = "Number" > 0< / span > , < span class = "Number" > 0< / span > , < span class = "Number" > 1< / span > , < span class = "Number" > 1< / span > , < span class = "Number" > 1< / span > , < span class = "Number" > 0< / span > ];
< / pre > < button onclick = 'javascript: var ages , matrix , song ;
2009-12-26 07:17:34 +00:00
song = ["do", "re", "mi", "fa", "so"];
ages = {
2009-12-21 16:41:45 +00:00
max: 10,
ida: 9,
tim: 11
};
2010-01-05 03:19:45 +00:00
matrix = [1, 0, 1, 0, 0, 1, 1, 1, 0];
2009-12-21 16:41:45 +00:00
;alert(song.join(","));'>run: song.join(",")< / button > < br class = 'clear' / > < / div >
2009-12-24 00:42:18 +00:00
< p id = "lexical_scope" >
< b class = "header" > Lexical Scoping and Variable Safety< / b >
The CoffeeScript compiler takes care to make sure that all of your variables
2009-12-24 07:01:39 +00:00
are properly declared within lexical scope — you never need to write
< tt > var< / tt > yourself.
2009-12-24 00:42:18 +00:00
< / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > num< span class = "Keyword" > :< / span > < span class = "Number" > 1< / span >
< span class = "FunctionName" > change_numbers< / span > < span class = "Keyword" > :< / span > < span class = "Storage" > => < / span >
2010-01-05 03:19:45 +00:00
new_num< span class = "Keyword" > :< / span > < span class = "Keyword" > -< / span > < span class = "Number" > 1< / span >
num< span class = "Keyword" > :< / span > < span class = "Number" > 10< / span >
2009-12-31 18:01:10 +00:00
new_num< span class = "Keyword" > :< / span > change_numbers()
2009-12-26 07:17:34 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > change_numbers, new_num, num;
num < span class = "Keyword" > =< / span > < span class = "Number" > 1< / span > ;
2009-12-31 04:43:55 +00:00
change_numbers < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > change_numbers< / span > () {
2009-12-26 07:17:34 +00:00
< span class = "Storage" > var< / span > new_num;
2010-01-05 03:19:45 +00:00
new_num < span class = "Keyword" > =< / span > < span class = "Keyword" > -< / span > < span class = "Number" > 1< / span > ;
< span class = "Keyword" > return< / span > num < span class = "Keyword" > =< / span > < span class = "Number" > 10< / span > ;
2009-12-21 16:41:45 +00:00
};
2009-12-26 07:17:34 +00:00
new_num < span class = "Keyword" > =< / span > change_numbers();
< / pre > < button onclick = 'javascript: var change_numbers , new_num , num ;
num = 1;
2009-12-31 04:43:55 +00:00
change_numbers = function change_numbers() {
2009-12-26 07:17:34 +00:00
var new_num;
2010-01-05 03:19:45 +00:00
new_num = -1;
return num = 10;
2009-12-21 16:41:45 +00:00
};
2009-12-26 07:17:34 +00:00
new_num = change_numbers();
2009-12-21 16:41:45 +00:00
;alert(new_num);'>run: new_num< / button > < br class = 'clear' / > < / div >
2009-12-24 00:42:18 +00:00
< p >
2010-01-05 03:19:45 +00:00
Notice how the all of the variable declarations have been pushed up to
the top of the closest scope, the first time they appear.
< b > num< / b > is not redeclared within the inner function, because it's
already in scope; the < b > new_num< / b > within the function, on the other hand,
should not be able to change the value of the external variable of the same name, and
therefore has a declaration of its own.
2009-12-24 00:42:18 +00:00
< / p >
< p >
2009-12-24 07:01:39 +00:00
Although suppressed within this documentation for clarity, all
2009-12-24 00:42:18 +00:00
CoffeeScript output is wrapped in an anonymous function:
< tt > (function(){ ... })();< / tt > This safety wrapper, combined with the
automatic generation of the < tt > var< / tt > keyword, make it exceedingly difficult
2010-01-05 03:19:45 +00:00
to pollute the global namespace by accident. If you'd like to create
global variables, attach them as properties on < b > window< / b > ,
or on the < b > exports< / b > object in CommonJS.
2009-12-24 00:42:18 +00:00
< / p >
< p id = "conditionals" >
< b class = "header" > Conditionals, Ternaries, and Conditional Assignment< / b >
2009-12-29 02:02:40 +00:00
< b > If/else< / b > statements can be written without the use of parentheses and
2010-01-05 03:19:45 +00:00
curly brackets. As with functions and other block expressions,
multi-line conditionals are delimited by indentation. There's also a handy
postfix form, with the < tt > if< / tt > or < tt > unless< / tt > at the end.
2009-12-24 00:42:18 +00:00
< / p >
2009-12-24 09:38:32 +00:00
< p >
CoffeeScript will compile < b > if< / b > statements using the ternary operator
when possible, to make it easier to use the result as an expression.
< / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > mood< span class = "Keyword" > :< / span > greatly_improved < span class = "Keyword" > if< / span > singing
2009-12-21 16:41:45 +00:00
2009-12-31 18:01:10 +00:00
< span class = "Keyword" > if< / span > happy < span class = "Keyword" > and< / span > knows_it
2009-12-21 16:41:45 +00:00
claps_hands()
2009-12-31 04:43:55 +00:00
cha_cha_cha()
2009-12-21 16:41:45 +00:00
2009-12-31 18:01:10 +00:00
date< span class = "Keyword" > :< / span > < span class = "Keyword" > if< / span > friday < span class = "Keyword" > then< / span > sue < span class = "Keyword" > else< / span > jill
2009-12-21 16:41:45 +00:00
2009-12-25 15:31:51 +00:00
expensive < span class = "Keyword" > ||< / span > < span class = "Keyword" > =< / span > do_the_math()
2009-12-26 07:17:34 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > date, mood;
2009-12-21 16:41:45 +00:00
< span class = "Keyword" > if< / span > (singing) {
mood < span class = "Keyword" > =< / span > greatly_improved;
}
< span class = "Keyword" > if< / span > (happy < span class = "Keyword" > & < / span > < span class = "Keyword" > & < / span > knows_it) {
claps_hands();
cha_cha_cha();
}
2009-12-26 07:17:34 +00:00
date < span class = "Keyword" > =< / span > friday ? sue : jill;
2009-12-21 16:41:45 +00:00
expensive < span class = "Keyword" > =< / span > expensive < span class = "Keyword" > ||< / span > do_the_math();
< / pre > < br class = 'clear' / > < / div >
2009-12-24 00:42:18 +00:00
< p >
2010-01-05 03:19:45 +00:00
The conditional assignment operators are included: < tt > ||=< / tt > ,
2009-12-24 00:42:18 +00:00
which only assigns a value to a variable if the variable's current value
2009-12-25 15:31:51 +00:00
is falsy, and < tt > & & =< / tt > , which only replaces the value of
2009-12-24 00:42:18 +00:00
truthy variables.
< / p >
2010-01-05 03:19:45 +00:00
< p id = "existence" >
< b class = "header" > The Existence Operator< / b >
It's a little difficult to check for the existence of a variable in
JavaScript. < tt > if (variable) ...< / tt > comes close, but fails for zero,
the empty string, and false. The existence operator < tt > ?< / tt > returns true unless
a variable is < b > null< / b > or < b > undefined< / b > , which makes it analogous
2010-01-05 05:19:22 +00:00
to Ruby's < tt > nil?< / tt >
2010-01-05 03:19:45 +00:00
< / p >
< div class = 'code' > < pre class = "idle" > solipsism< span class = "Keyword" > :< / span > < span class = "BuiltInConstant" > true< / span > < span class = "Keyword" > if< / span > mind< span class = "Keyword" > ?< / span > < span class = "Keyword" > and< / span > < span class = "Keyword" > not< / span > world< span class = "Keyword" > ?< / span >
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > solipsism;
2010-01-05 05:34:18 +00:00
< span class = "Keyword" > if< / span > ((< span class = "Keyword" > typeof< / span > mind < span class = "Keyword" > !< / span > < span class = "Keyword" > ==< / span > < span class = "String" > < span class = "String" > " < / span > undefined< span class = "String" > " < / span > < / span > < span class = "Keyword" > & < / span > < span class = "Keyword" > & < / span > mind < span class = "Keyword" > !< / span > < span class = "Keyword" > ==< / span > < span class = "BuiltInConstant" > null< / span > ) < span class = "Keyword" > & < / span > < span class = "Keyword" > & < / span > < span class = "Keyword" > !< / span > (< span class = "Keyword" > typeof< / span > world < span class = "Keyword" > !< / span > < span class = "Keyword" > ==< / span > < span class = "String" > < span class = "String" > " < / span > undefined< span class = "String" > " < / span > < / span > < span class = "Keyword" > & < / span > < span class = "Keyword" > & < / span > world < span class = "Keyword" > !< / span > < span class = "Keyword" > ==< / span > < span class = "BuiltInConstant" > null< / span > )) {
2010-01-05 03:19:45 +00:00
solipsism < span class = "Keyword" > =< / span > < span class = "BuiltInConstant" > true< / span > ;
}
< / pre > < br class = 'clear' / > < / div >
2009-12-24 07:01:39 +00:00
< p id = "aliases" >
< b class = "header" > Aliases< / b >
Because the < tt > ==< / tt > operator frequently causes undesirable coercion,
is intransitive, and has a different meaning than in other languages,
CoffeeScript compiles < tt > ==< / tt > into < tt > ===< / tt > , and < tt > !=< / tt > into
< tt > !==< / tt > .
In addition, < tt > is< / tt > compiles into < tt > ===< / tt > ,
2009-12-25 01:21:20 +00:00
and < tt > isnt< / tt > into < tt > !==< / tt > .
2009-12-24 07:01:39 +00:00
< / p >
< p >
You can use < tt > not< / tt > as an alias for < tt > !< / tt > .
< / p >
2009-12-24 22:37:30 +00:00
< p >
For logic, < tt > and< / tt > compiles to < tt > & & < / tt > , and < tt > or< / tt >
into < tt > ||< / tt > .
< / p >
2009-12-24 09:33:59 +00:00
< p >
Instead of a newline or semicolon, < tt > then< / tt > can be used to separate
2009-12-25 08:16:56 +00:00
conditions from expressions, in < b > while< / b > ,
2009-12-24 09:33:59 +00:00
< b > if< / b > /< b > else< / b > , and < b > switch< / b > /< b > when< / b > statements.
< / p >
2009-12-24 07:01:39 +00:00
< p >
As in < a href = "http://yaml.org/" > YAML< / a > , < tt > on< / tt > and < tt > yes< / tt >
are the same as boolean < tt > true< / tt > , while < tt > off< / tt > and < tt > no< / tt > are boolean < tt > false< / tt > .
< / p >
< p >
For single-line statements, < tt > unless< / tt > can be used as the inverse of < tt > if< / tt > .
< / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > launch() < span class = "Keyword" > if< / span > ignition < span class = "Keyword" > is< / span > < span class = "BuiltInConstant" > on< / span >
2009-12-24 07:01:39 +00:00
2009-12-31 18:01:10 +00:00
volume< span class = "Keyword" > :< / span > < span class = "Number" > 10< / span > < span class = "Keyword" > if< / span > band < span class = "Keyword" > isnt< / span > spinal_tap
2009-12-24 07:01:39 +00:00
2009-12-31 18:01:10 +00:00
let_the_wild_rumpus_begin() < span class = "Keyword" > unless< / span > answer < span class = "Keyword" > is< / span > < span class = "BuiltInConstant" > no< / span >
2009-12-24 09:33:59 +00:00
2009-12-31 18:01:10 +00:00
< span class = "Keyword" > if< / span > car.speed < span class = "Keyword" > < < / span > speed_limit < span class = "Keyword" > then< / span > accelerate()
2009-12-26 07:17:34 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > volume;
< span class = "Keyword" > if< / span > (ignition < span class = "Keyword" > ===< / span > < span class = "BuiltInConstant" > true< / span > ) {
2009-12-24 07:01:39 +00:00
launch();
}
< span class = "Keyword" > if< / span > (band < span class = "Keyword" > !< / span > < span class = "Keyword" > ==< / span > spinal_tap) {
volume < span class = "Keyword" > =< / span > < span class = "Number" > 10< / span > ;
}
< span class = "Keyword" > if< / span > (< span class = "Keyword" > !< / span > (answer < span class = "Keyword" > ===< / span > < span class = "BuiltInConstant" > false< / span > )) {
let_the_wild_rumpus_begin();
}
2009-12-24 09:33:59 +00:00
car.speed < span class = "Keyword" > < < / span > speed_limit ? accelerate() : < span class = "BuiltInConstant" > null< / span > ;
2009-12-24 07:01:39 +00:00
< / pre > < br class = 'clear' / > < / div >
2009-12-24 00:42:18 +00:00
2010-01-05 04:26:27 +00:00
< p id = "splats" >
2010-01-06 02:40:36 +00:00
< b class = "header" > Splats...< / b >
2010-01-05 04:26:27 +00:00
The JavaScript < b > arguments object< / b > is a useful way to work with
functions that accept variable numbers of arguments. CoffeeScript provides
2010-01-06 02:40:36 +00:00
splats < tt > ...< / tt > , both for function definition as well as invocation,
2010-01-05 04:26:27 +00:00
making variable arguments a little bit more palatable.
< / p >
< div class = 'code' > < pre class = "idle" > gold< span class = "Keyword" > :< / span > silver< span class = "Keyword" > :< / span > the_field< span class = "Keyword" > :< / span > < span class = "String" > < span class = "String" > " < / span > unknown< span class = "String" > " < / span > < / span >
2010-01-06 02:40:36 +00:00
medalists< span class = "Keyword" > :< / span > < span class = "FunctionArgument" > first, second, rest... < / span > < span class = "Storage" > => < / span >
2010-01-05 04:26:27 +00:00
gold< span class = "Keyword" > :< / span > first
silver< span class = "Keyword" > :< / span > second
the_field< span class = "Keyword" > :< / span > rest
contenders< span class = "Keyword" > :< / span > [
< span class = "String" > < span class = "String" > " < / span > Michael Phelps< span class = "String" > " < / span > < / span >
< span class = "String" > < span class = "String" > " < / span > Liu Xiang< span class = "String" > " < / span > < / span >
< span class = "String" > < span class = "String" > " < / span > Yao Ming< span class = "String" > " < / span > < / span >
< span class = "String" > < span class = "String" > " < / span > Allyson Felix< span class = "String" > " < / span > < / span >
< span class = "String" > < span class = "String" > " < / span > Shawn Johnson< span class = "String" > " < / span > < / span >
< span class = "String" > < span class = "String" > " < / span > Roman Sebrle< span class = "String" > " < / span > < / span >
< span class = "String" > < span class = "String" > " < / span > Guo Jingjing< span class = "String" > " < / span > < / span >
< span class = "String" > < span class = "String" > " < / span > Tyson Gay< span class = "String" > " < / span > < / span >
< span class = "String" > < span class = "String" > " < / span > Asafa Powell< span class = "String" > " < / span > < / span >
< span class = "String" > < span class = "String" > " < / span > Usain Bolt< span class = "String" > " < / span > < / span >
]
2010-01-06 02:40:36 +00:00
medalists(contenders...)
2010-01-05 04:26:27 +00:00
alert(< span class = "String" > < span class = "String" > " < / span > Gold: < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > gold)
alert(< span class = "String" > < span class = "String" > " < / span > Silver: < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > silver)
alert(< span class = "String" > < span class = "String" > " < / span > The Field: < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > the_field)
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > contenders, gold, medalists, silver, the_field;
gold < span class = "Keyword" > =< / span > silver < span class = "Keyword" > =< / span > the_field < span class = "Keyword" > =< / span > < span class = "String" > < span class = "String" > " < / span > unknown< span class = "String" > " < / span > < / span > ;
medalists < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > medalists< / span > (< span class = "FunctionArgument" > first, second< / span > ) {
< span class = "Storage" > var< / span > rest;
rest < span class = "Keyword" > =< / span > < span class = "LibraryClassType" > Array< / span > .< span class = "LibraryConstant" > prototype< / span > .slice.< span class = "LibraryFunction" > call< / span > (arguments, < span class = "Number" > 2< / span > );
gold < span class = "Keyword" > =< / span > first;
silver < span class = "Keyword" > =< / span > second;
< span class = "Keyword" > return< / span > the_field < span class = "Keyword" > =< / span > rest;
};
contenders < span class = "Keyword" > =< / span > [< span class = "String" > < span class = "String" > " < / span > Michael Phelps< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > Liu Xiang< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > Yao Ming< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > Allyson Felix< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > Shawn Johnson< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > Roman Sebrle< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > Guo Jingjing< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > Tyson Gay< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > Asafa Powell< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > Usain Bolt< span class = "String" > " < / span > < / span > ];
medalists.< span class = "LibraryFunction" > apply< / span > (< span class = "Variable" > this< / span > , contenders);
< span class = "LibraryFunction" > alert< / span > (< span class = "String" > < span class = "String" > " < / span > Gold: < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > gold);
< span class = "LibraryFunction" > alert< / span > (< span class = "String" > < span class = "String" > " < / span > Silver: < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > silver);
< span class = "LibraryFunction" > alert< / span > (< span class = "String" > < span class = "String" > " < / span > The Field: < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > the_field);
< / pre > < button onclick = 'javascript: var contenders , gold , medalists , silver , the_field ;
gold = silver = the_field = "unknown";
medalists = function medalists(first, second) {
var rest;
rest = Array.prototype.slice.call(arguments, 2);
gold = first;
silver = second;
return the_field = rest;
};
contenders = ["Michael Phelps", "Liu Xiang", "Yao Ming", "Allyson Felix", "Shawn Johnson", "Roman Sebrle", "Guo Jingjing", "Tyson Gay", "Asafa Powell", "Usain Bolt"];
medalists.apply(this, contenders);
alert("Gold: " + gold);
alert("Silver: " + silver);
alert("The Field: " + the_field);
2010-01-05 14:29:10 +00:00
;'>run< / button > < br class = 'clear' / > < / div >
< p id = "arguments" >
< b class = "header" > Arguments are Arrays< / b >
If you reference the < b > arguments object< / b > directly, it will be converted
2010-01-06 02:40:36 +00:00
into a real Array, making all of the
< a href = "https://developer.mozilla.org/En/Core_JavaScript_1.5_Reference/Objects/Array" > Array methods< / a >
2010-01-05 14:29:10 +00:00
available.
< / p >
< div class = 'code' > < pre class = "idle" > < span class = "FunctionName" > backwards< / span > < span class = "Keyword" > :< / span > < span class = "Storage" > => < / span >
alert(arguments.reverse())
backwards(< span class = "String" > < span class = "String" > " < / span > stairway< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > to< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > heaven< span class = "String" > " < / span > < / span > )
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > backwards;
backwards < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > backwards< / span > () {
< span class = "Keyword" > return< / span > < span class = "LibraryFunction" > alert< / span > (< span class = "LibraryClassType" > Array< / span > .< span class = "LibraryConstant" > prototype< / span > .slice.< span class = "LibraryFunction" > call< / span > (arguments, < span class = "Number" > 0< / span > ).< span class = "LibraryFunction" > reverse< / span > ());
};
backwards(< span class = "String" > < span class = "String" > " < / span > stairway< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > to< span class = "String" > " < / span > < / span > , < span class = "String" > < span class = "String" > " < / span > heaven< span class = "String" > " < / span > < / span > );
< / pre > < button onclick = 'javascript: var backwards ;
backwards = function backwards() {
return alert(Array.prototype.slice.call(arguments, 0).reverse());
};
backwards("stairway", "to", "heaven");
2010-01-05 04:26:27 +00:00
;'>run< / button > < br class = 'clear' / > < / div >
2009-12-24 00:42:18 +00:00
< p id = "while" >
< b class = "header" > While Loops< / b >
The only low-level loop that CoffeeScript provides is the while loop.
< / p >
< div class = 'code' > < pre class = "idle" > < span class = "Keyword" > while< / span > demand < span class = "Keyword" > > < / span > supply
2009-12-21 16:41:45 +00:00
sell()
2009-12-31 04:43:55 +00:00
restock()
2009-12-21 16:41:45 +00:00
2009-12-31 18:01:10 +00:00
< span class = "Keyword" > while< / span > supply < span class = "Keyword" > > < / span > demand < span class = "Keyword" > then< / span > buy()
2009-12-21 16:41:45 +00:00
< / pre > < pre class = "idle" > < span class = "Keyword" > while< / span > (demand < span class = "Keyword" > > < / span > supply) {
sell();
restock();
}
< span class = "Keyword" > while< / span > (supply < span class = "Keyword" > > < / span > demand) {
buy();
}
< / pre > < br class = 'clear' / > < / div >
2009-12-24 00:42:18 +00:00
< p >
2009-12-24 01:24:55 +00:00
Other JavaScript loops, such as < b > for< / b > loops and < b > do-while< / b > loops
can be mimicked by variations on < b > while< / b > , but the hope is that you
won't need to do that with CoffeeScript, either because you're using
2009-12-24 00:42:18 +00:00
< b > each< / b > (< b > forEach< / b > ) style iterators, or...
< / p >
2009-12-21 16:41:45 +00:00
2010-01-05 03:19:45 +00:00
< p id = "comprehensions" >
< b class = "header" > Comprehensions (Arrays, Objects, and Ranges)< / b >
2009-12-24 01:24:55 +00:00
For your looping needs, CoffeeScript provides array comprehensions
2009-12-24 00:42:18 +00:00
similar to Python's. They replace (and compile into) < b > for< / b > loops, with
optional guard clauses and the value of the current array index.
Unlike for loops, array comprehensions are expressions, and can be returned
and assigned. They should be able to handle most places where you otherwise
would use a loop, < b > each< / b > /< b > forEach< / b > , < b > map< / b > , or < b > select< / b > /< b > filter< / b > .
< / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > < span class = "Comment" > < span class = "Comment" > #< / span > Eat lunch.< / span >
2010-01-05 03:19:45 +00:00
lunch< span class = "Keyword" > :< / span > eat(food) < span class = "Keyword" > for< / span > food < span class = "Keyword" > in< / span > [< span class = "String" > < span class = "String" > '< / span > toast< span class = "String" > '< / span > < / span > , < span class = "String" > < span class = "String" > '< / span > cheese< span class = "String" > '< / span > < / span > , < span class = "String" > < span class = "String" > '< / span > wine< span class = "String" > '< / span > < / span > ]
2009-12-21 16:41:45 +00:00
2010-01-05 03:19:45 +00:00
< span class = "Comment" > < span class = "Comment" > #< / span > Naive collision detection.< / span >
< span class = "Keyword" > for< / span > roid < span class = "Keyword" > in< / span > asteroids
< span class = "Keyword" > for< / span > roid2 < span class = "Keyword" > in< / span > asteroids < span class = "Keyword" > when< / span > roid < span class = "Keyword" > isnt< / span > roid2
roid.explode() < span class = "Keyword" > if< / span > roid.overlaps(roid2)
2010-01-10 20:52:23 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > __a, __b, __c, __d, __e, __f, __g, food, lunch, roid, roid2;
2009-12-22 17:08:29 +00:00
< span class = "Comment" > < span class = "Comment" > //< / span > Eat lunch.< / span >
2010-01-05 00:15:24 +00:00
lunch < span class = "Keyword" > =< / span > (< span class = "Storage" > function< / span > () {
2010-01-10 19:45:44 +00:00
__c < span class = "Keyword" > =< / span > []; __a < span class = "Keyword" > =< / span > [< span class = "String" > < span class = "String" > '< / span > toast< span class = "String" > '< / span > < / span > , < span class = "String" > < span class = "String" > '< / span > cheese< span class = "String" > '< / span > < / span > , < span class = "String" > < span class = "String" > '< / span > wine< span class = "String" > '< / span > < / span > ];
< span class = "Keyword" > for< / span > (__b< span class = "Keyword" > =< / span > < span class = "Number" > 0< / span > ; __b< span class = "Keyword" > < < / span > __a.< span class = "LibraryConstant" > length< / span > ; __b< span class = "Keyword" > ++< / span > ) {
food < span class = "Keyword" > =< / span > __a[__b];
__c.< span class = "LibraryFunction" > push< / span > (eat(food));
2009-12-31 21:50:46 +00:00
}
2010-01-05 00:15:24 +00:00
< span class = "Keyword" > return< / span > __c;
})();
2010-01-05 03:19:45 +00:00
< span class = "Comment" > < span class = "Comment" > //< / span > Naive collision detection.< / span >
2010-01-10 19:45:44 +00:00
__d < span class = "Keyword" > =< / span > asteroids;
< span class = "Keyword" > for< / span > (__e< span class = "Keyword" > =< / span > < span class = "Number" > 0< / span > ; __e< span class = "Keyword" > < < / span > __d.< span class = "LibraryConstant" > length< / span > ; __e< span class = "Keyword" > ++< / span > ) {
roid < span class = "Keyword" > =< / span > __d[__e];
__f < span class = "Keyword" > =< / span > asteroids;
< span class = "Keyword" > for< / span > (__g< span class = "Keyword" > =< / span > < span class = "Number" > 0< / span > ; __g< span class = "Keyword" > < < / span > __f.< span class = "LibraryConstant" > length< / span > ; __g< span class = "Keyword" > ++< / span > ) {
roid2 < span class = "Keyword" > =< / span > __f[__g];
< span class = "Keyword" > if< / span > (roid < span class = "Keyword" > !< / span > < span class = "Keyword" > ==< / span > roid2) {
< span class = "Keyword" > if< / span > (roid.overlaps(roid2)) {
roid.explode();
2010-01-05 03:19:45 +00:00
}
}
2009-12-31 21:50:46 +00:00
}
2009-12-21 16:41:45 +00:00
}
< / pre > < br class = 'clear' / > < / div >
2009-12-27 04:46:31 +00:00
< p >
2010-01-05 03:19:45 +00:00
If you know the start and end of your loop, or would like to step through
in fixed-size increments, you can use a range to specify the start and
2010-01-10 20:52:23 +00:00
end of your comprehension. (The long line-breaking "for" definitions in
the compiled JS below allow ranges to count downwards, as well as upwards).
< / p >
< div class = 'code' > < pre class = "idle" > countdown< span class = "Keyword" > :< / span > num < span class = "Keyword" > for< / span > num < span class = "Keyword" > in< / span > [< span class = "Number" > 10< / span > ..< span class = "Number" > 1< / span > ]
< span class = "FunctionName" > egg_delivery< / span > < span class = "Keyword" > :< / span > < span class = "Storage" > => < / span >
< span class = "Keyword" > for< / span > i < span class = "Keyword" > in< / span > [< span class = "Number" > 0< / span > ...eggs.length] < span class = "Keyword" > by< / span > < span class = "Number" > 12< / span >
dozen_eggs< span class = "Keyword" > :< / span > eggs[i...i< span class = "Keyword" > +< / span > < span class = "Number" > 12< / span > ]
deliver(< span class = "Keyword" > new< / span > < span class = "TypeName" > egg_carton< / span > (dozen))
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > __a, __b, __c, __d, __e, countdown, egg_delivery, num;
countdown < span class = "Keyword" > =< / span > (< span class = "Storage" > function< / span > () {
__b < span class = "Keyword" > =< / span > []; __d < span class = "Keyword" > =< / span > < span class = "Number" > 10< / span > ; __e < span class = "Keyword" > =< / span > < span class = "Number" > 1< / span > ;
< span class = "Keyword" > for< / span > (__c< span class = "Keyword" > =< / span > < span class = "Number" > 0< / span > , num< span class = "Keyword" > =< / span > __d; (__d < span class = "Keyword" > < =< / span > __e ? num < span class = "Keyword" > < =< / span > __e : num < span class = "Keyword" > > =< / span > __e); (__d < span class = "Keyword" > < =< / span > __e ? num < span class = "Keyword" > +< / span > < span class = "Keyword" > =< / span > < span class = "Number" > 1< / span > : num < span class = "Keyword" > -< / span > < span class = "Keyword" > =< / span > < span class = "Number" > 1< / span > ), __c< span class = "Keyword" > ++< / span > ) {
__b.< span class = "LibraryFunction" > push< / span > (num);
}
< span class = "Keyword" > return< / span > __b;
})();
egg_delivery < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > egg_delivery< / span > () {
< span class = "Storage" > var< / span > __f, __g, __h, __i, __j, dozen_eggs, i;
__g < span class = "Keyword" > =< / span > []; __i < span class = "Keyword" > =< / span > < span class = "Number" > 0< / span > ; __j < span class = "Keyword" > =< / span > eggs.< span class = "LibraryConstant" > length< / span > ;
< span class = "Keyword" > for< / span > (__h< span class = "Keyword" > =< / span > < span class = "Number" > 0< / span > , i< span class = "Keyword" > =< / span > __i; (__i < span class = "Keyword" > < =< / span > __j ? i < span class = "Keyword" > < < / span > __j : i < span class = "Keyword" > > < / span > __j); (__i < span class = "Keyword" > < =< / span > __j ? i < span class = "Keyword" > +< / span > < span class = "Keyword" > =< / span > < span class = "Number" > 12< / span > : i < span class = "Keyword" > -< / span > < span class = "Keyword" > =< / span > < span class = "Number" > 12< / span > ), __h< span class = "Keyword" > ++< / span > ) {
__g.< span class = "LibraryFunction" > push< / span > ((< span class = "Storage" > function< / span > () {
dozen_eggs < span class = "Keyword" > =< / span > eggs.< span class = "LibraryFunction" > slice< / span > (i, i < span class = "Keyword" > +< / span > < span class = "Number" > 12< / span > );
< span class = "Keyword" > return< / span > deliver(< span class = "Keyword" > new< / span > < span class = "TypeName" > egg_carton< / span > (dozen));
})());
}
< span class = "Keyword" > return< / span > __g;
};
< / pre > < button onclick = 'javascript: var __a , __b , __c , __d , __e , countdown , egg_delivery , num ;
countdown = (function() {
__b = []; __d = 10; __e = 1;
for (__c=0, num=__d; (__d < = __e ? num < = __e : num >= __e); (__d < = __e ? num += 1 : num -= 1), __c++) {
__b.push(num);
}
return __b;
})();
egg_delivery = function egg_delivery() {
var __f, __g, __h, __i, __j, dozen_eggs, i;
__g = []; __i = 0; __j = eggs.length;
for (__h=0, i=__i; (__i < = __j ? i < __j : i > __j); (__i < = __j ? i += 12 : i -= 12), __h++) {
__g.push((function() {
dozen_eggs = eggs.slice(i, i + 12);
return deliver(new egg_carton(dozen));
})());
}
return __g;
};
;alert(countdown);'>run: countdown< / button > < br class = 'clear' / > < / div >
2010-01-05 03:19:45 +00:00
< p >
2010-01-10 20:52:23 +00:00
Comprehensions can also be used to iterate over the keys and values in
an object. Use < tt > ino< / tt > to signal comprehension over an object instead
of an array.
2009-12-27 04:46:31 +00:00
< / p >
2010-01-10 20:52:23 +00:00
< div class = 'code' > < pre class = "idle" > years_old< span class = "Keyword" > :< / span > {max< span class = "Keyword" > :< / span > < span class = "Number" > 10< / span > , ida< span class = "Keyword" > :< / span > < span class = "Number" > 9< / span > , tim< span class = "Keyword" > :< / span > < span class = "Number" > 11< / span > }
ages< span class = "Keyword" > :< / span > child < span class = "Keyword" > +< / span > < span class = "String" > < span class = "String" > " < / span > is < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > age < span class = "Keyword" > for< / span > child, age ino years_old
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > __a, __b, age, ages, child, years_old;
years_old < span class = "Keyword" > =< / span > {
max: < span class = "Number" > 10< / span > ,
ida: < span class = "Number" > 9< / span > ,
tim: < span class = "Number" > 11< / span >
};
ages < span class = "Keyword" > =< / span > (< span class = "Storage" > function< / span > () {
__b < span class = "Keyword" > =< / span > []; __a < span class = "Keyword" > =< / span > years_old;
< span class = "Keyword" > for< / span > (child < span class = "Keyword" > in< / span > __a) {
age < span class = "Keyword" > =< / span > __a[child];
< span class = "Keyword" > if< / span > (__a.hasOwnProperty(child)) {
__b.< span class = "LibraryFunction" > push< / span > (child < span class = "Keyword" > +< / span > < span class = "String" > < span class = "String" > " < / span > is < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > age);
}
}
< span class = "Keyword" > return< / span > __b;
})();
< / pre > < button onclick = 'javascript: var __a , __b , age , ages , child , years_old ;
years_old = {
max: 10,
ida: 9,
tim: 11
};
ages = (function() {
__b = []; __a = years_old;
for (child in __a) {
age = __a[child];
if (__a.hasOwnProperty(child)) {
__b.push(child + " is " + age);
}
}
return __b;
})();
;alert(ages.join(", "));'>run: ages.join(", ")< / button > < br class = 'clear' / > < / div >
2009-12-21 16:41:45 +00:00
2010-01-05 03:19:45 +00:00
< p id = "slice_splice" >
< b class = "header" > Array Slicing and Splicing with Ranges< / b >
2009-12-26 00:35:57 +00:00
CoffeeScript borrows Ruby's
< a href = "http://ruby-doc.org/core/classes/Range.html" > range syntax< / a >
for extracting slices of arrays. With two dots (< tt > 3..5< / tt > ), the range
is inclusive: the first argument is the index of the first element in
the slice, and the second is the index of the last one. Three dots signify
a range that excludes the end.
< / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > numbers< span class = "Keyword" > :< / span > [< span class = "Number" > 0< / span > , < span class = "Number" > 1< / span > , < span class = "Number" > 2< / span > , < span class = "Number" > 3< / span > , < span class = "Number" > 4< / span > , < span class = "Number" > 5< / span > , < span class = "Number" > 6< / span > , < span class = "Number" > 7< / span > , < span class = "Number" > 8< / span > , < span class = "Number" > 9< / span > ]
2009-12-26 00:35:57 +00:00
2009-12-31 18:01:10 +00:00
three_to_six< span class = "Keyword" > :< / span > numbers[< span class = "Number" > 3< / span > ..< span class = "Number" > 6< / span > ]
2009-12-26 00:35:57 +00:00
2009-12-31 18:01:10 +00:00
numbers_copy< span class = "Keyword" > :< / span > numbers[< span class = "Number" > 0< / span > ...numbers.length]
2009-12-26 00:35:57 +00:00
2009-12-26 07:17:34 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > numbers, numbers_copy, three_to_six;
numbers < span class = "Keyword" > =< / span > [< span class = "Number" > 0< / span > , < span class = "Number" > 1< / span > , < span class = "Number" > 2< / span > , < span class = "Number" > 3< / span > , < span class = "Number" > 4< / span > , < span class = "Number" > 5< / span > , < span class = "Number" > 6< / span > , < span class = "Number" > 7< / span > , < span class = "Number" > 8< / span > , < span class = "Number" > 9< / span > ];
three_to_six < span class = "Keyword" > =< / span > numbers.< span class = "LibraryFunction" > slice< / span > (< span class = "Number" > 3< / span > , < span class = "Number" > 6< / span > < span class = "Keyword" > +< / span > < span class = "Number" > 1< / span > );
numbers_copy < span class = "Keyword" > =< / span > numbers.< span class = "LibraryFunction" > slice< / span > (< span class = "Number" > 0< / span > , numbers.< span class = "LibraryConstant" > length< / span > );
< / pre > < button onclick = 'javascript: var numbers , numbers_copy , three_to_six ;
numbers = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
three_to_six = numbers.slice(3, 6 + 1);
numbers_copy = numbers.slice(0, numbers.length);
2009-12-26 00:35:57 +00:00
;alert(numbers_copy);'>run: numbers_copy< / button > < br class = 'clear' / > < / div >
2010-01-05 03:19:45 +00:00
< p >
The same syntax can be used with assignment to replace a segment of an
array with new values (to splice it).
< / p >
< div class = 'code' > < pre class = "idle" > numbers< span class = "Keyword" > :< / span > [< span class = "Number" > 0< / span > , < span class = "Number" > 1< / span > , < span class = "Number" > 2< / span > , < span class = "Number" > 3< / span > , < span class = "Number" > 4< / span > , < span class = "Number" > 5< / span > , < span class = "Number" > 6< / span > , < span class = "Number" > 7< / span > , < span class = "Number" > 8< / span > , < span class = "Number" > 9< / span > ]
numbers[< span class = "Number" > 3< / span > ..< span class = "Number" > 6< / span > ]< span class = "Keyword" > :< / span > [< span class = "Keyword" > -< / span > < span class = "Number" > 3< / span > , < span class = "Keyword" > -< / span > < span class = "Number" > 4< / span > , < span class = "Keyword" > -< / span > < span class = "Number" > 5< / span > , < span class = "Keyword" > -< / span > < span class = "Number" > 6< / span > ]
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > numbers;
numbers < span class = "Keyword" > =< / span > [< span class = "Number" > 0< / span > , < span class = "Number" > 1< / span > , < span class = "Number" > 2< / span > , < span class = "Number" > 3< / span > , < span class = "Number" > 4< / span > , < span class = "Number" > 5< / span > , < span class = "Number" > 6< / span > , < span class = "Number" > 7< / span > , < span class = "Number" > 8< / span > , < span class = "Number" > 9< / span > ];
numbers.splice.< span class = "LibraryFunction" > apply< / span > (numbers, [< span class = "Number" > 3< / span > , < span class = "Number" > 6< / span > < span class = "Keyword" > -< / span > < span class = "Number" > 3< / span > < span class = "Keyword" > +< / span > < span class = "Number" > 1< / span > ].< span class = "LibraryFunction" > concat< / span > ([< span class = "Keyword" > -< / span > < span class = "Number" > 3< / span > , < span class = "Keyword" > -< / span > < span class = "Number" > 4< / span > , < span class = "Keyword" > -< / span > < span class = "Number" > 5< / span > , < span class = "Keyword" > -< / span > < span class = "Number" > 6< / span > ]));
< / pre > < button onclick = 'javascript: var numbers ;
numbers = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
numbers.splice.apply(numbers, [3, 6 - 3 + 1].concat([-3, -4, -5, -6]));
;alert(numbers);'>run: numbers< / button > < br class = 'clear' / > < / div >
2010-01-05 04:26:27 +00:00
2010-01-05 03:51:02 +00:00
< p id = "expressions" >
< b class = "header" > Everything is an Expression (at least, as much as possible)< / b >
You might have noticed how even though we don't add return statements
to CoffeeScript functions, they nonetheless return their final value.
The CoffeeScript compiler tries to make sure that all statements in the
language can be used as expressions. Watch how the < tt > return< / tt > gets
pushed down into each possible branch of execution, in the function
below.
< / p >
< div class = 'code' > < pre class = "idle" > < span class = "FunctionName" > grade< / span > < span class = "Keyword" > :< / span > < span class = "FunctionArgument" > student< / span > < span class = "Storage" > => < / span >
< span class = "Keyword" > if< / span > student.excellent_work
< span class = "String" > < span class = "String" > " < / span > A+< span class = "String" > " < / span > < / span >
< span class = "Keyword" > else< / span > < span class = "Keyword" > if< / span > student.okay_stuff
< span class = "Keyword" > if< / span > student.tried_hard < span class = "Keyword" > then< / span > < span class = "String" > < span class = "String" > " < / span > B< span class = "String" > " < / span > < / span > < span class = "Keyword" > else< / span > < span class = "String" > < span class = "String" > " < / span > B-< span class = "String" > " < / span > < / span >
< span class = "Keyword" > else< / span >
< span class = "String" > < span class = "String" > " < / span > C< span class = "String" > " < / span > < / span >
eldest< span class = "Keyword" > :< / span > < span class = "Keyword" > if< / span > < span class = "Number" > 24< / span > < span class = "Keyword" > > < / span > < span class = "Number" > 21< / span > < span class = "Keyword" > then< / span > < span class = "String" > < span class = "String" > " < / span > Liz< span class = "String" > " < / span > < / span > < span class = "Keyword" > else< / span > < span class = "String" > < span class = "String" > " < / span > Ike< span class = "String" > " < / span > < / span >
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > eldest, grade;
grade < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > grade< / span > (< span class = "FunctionArgument" > student< / span > ) {
< span class = "Keyword" > if< / span > (student.excellent_work) {
< span class = "Keyword" > return< / span > < span class = "String" > < span class = "String" > " < / span > A+< span class = "String" > " < / span > < / span > ;
} < span class = "Keyword" > else< / span > < span class = "Keyword" > if< / span > (student.okay_stuff) {
< span class = "Keyword" > return< / span > student.tried_hard ? < span class = "String" > < span class = "String" > " < / span > B< span class = "String" > " < / span > < / span > : < span class = "String" > < span class = "String" > " < / span > B-< span class = "String" > " < / span > < / span > ;
} < span class = "Keyword" > else< / span > {
< span class = "Keyword" > return< / span > < span class = "String" > < span class = "String" > " < / span > C< span class = "String" > " < / span > < / span > ;
}
};
eldest < span class = "Keyword" > =< / span > < span class = "Number" > 24< / span > < span class = "Keyword" > > < / span > < span class = "Number" > 21< / span > ? < span class = "String" > < span class = "String" > " < / span > Liz< span class = "String" > " < / span > < / span > : < span class = "String" > < span class = "String" > " < / span > Ike< span class = "String" > " < / span > < / span > ;
< / pre > < button onclick = 'javascript: var eldest , grade ;
grade = function grade(student) {
if (student.excellent_work) {
return "A+";
} else if (student.okay_stuff) {
return student.tried_hard ? "B" : "B-";
} else {
return "C";
}
};
eldest = 24 > 21 ? "Liz" : "Ike";
;alert(eldest);'>run: eldest< / button > < br class = 'clear' / > < / div >
< p >
Because variable declarations occur at the top of scope, assignment can
be used within expressions, even for variables that haven't been seen before:
< / p >
< div class = 'code' > < pre class = "idle" > six< span class = "Keyword" > :< / span > (one< span class = "Keyword" > :< / span > < span class = "Number" > 1< / span > ) < span class = "Keyword" > +< / span > (two< span class = "Keyword" > :< / span > < span class = "Number" > 2< / span > ) < span class = "Keyword" > +< / span > (three< span class = "Keyword" > :< / span > < span class = "Number" > 3< / span > )
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > one, six, three, two;
six < span class = "Keyword" > =< / span > (one < span class = "Keyword" > =< / span > < span class = "Number" > 1< / span > ) < span class = "Keyword" > +< / span > (two < span class = "Keyword" > =< / span > < span class = "Number" > 2< / span > ) < span class = "Keyword" > +< / span > (three < span class = "Keyword" > =< / span > < span class = "Number" > 3< / span > );
< / pre > < button onclick = 'javascript: var one , six , three , two ;
six = (one = 1) + (two = 2) + (three = 3);
;alert(six);'>run: six< / button > < br class = 'clear' / > < / div >
< p >
Things that would otherwise be statements in JavaScript, when used
as part of an expression in CoffeeScript, are converted into expressions
by wrapping them in a closure. This lets you do useful things, like assign
the result of a comprehension to a variable:
< / p >
< div class = 'code' > < pre class = "idle" > < span class = "Comment" > < span class = "Comment" > #< / span > The first ten global properties.< / span >
globals< span class = "Keyword" > :< / span > (name < span class = "Keyword" > for< / span > property, name < span class = "Keyword" > in< / span > window)[< span class = "Number" > 0< / span > ...< span class = "Number" > 10< / span > ]
2010-01-10 20:52:23 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > __a, __b, globals, name, property;
2010-01-05 03:51:02 +00:00
< span class = "Comment" > < span class = "Comment" > //< / span > The first ten global properties.< / span >
globals < span class = "Keyword" > =< / span > ((< span class = "Storage" > function< / span > () {
2010-01-10 19:45:44 +00:00
__b < span class = "Keyword" > =< / span > []; __a < span class = "Keyword" > =< / span > < span class = "LibraryClassType" > window< / span > ;
< span class = "Keyword" > for< / span > (name< span class = "Keyword" > =< / span > < span class = "Number" > 0< / span > ; name< span class = "Keyword" > < < / span > __a.< span class = "LibraryConstant" > length< / span > ; name< span class = "Keyword" > ++< / span > ) {
property < span class = "Keyword" > =< / span > __a[name];
__b.< span class = "LibraryFunction" > push< / span > (name);
2010-01-05 03:51:02 +00:00
}
< span class = "Keyword" > return< / span > __b;
})()).< span class = "LibraryFunction" > slice< / span > (< span class = "Number" > 0< / span > , < span class = "Number" > 10< / span > );
2010-01-10 20:52:23 +00:00
< / pre > < button onclick = 'javascript: var __a , __b , globals , name , property ;
2010-01-05 03:51:02 +00:00
// The first ten global properties.
globals = ((function() {
2010-01-10 19:45:44 +00:00
__b = []; __a = window;
for (name=0; name< __a.length ; name + + ) {
property = __a[name];
__b.push(name);
2010-01-05 03:51:02 +00:00
}
return __b;
})()).slice(0, 10);
;alert(globals);'>run: globals< / button > < br class = 'clear' / > < / div >
< p >
As well as silly things, like passing a < b > try/catch< / b > statement directly
into a function call:
< / p >
< div class = 'code' > < pre class = "idle" > alert(
< span class = "Keyword" > try< / span >
nonexistent < span class = "Keyword" > /< / span > < span class = "BuiltInConstant" > undefined< / span >
< span class = "Keyword" > catch< / span > error
2010-01-10 20:52:23 +00:00
< span class = "String" > < span class = "String" > " < / span > Caught an error: < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > error
2010-01-05 03:51:02 +00:00
)
< / pre > < pre class = "idle" > < span class = "LibraryFunction" > alert< / span > ((< span class = "Storage" > function< / span > () {
< span class = "Keyword" > try< / span > {
< span class = "Keyword" > return< / span > nonexistent / undefined;
} < span class = "Keyword" > catch< / span > (error) {
2010-01-10 20:52:23 +00:00
< span class = "Keyword" > return< / span > < span class = "String" > < span class = "String" > " < / span > Caught an error: < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > error;
2010-01-05 03:51:02 +00:00
}
})());
< / pre > < button onclick = 'javascript: alert ( ( function ( ) {
try {
return nonexistent / undefined;
} catch (error) {
2010-01-10 20:52:23 +00:00
return "Caught an error: " + error;
2010-01-05 03:51:02 +00:00
}
})());
;'>run< / button > < br class = 'clear' / > < / div >
2009-12-21 16:41:45 +00:00
2009-12-25 00:49:23 +00:00
< p id = "inheritance" >
< b class = "header" > Inheritance, and Calling Super from a Subclass< / b >
2009-12-24 00:42:18 +00:00
JavaScript's prototypal inheritance has always been a bit of a
brain-bender, with a whole family tree of libraries that provide a cleaner
syntax for classical inheritance on top of JavaScript's prototypes:
2009-12-24 01:24:55 +00:00
< a href = "http://code.google.com/p/base2/" > Base2< / a > ,
2009-12-24 00:42:18 +00:00
< a href = "http://prototypejs.org/" > Prototype.js< / a > ,
< a href = "http://jsclass.jcoglan.com/" > JS.Class< / a > , etc.
2009-12-24 01:48:55 +00:00
The libraries provide syntactic sugar, but the built-in inheritance would
2009-12-25 00:49:23 +00:00
be completely usable if it weren't for a couple of small exceptions:
it's awkward to call < b > super< / b > (the prototype object's
implementation of the current function), and it's awkward to correctly
set the prototype chain. CoffeeScript provides < tt > extends< / tt >
to help with prototype setup, and converts
2009-12-24 01:48:55 +00:00
< tt > super()< / tt > calls into calls against the immediate ancestor's
method of the same name.
2009-12-24 00:42:18 +00:00
< / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > < span class = "FunctionName" > Animal< / span > < span class = "Keyword" > :< / span > < span class = "Storage" > => < / span >
< span class = "FunctionName" > Animal.prototype.move< / span > < span class = "Keyword" > :< / span > < span class = "FunctionArgument" > meters< / span > < span class = "Storage" > => < / span >
alert(< span class = "Variable" > this< / span > .name < span class = "Keyword" > +< / span > < span class = "String" > < span class = "String" > " < / span > moved < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > meters < span class = "Keyword" > +< / span > < span class = "String" > < span class = "String" > " < / span > m.< span class = "String" > " < / span > < / span > )
2009-12-21 16:41:45 +00:00
2009-12-31 18:01:10 +00:00
< span class = "FunctionName" > Snake< / span > < span class = "Keyword" > :< / span > < span class = "FunctionArgument" > name< / span > < span class = "Storage" > => < / span > < span class = "Variable" > this< / span > .name< span class = "Keyword" > :< / span > name
Snake < span class = "Variable" > extends< / span > Animal
< span class = "FunctionName" > Snake.prototype.move< / span > < span class = "Keyword" > :< / span > < span class = "Storage" > => < / span >
alert(< span class = "String" > < span class = "String" > " < / span > Slithering...< span class = "String" > " < / span > < / span > )
2009-12-31 04:43:55 +00:00
< span class = "Variable" > super< / span > (< span class = "Number" > 5< / span > )
2009-12-21 16:41:45 +00:00
2009-12-31 18:01:10 +00:00
< span class = "FunctionName" > Horse< / span > < span class = "Keyword" > :< / span > < span class = "FunctionArgument" > name< / span > < span class = "Storage" > => < / span > < span class = "Variable" > this< / span > .name< span class = "Keyword" > :< / span > name
Horse < span class = "Variable" > extends< / span > Animal
< span class = "FunctionName" > Horse.prototype.move< / span > < span class = "Keyword" > :< / span > < span class = "Storage" > => < / span >
alert(< span class = "String" > < span class = "String" > " < / span > Galloping...< span class = "String" > " < / span > < / span > )
2009-12-31 04:43:55 +00:00
< span class = "Variable" > super< / span > (< span class = "Number" > 45< / span > )
2009-12-21 16:41:45 +00:00
2009-12-31 18:01:10 +00:00
sam< span class = "Keyword" > :< / span > < span class = "Keyword" > new< / span > < span class = "TypeName" > Snake< / span > (< span class = "String" > < span class = "String" > " < / span > Sammy the Python< span class = "String" > " < / span > < / span > )
tom< span class = "Keyword" > :< / span > < span class = "Keyword" > new< / span > < span class = "TypeName" > Horse< / span > (< span class = "String" > < span class = "String" > " < / span > Tommy the Palomino< span class = "String" > " < / span > < / span > )
2009-12-21 16:41:45 +00:00
sam.move()
tom.move()
2009-12-24 07:01:39 +00:00
2010-01-10 19:45:44 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > Animal, Horse, Snake, __a, __b, sam, tom;
2009-12-31 04:43:55 +00:00
Animal < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > Animal< / span > () {
2009-12-21 16:41:45 +00:00
};
2009-12-31 04:43:55 +00:00
< span class = "LibraryClassType" > Animal< / span > .< span class = "LibraryConstant" > prototype< / span > .< span class = "FunctionName" > move< / span > = < span class = "Storage" > function< / span > < span class = "FunctionName" > move< / span > (< span class = "FunctionArgument" > meters< / span > ) {
2009-12-21 16:41:45 +00:00
< span class = "Keyword" > return< / span > < span class = "LibraryFunction" > alert< / span > (< span class = "Variable" > this< / span > .< span class = "LibraryConstant" > name< / span > < span class = "Keyword" > +< / span > < span class = "String" > < span class = "String" > " < / span > moved < span class = "String" > " < / span > < / span > < span class = "Keyword" > +< / span > meters < span class = "Keyword" > +< / span > < span class = "String" > < span class = "String" > " < / span > m.< span class = "String" > " < / span > < / span > );
};
2009-12-31 04:43:55 +00:00
Snake < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > Snake< / span > (< span class = "FunctionArgument" > name< / span > ) {
2010-01-07 04:47:36 +00:00
< span class = "Storage" > var< / span > __a;
__a < span class = "Keyword" > =< / span > < span class = "Variable" > this< / span > .< span class = "LibraryConstant" > name< / span > < span class = "Keyword" > =< / span > name;
< span class = "Keyword" > return< / span > Snake < span class = "Keyword" > ===< / span > < span class = "Variable" > this< / span > .< span class = "LibraryConstant" > constructor< / span > ? < span class = "Variable" > this< / span > : __a;
2009-12-21 16:41:45 +00:00
};
2010-01-10 19:45:44 +00:00
< span class = "FunctionName" > __a< / span > = < span class = "Storage" > function< / span > (){};
< span class = "LibraryClassType" > __a< / span > .< span class = "LibraryConstant" > prototype< / span > = Animal.< span class = "LibraryConstant" > prototype< / span > ;
2009-12-25 21:57:47 +00:00
Snake.__superClass__ < span class = "Keyword" > =< / span > Animal.< span class = "LibraryConstant" > prototype< / span > ;
2010-01-10 19:45:44 +00:00
< span class = "LibraryClassType" > Snake< / span > .< span class = "LibraryConstant" > prototype< / span > = < span class = "Keyword" > new< / span > < span class = "TypeName" > __a< / span > ();
2009-12-25 21:57:47 +00:00
< span class = "LibraryClassType" > Snake< / span > .< span class = "LibraryConstant" > prototype< / span > .< span class = "FunctionName" > constructor< / span > = Snake;
2009-12-31 04:43:55 +00:00
< span class = "LibraryClassType" > Snake< / span > .< span class = "LibraryConstant" > prototype< / span > .< span class = "FunctionName" > move< / span > = < span class = "Storage" > function< / span > < span class = "FunctionName" > move< / span > () {
2009-12-21 16:41:45 +00:00
< span class = "LibraryFunction" > alert< / span > (< span class = "String" > < span class = "String" > " < / span > Slithering...< span class = "String" > " < / span > < / span > );
2009-12-25 21:57:47 +00:00
< span class = "Keyword" > return< / span > Snake.__superClass__.move.< span class = "LibraryFunction" > call< / span > (< span class = "Variable" > this< / span > , < span class = "Number" > 5< / span > );
2009-12-21 16:41:45 +00:00
};
2009-12-31 04:43:55 +00:00
Horse < span class = "Keyword" > =< / span > < span class = "Storage" > function< / span > < span class = "FunctionName" > Horse< / span > (< span class = "FunctionArgument" > name< / span > ) {
2010-01-10 19:45:44 +00:00
< span class = "Storage" > var< / span > __b;
__b < span class = "Keyword" > =< / span > < span class = "Variable" > this< / span > .< span class = "LibraryConstant" > name< / span > < span class = "Keyword" > =< / span > name;
< span class = "Keyword" > return< / span > Horse < span class = "Keyword" > ===< / span > < span class = "Variable" > this< / span > .< span class = "LibraryConstant" > constructor< / span > ? < span class = "Variable" > this< / span > : __b;
2009-12-21 16:41:45 +00:00
};
2010-01-10 19:45:44 +00:00
< span class = "FunctionName" > __b< / span > = < span class = "Storage" > function< / span > (){};
< span class = "LibraryClassType" > __b< / span > .< span class = "LibraryConstant" > prototype< / span > = Animal.< span class = "LibraryConstant" > prototype< / span > ;
2009-12-25 21:57:47 +00:00
Horse.__superClass__ < span class = "Keyword" > =< / span > Animal.< span class = "LibraryConstant" > prototype< / span > ;
2010-01-10 19:45:44 +00:00
< span class = "LibraryClassType" > Horse< / span > .< span class = "LibraryConstant" > prototype< / span > = < span class = "Keyword" > new< / span > < span class = "TypeName" > __b< / span > ();
2009-12-25 21:57:47 +00:00
< span class = "LibraryClassType" > Horse< / span > .< span class = "LibraryConstant" > prototype< / span > .< span class = "FunctionName" > constructor< / span > = Horse;
2009-12-31 04:43:55 +00:00
< span class = "LibraryClassType" > Horse< / span > .< span class = "LibraryConstant" > prototype< / span > .< span class = "FunctionName" > move< / span > = < span class = "Storage" > function< / span > < span class = "FunctionName" > move< / span > () {
2009-12-21 16:41:45 +00:00
< span class = "LibraryFunction" > alert< / span > (< span class = "String" > < span class = "String" > " < / span > Galloping...< span class = "String" > " < / span > < / span > );
2009-12-25 21:57:47 +00:00
< span class = "Keyword" > return< / span > Horse.__superClass__.move.< span class = "LibraryFunction" > call< / span > (< span class = "Variable" > this< / span > , < span class = "Number" > 45< / span > );
2009-12-21 16:41:45 +00:00
};
2009-12-26 07:17:34 +00:00
sam < span class = "Keyword" > =< / span > < span class = "Keyword" > new< / span > < span class = "TypeName" > Snake< / span > (< span class = "String" > < span class = "String" > " < / span > Sammy the Python< span class = "String" > " < / span > < / span > );
tom < span class = "Keyword" > =< / span > < span class = "Keyword" > new< / span > < span class = "TypeName" > Horse< / span > (< span class = "String" > < span class = "String" > " < / span > Tommy the Palomino< span class = "String" > " < / span > < / span > );
2009-12-21 16:41:45 +00:00
sam.move();
tom.move();
2010-01-10 19:45:44 +00:00
< / pre > < button onclick = 'javascript: var Animal , Horse , Snake , __a , __b , sam , tom ;
2009-12-31 04:43:55 +00:00
Animal = function Animal() {
2009-12-21 16:41:45 +00:00
};
2009-12-31 04:43:55 +00:00
Animal.prototype.move = function move(meters) {
2009-12-21 16:41:45 +00:00
return alert(this.name + " moved " + meters + "m.");
};
2009-12-31 04:43:55 +00:00
Snake = function Snake(name) {
2010-01-07 04:47:36 +00:00
var __a;
__a = this.name = name;
return Snake === this.constructor ? this : __a;
2009-12-21 16:41:45 +00:00
};
2010-01-10 19:45:44 +00:00
__a = function(){};
__a.prototype = Animal.prototype;
2009-12-25 21:57:47 +00:00
Snake.__superClass__ = Animal.prototype;
2010-01-10 19:45:44 +00:00
Snake.prototype = new __a();
2009-12-25 21:57:47 +00:00
Snake.prototype.constructor = Snake;
2009-12-31 04:43:55 +00:00
Snake.prototype.move = function move() {
2009-12-21 16:41:45 +00:00
alert("Slithering...");
2009-12-25 21:57:47 +00:00
return Snake.__superClass__.move.call(this, 5);
2009-12-21 16:41:45 +00:00
};
2009-12-31 04:43:55 +00:00
Horse = function Horse(name) {
2010-01-10 19:45:44 +00:00
var __b;
__b = this.name = name;
return Horse === this.constructor ? this : __b;
2009-12-21 16:41:45 +00:00
};
2010-01-10 19:45:44 +00:00
__b = function(){};
__b.prototype = Animal.prototype;
2009-12-25 21:57:47 +00:00
Horse.__superClass__ = Animal.prototype;
2010-01-10 19:45:44 +00:00
Horse.prototype = new __b();
2009-12-25 21:57:47 +00:00
Horse.prototype.constructor = Horse;
2009-12-31 04:43:55 +00:00
Horse.prototype.move = function move() {
2009-12-21 16:41:45 +00:00
alert("Galloping...");
2009-12-25 21:57:47 +00:00
return Horse.__superClass__.move.call(this, 45);
2009-12-21 16:41:45 +00:00
};
2009-12-26 07:17:34 +00:00
sam = new Snake("Sammy the Python");
tom = new Horse("Tommy the Palomino");
2009-12-21 16:41:45 +00:00
sam.move();
tom.move();
;'>run< / button > < br class = 'clear' / > < / div >
2010-01-05 04:26:27 +00:00
< p id = "blocks" >
< b class = "header" > Blocks< / b >
Many common looping functions (in Prototype, jQuery, and Underscore,
2010-01-05 14:29:10 +00:00
for example) take a single function as their final argument. To make
final functions easier to pass, CoffeeScript includes block syntax,
2010-01-05 05:19:22 +00:00
so you don't have to close the parentheses on the other side.
2010-01-05 04:26:27 +00:00
< / p >
< div class = 'code' > < pre class = "idle" > < span class = "Keyword" > $< / span > (< span class = "String" > < span class = "String" > '< / span > table.list< span class = "String" > '< / span > < / span > ).each()< span class = "FunctionArgument" > table < / span > < span class = "Storage" > => < / span >
< span class = "Keyword" > $< / span > (< span class = "String" > < span class = "String" > '< / span > tr.account< span class = "String" > '< / span > < / span > , table).each()< span class = "FunctionArgument" > row < / span > < span class = "Storage" > => < / span >
row.show()
row.highlight()
< / pre > < pre class = "idle" > < span class = "Keyword" > $< / span > (< span class = "String" > < span class = "String" > '< / span > table.list< span class = "String" > '< / span > < / span > ).each(< span class = "Storage" > function< / span > (table) {
< span class = "Keyword" > return< / span > < span class = "Keyword" > $< / span > (< span class = "String" > < span class = "String" > '< / span > tr.account< span class = "String" > '< / span > < / span > , table).each(< span class = "Storage" > function< / span > (row) {
row.show();
< span class = "Keyword" > return< / span > row.highlight();
});
});
< / pre > < br class = 'clear' / > < / div >
2009-12-24 00:42:18 +00:00
< p id = "embedded" >
< b class = "header" > Embedded JavaScript< / b >
If you ever need to interpolate literal JavaScript snippets, you can
use backticks to pass JavaScript straight through.
< / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > hi< span class = "Keyword" > :< / span > < span class = "String" > < span class = "String" > `< / span > function() {< / span >
< span class = "String" > return [document.title, " Hello JavaScript" ].join(" : " );< / span >
< span class = "String" > }< span class = "String" > `< / span > < / span >
2009-12-21 16:41:45 +00:00
2009-12-26 07:17:34 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > hi;
< span class = "FunctionName" > hi< / span > = < span class = "Storage" > function< / span > () {
2009-12-24 01:24:55 +00:00
< span class = "Keyword" > return< / span > [< span class = "LibraryClassType" > document< / span > .< span class = "LibraryConstant" > title< / span > , < span class = "String" > < span class = "String" > " < / span > Hello JavaScript< span class = "String" > " < / span > < / span > ].< span class = "LibraryFunction" > join< / span > (< span class = "String" > < span class = "String" > " < / span > : < span class = "String" > " < / span > < / span > );
2009-12-21 16:41:45 +00:00
};
2009-12-26 07:17:34 +00:00
< / pre > < button onclick = 'javascript: var hi ;
hi = function() {
2009-12-24 01:24:55 +00:00
return [document.title, "Hello JavaScript"].join(": ");
2009-12-21 16:41:45 +00:00
};
2009-12-24 01:24:55 +00:00
;alert(hi());'>run: hi()< / button > < br class = 'clear' / > < / div >
2009-12-21 16:41:45 +00:00
2009-12-24 00:42:18 +00:00
< p id = "switch" >
2009-12-24 09:33:59 +00:00
< b class = "header" > Switch/When/Else< / b >
2009-12-24 07:01:39 +00:00
< b > Switch< / b > statements in JavaScript are rather broken. You can only
2009-12-24 08:12:07 +00:00
do comparisons based on string equality, and need to remember to < b > break< / b > at the end of
2009-12-24 06:22:41 +00:00
every < b > case< / b > statement to avoid accidentally falling through to
2009-12-24 09:33:59 +00:00
the default case. CoffeeScript compiles < b > switch< / b > statements into JavaScript if-else chains, allowing you to
2009-12-24 00:42:18 +00:00
compare any object (via < b > ===< / b > ), preventing fall-through, and resulting
2009-12-24 09:33:59 +00:00
in a returnable, assignable expression. The format is: < tt > switch< / tt > condition,
< tt > when< / tt > clauses, < tt > else< / tt > the default case.
2009-12-24 00:42:18 +00:00
< / p >
< div class = 'code' > < pre class = "idle" > < span class = "Keyword" > switch< / span > day
2009-12-31 18:01:10 +00:00
< span class = "Keyword" > when< / span > < span class = "String" > < span class = "String" > " < / span > Tuesday< span class = "String" > " < / span > < / span > < span class = "Keyword" > then< / span > eat_breakfast()
< span class = "Keyword" > when< / span > < span class = "String" > < span class = "String" > " < / span > Wednesday< span class = "String" > " < / span > < / span > < span class = "Keyword" > then< / span > go_to_the_park()
< span class = "Keyword" > when< / span > < span class = "String" > < span class = "String" > " < / span > Saturday< span class = "String" > " < / span > < / span >
< span class = "Keyword" > if< / span > day < span class = "Keyword" > is< / span > bingo_day
2009-12-31 04:43:55 +00:00
go_to_bingo()
go_dancing()
2009-12-31 18:01:10 +00:00
< span class = "Keyword" > when< / span > < span class = "String" > < span class = "String" > " < / span > Sunday< span class = "String" > " < / span > < / span > < span class = "Keyword" > then< / span > go_to_church()
2009-12-31 04:43:55 +00:00
< span class = "Keyword" > else< / span > go_to_work()
2009-12-21 16:41:45 +00:00
< / pre > < pre class = "idle" > < span class = "Keyword" > if< / span > (day < span class = "Keyword" > ===< / span > < span class = "String" > < span class = "String" > " < / span > Tuesday< span class = "String" > " < / span > < / span > ) {
eat_breakfast();
} < span class = "Keyword" > else< / span > < span class = "Keyword" > if< / span > (day < span class = "Keyword" > ===< / span > < span class = "String" > < span class = "String" > " < / span > Wednesday< span class = "String" > " < / span > < / span > ) {
go_to_the_park();
} < span class = "Keyword" > else< / span > < span class = "Keyword" > if< / span > (day < span class = "Keyword" > ===< / span > < span class = "String" > < span class = "String" > " < / span > Saturday< span class = "String" > " < / span > < / span > ) {
2009-12-24 01:48:55 +00:00
< span class = "Keyword" > if< / span > (day < span class = "Keyword" > ===< / span > bingo_day) {
go_to_bingo();
go_dancing();
}
2009-12-21 16:41:45 +00:00
} < span class = "Keyword" > else< / span > < span class = "Keyword" > if< / span > (day < span class = "Keyword" > ===< / span > < span class = "String" > < span class = "String" > " < / span > Sunday< span class = "String" > " < / span > < / span > ) {
go_to_church();
} < span class = "Keyword" > else< / span > {
go_to_work();
}
< / pre > < br class = 'clear' / > < / div >
2009-12-24 00:42:18 +00:00
< p id = "try" >
< b class = "header" > Try/Catch/Finally< / b >
2009-12-24 07:01:39 +00:00
Try/catch statements are just about the same as JavaScript (although
2009-12-24 08:12:07 +00:00
they work as expressions).
2009-12-24 00:42:18 +00:00
< / p >
< div class = 'code' > < pre class = "idle" > < span class = "Keyword" > try< / span >
2009-12-21 16:41:45 +00:00
all_hell_breaks_loose()
cats_and_dogs_living_together()
< span class = "Keyword" > catch< / span > error
2009-12-31 18:01:10 +00:00
print(error)
2009-12-21 16:41:45 +00:00
< span class = "Keyword" > finally< / span >
2009-12-31 04:43:55 +00:00
clean_up()
2009-12-21 16:41:45 +00:00
< / pre > < pre class = "idle" > < span class = "Keyword" > try< / span > {
all_hell_breaks_loose();
cats_and_dogs_living_together();
} < span class = "Keyword" > catch< / span > (error) {
< span class = "LibraryFunction" > print< / span > (error);
} < span class = "Keyword" > finally< / span > {
clean_up();
}
< / pre > < br class = 'clear' / > < / div >
2010-01-05 05:19:22 +00:00
< p id = "strings" >
2009-12-24 00:42:18 +00:00
< b class = "header" > Multiline Strings< / b >
Multiline strings are allowed in CoffeeScript.
< / p >
2009-12-31 18:01:10 +00:00
< div class = 'code' > < pre class = "idle" > moby_dick< span class = "Keyword" > :< / span > < span class = "String" > < span class = "String" > " < / span > Call me Ishmael. Some years ago --< / span >
2009-12-21 16:41:45 +00:00
< span class = "String" > never mind how long precisely -- having little< / span >
< span class = "String" > or no money in my purse, and nothing particular< / span >
< span class = "String" > to interest me on shore, I thought I would sail< / span >
< span class = "String" > about a little and see the watery part of the< / span >
< span class = "String" > world...< span class = "String" > " < / span > < / span >
2009-12-24 06:22:41 +00:00
2009-12-26 07:17:34 +00:00
< / pre > < pre class = "idle" > < span class = "Storage" > var< / span > moby_dick;
moby_dick < span class = "Keyword" > =< / span > < span class = "String" > < span class = "String" > " < / span > Call me Ishmael. Some years ago -- \< / span >
2009-12-24 06:22:41 +00:00
< span class = "String" > never mind how long precisely -- having little \< / span >
< span class = "String" > or no money in my purse, and nothing particular \< / span >
< span class = "String" > to interest me on shore, I thought I would sail \< / span >
< span class = "String" > about a little and see the watery part of the \< / span >
2009-12-21 16:41:45 +00:00
< span class = "String" > world...< span class = "String" > " < / span > < / span > ;
2009-12-26 07:17:34 +00:00
< / pre > < button onclick = 'javascript: var moby_dick ;
moby_dick = "Call me Ishmael. Some years ago -- \
2009-12-24 06:22:41 +00:00
never mind how long precisely -- having little \
or no money in my purse, and nothing particular \
to interest me on shore, I thought I would sail \
about a little and see the watery part of the \
world...";
;alert(moby_dick);'>run: moby_dick< / button > < br class = 'clear' / > < / div >
2009-12-31 18:01:10 +00:00
2009-12-26 17:05:57 +00:00
< h2 id = "resources" > Resources< / h2 >
2009-12-31 18:01:10 +00:00
2009-12-31 23:22:51 +00:00
< ul >
< li >
< a href = "http://github.com/jashkenas/coffee-script/" > Source Code< / a > < br / >
Use < tt > bin/coffee< / tt > to test your changes, or < tt > rake gem:install< / tt > to
create and install a custom version of the gem. If you're hacking on the
parser, use < tt > rake build:parser< / tt > to rebuild it.
< / li >
< li >
< a href = "http://github.com/jashkenas/coffee-script/issues" > Bugs and Feature Requests< / a >
< / li >
2010-01-05 04:26:27 +00:00
< li >
< a href = "http://github.com/jnicklas/bistro_car" > BistroCar< / a > < br / >
2010-01-05 14:29:10 +00:00
A Rails plugin by
2010-01-05 05:19:22 +00:00
< a href = "http://github.com/jnicklas" > Jonas Nicklas< / a >
that includes CoffeeScript helpers,
2010-01-05 04:26:27 +00:00
bundling and minification.
< / li >
2009-12-31 23:22:51 +00:00
< / ul >
2009-12-25 08:16:56 +00:00
2009-12-24 17:54:12 +00:00
< h2 id = "contributing" > Contributing< / h2 >
2009-12-25 08:16:56 +00:00
2009-12-24 17:54:12 +00:00
< p >
Here's a wish list of things that would be wonderful to have in
CoffeeScript:
< / p >
2009-12-25 08:16:56 +00:00
2009-12-24 17:54:12 +00:00
< ul >
2010-01-05 05:34:18 +00:00
< li >
A clean, safe syntax for manipulating the prototype chain, and performing
2010-01-05 14:29:10 +00:00
inheritance. < a href = "#inheritance" > < b > extends< / b > and < b > super< / b > < / a > are the start of this, but
2010-01-05 05:34:18 +00:00
aren't a complete answer.
< / li >
2009-12-24 17:54:12 +00:00
< li >
2009-12-31 18:01:10 +00:00
A CoffeeScript version of the compiler, perhaps using Alessandro Warth's
2009-12-24 17:54:12 +00:00
< a href = "http://tinlizzie.org/ometa/" > OMeta< / a > .
< / li >
< li >
Test cases for any syntax errors you encounter that you think CoffeeScript
should be able to compile properly.
< / li >
< li >
2009-12-25 08:16:56 +00:00
A tutorial that introduces CoffeeScript from the ground up for folks
2009-12-24 17:54:12 +00:00
without knowledge of JavaScript.
< / li >
< li >
Integration with Processing.js's JavaScript API (this would depend on
having a JavaScript version of the compiler).
< / li >
2009-12-24 18:31:44 +00:00
< li >
2009-12-25 08:16:56 +00:00
A lot of the code generation in < tt > nodes.rb< / tt > gets into messy
2009-12-24 18:31:44 +00:00
string manipulation. Techniques for cleaning this up across the board
would be appreciated.
< / li >
2009-12-24 17:54:12 +00:00
< / ul >
2009-12-25 08:16:56 +00:00
2009-12-24 08:12:07 +00:00
< h2 id = "change_log" > Change Log< / h2 >
2009-12-31 18:01:10 +00:00
2010-01-10 19:45:44 +00:00
< p >
< b class = "header" style = "margin-top: 20px;" > 0.2.2< / b >
The "splat" symbol has been changed from a prefix asterisk < tt > *< / tt > , to
a postfix ellipsis < tt > ...< / tt > . Added JavaScript's < tt > in< / tt > operator,
empty < tt > return< / tt > statements, and empty < tt > while< / tt > loops.
Constructor functions that start with capital letters now include a
safety check to make sure that the new instance of the object is returned.
The < tt > extends< / tt > keyword now functions identically to < tt > goog.inherits< / tt >
in Google's Closure Library.
< / p >
2010-01-05 14:29:10 +00:00
< p >
< b class = "header" style = "margin-top: 20px;" > 0.2.1< / b >
Arguments objects are now converted into real arrays when referenced.
< / p >
2010-01-05 05:19:22 +00:00
< p >
< b class = "header" style = "margin-top: 20px;" > 0.2.0< / b >
Major release. Significant whitespace. Better statement-to-expression
conversion. Splats. Splice literals. Object comprehensions. Blocks.
The existence operator. Many thanks to all the folks who posted issues,
2010-01-05 14:29:10 +00:00
with special thanks to
2010-01-05 05:19:22 +00:00
< a href = "http://github.com/kamatsu" > Liam O'Connor-Davis< / a > for whitespace
and expression help.
< / p >
2009-12-27 20:49:11 +00:00
< p >
< b class = "header" style = "margin-top: 20px;" > 0.1.6< / b >
Bugfix for running < tt > coffee --interactive< / tt > and < tt > --run< / tt >
2009-12-31 18:01:10 +00:00
from outside of the CoffeeScript directory. Bugfix for nested
function/if-statements.
2009-12-27 20:49:11 +00:00
< / p >
2009-12-31 18:01:10 +00:00
2009-12-27 05:25:37 +00:00
< p >
< b class = "header" style = "margin-top: 20px;" > 0.1.5< / b >
Array slice literals and array comprehensions can now both take Ruby-style
2009-12-31 18:01:10 +00:00
ranges to specify the start and end. JavaScript variable declaration is
now pushed up to the top of the scope, making all assignment statements into
2009-12-27 05:25:37 +00:00
expressions. You can use < tt > \< / tt > to escape newlines.
The < tt > coffee-script< / tt > command is now called < tt > coffee< / tt > .
< / p >
2009-12-26 00:35:57 +00:00
2009-12-25 22:43:24 +00:00
< p >
< b class = "header" style = "margin-top: 20px;" > 0.1.4< / b >
The official CoffeeScript extension is now < tt > .coffee< / tt > instead of
2009-12-26 00:35:57 +00:00
< tt > .cs< / tt > , which properly belongs to
2009-12-25 22:43:24 +00:00
< a href = "http://en.wikipedia.org/wiki/C_Sharp_(programming_language)" > C#< / a > .
Due to popular demand, you can now also use < tt > =< / tt > to assign. Unlike
JavaScript, < tt > =< / tt > can also be used within object literals, interchangeably
2009-12-26 00:35:57 +00:00
with < tt > :< / tt > . Made a grammatical fix for chained function calls
like < tt > func(1)(2)(3)(4)< / tt > . Inheritance and super no longer use
< tt > __proto__< / tt > , so they should be IE-compatible now.
2009-12-25 22:43:24 +00:00
< / p >
2009-12-25 22:18:05 +00:00
2009-12-25 08:16:56 +00:00
< p >
< b class = "header" style = "margin-top: 20px;" > 0.1.3< / b >
2009-12-26 16:57:13 +00:00
The < tt > coffee< / tt > command now includes < tt > --interactive< / tt > ,
2009-12-25 08:16:56 +00:00
which launches an interactive CoffeeScript session, and < tt > --run< / tt > ,
which directly compiles and executes a script. Both options depend on a
working installation of Narwhal.
2009-12-25 22:18:05 +00:00
The < tt > aint< / tt > keyword has been replaced by < tt > isnt< / tt > , which goes
2009-12-25 08:16:56 +00:00
together a little smoother with < tt > is< / tt > .
Quoted strings are now allowed as identifiers within object literals: eg.
< tt > {"5+5": 10}< / tt > .
2009-12-25 22:18:05 +00:00
All assignment operators now use a colon: < tt > +:< / tt > , < tt > -:< / tt > ,
2009-12-25 08:16:56 +00:00
< tt > *:< / tt > , etc.
< / p >
2009-12-24 20:02:28 +00:00
< p >
2009-12-25 01:05:55 +00:00
< b class = "header" style = "margin-top: 20px;" > 0.1.2< / b >
2009-12-25 08:16:56 +00:00
Fixed a bug with calling < tt > super()< / tt > through more than one level of
2009-12-25 01:05:55 +00:00
inheritance, with the re-addition of the < tt > extends< / tt > keyword.
2009-12-25 08:16:56 +00:00
Added experimental < a href = "http://narwhaljs.org/" > Narwhal< / a >
support (as a Tusk package), contributed by
2009-12-25 01:05:55 +00:00
< a href = "http://tlrobinson.net/" > Tom Robinson< / a > , including
< b > bin/cs< / b > as a CoffeeScript REPL and interpreter.
New < tt > --no-wrap< / tt > option to suppress the safety function
wrapper.
< / p >
2009-12-25 08:16:56 +00:00
2009-12-25 01:05:55 +00:00
< p >
< b class = "header" style = "margin-top: 20px;" > 0.1.1< / b >
2009-12-24 20:02:28 +00:00
Added < tt > instanceof< / tt > and < tt > typeof< / tt > as operators.
< / p >
2009-12-25 08:16:56 +00:00
2009-12-24 08:12:07 +00:00
< p >
2009-12-25 01:05:55 +00:00
< b class = "header" style = "margin-top: 20px;" > 0.1.0< / b >
2009-12-24 08:12:07 +00:00
Initial CoffeeScript release.
< / p >
2009-12-21 16:41:45 +00:00
2009-12-20 03:55:58 +00:00
< / div >
< / body >
< / html >
