doc: Fleshed out docs on Function#defer.

This commit is contained in:
tjcrowder 2009-09-10 13:11:30 +01:00
parent 5f02032763
commit d4aa3b7b4a
1 changed files with 14 additions and 0 deletions

View File

@ -233,6 +233,8 @@ Object.extend(Function.prototype, (function() {
/**
* Function#defer(args...) -> Number
* - args (?): Optional arguments to pass into the function.
*
* Schedules the function to run as soon as the interpreter is idle.
*
* A "deferred" function will not run immediately; rather, it will run as soon
@ -241,6 +243,18 @@ Object.extend(Function.prototype, (function() {
* Behaves much like `window.setTimeout` with a delay set to `0`. Returns an
* ID that can be used to clear the timeout with `window.clearTimeout` before
* it runs.
*
* ### Example
*
* function showMsg(msg) {
* alert(msg);
* }
*
* showMsg("One");
* showMsg.defer("Two");
* showMsg("Three");
* // Alerts "One", then "Three", then (after a brief pause) "Two"
* // Note that "Three" happens before "Two"
**/
function defer() {
var args = update([0.01], arguments);