Type: Function

Function Methods.

See Also:

Function: Function.from

If the passed argument is a function, it will return itself. Otherwise, it will return a function that returns the passed argument.

Syntax:

var foo = Function.from(obj);

Arguments:

  1. obj - (mixed) If this argument is a function, it will simply return itself. Otherwise, an object you wish to convert into a function that returns the argument.

Returns:

  • (function) Either the passed function or an anonymous function that returns the passed argument.

Examples:

var fn = Function.from(42);
alert(fn());    // alerts '42'
 
var fn2 = Function.from(fn);
alert(fn2());   // alerts '42'

Notes:

This function is equivalent to the following deprecated MooTools 1.2 methods:

var fn1 = Function.from();      // equivalent to var fn1 = function(){};
var fn2 = Function.from(foo);   // equivalent to var fn2 = function(){ return foo; };

Function: Function.attempt

Tries to execute a number of functions. Returns immediately the return value of the first non-failed function without executing successive functions, or null.

Syntax:

Function.attempt(fn[, fn, fn, fn, ...]);

Arguments:

  • fn - (function) Any number of functions to execute.

Returns:

  • (mixed) Standard return of the called function.
  • (null) null if all the passed functions fail.

Examples:

var result = Function.attempt(function(){
    return some.made.up.object;
}, function(){
    return jibberish.that.doesnt.exists;
}, function(){
    return false;
});
 
//result is false
 
var failure, success;
 
Function.attempt(function(){
    some.made.up.object = 'something';
    success = true;
}, function(){
    failure = true;
});
 
if (success) alert('yey!');

Notes:

This method is an equivalent of $try from MooTools 1.2.

Function method: extend

Extends a function with a new method or property.

Syntax:

myFunction.extend(key, value);
 
// Or
 
myFunction.extend(object);

Arguments:

  1. key - (string) The key of the method or property
  2. value - (mixed) The function or property value

Or

  1. object - (object) An object with the key value pairs to add multiple methods or properties

Returns:

  • (function) The function

Example:

var myFunction = function(){};
myFunction.extend('alert', function(text){
    alert(text);
});
myFunction.alert('Hello!'); // alerts Hello!
 
// Using objects
myFunction.extend({
    alert: function(text){
        alert(text);
    }
});

Function method: implement

Implements a method to the prototype of the function.

Syntax:

myFunction.implement(key, value);
 
// Or
 
myFunction.implement(object);

Arguments:

  1. key - (string) The method of property name in the prototype
  2. value - (mixed) The function or another value in the prototype

Or

  1. object - (object) An object with key-value pairs to add multiple methods or properties to the function it's prototype.

Returns:

  • (function) The function

Example:

var myFunction = function(){};
myFunction.implement('alert', function(text){
    alert(text);
});
var myInstance = new myFunction();
myInstance.alert('Hello!'); // alerts Hello!
 
// Using objects
myInstance.implement({
    alert: function(text){
        alert(text);
    }
});

Notes:

The difference between implement and extend, is that implement adds the value to the prototype. So with implement each instance of the function will have this method or property while with extend the method or property is added to a single instance.

Function method: attempt

Tries to execute a single function. Returns immediately the return value of the function if it does not fail, or null.

Syntax:

var myFunctionResult = myFunction.attempt(args[, bind]);

Arguments:

  1. args - (mixed) An argument, or array of arguments to run the function with.
  2. bind - (object, optional) The object that the "this" of the function will refer to.

Returns:

  • (mixed) This Function's return value.
  • (null) null if the function fails.

Examples:

var myFunction = function(){
    return some.made.up.object;
};
myFunction.attempt(); // returns 'null'
 
 
var myFunction = function(val){
    return val;
};
myFunction.attempt(false); // returns 'false'

See Also:

Function method: pass

Returns a closure with arguments and bind.

Syntax:

var newFunction = myFunction.pass([args[, bind]]);

Arguments:

  1. args - (mixed, optional) The arguments to pass to the function (must be an array if passing more than one argument).
  2. bind - (object, optional) The object that the "this" of the function will refer to.

Returns:

  • (function) The function whose arguments are passed when called.

Example:

var myFunction = function(){
    var result = 'Passed: ';
    for (var i = 0, l = arguments.length; i < l; i++){
        result += (arguments[i] + ' ');
    }
    return result;
}
var myHello = myFunction.pass('hello');
var myItems = myFunction.pass(['peach', 'apple', 'orange']);
 
// Later in the code, the functions can be executed:
alert(myHello()); // passes 'hello' to myFunction.
alert(myItems()); // passes the array of items to myFunction.

See Also:

Function:bind

Function method: bind

Changes the scope of this within the target function to refer to the bind parameter.

Syntax:

myFunction.bind([bind[, arg1, arg2, ...]]);

Arguments:

  1. bind - (object, optional) The object that the "this" of the function will refer to.
  2. arg1, arg2, ... - (mixed, optional) The arguments to pass to the function. If the bound function is called with other arguments the arguments are concatenated.

Returns:

  • (function) The bound function.

Example:

function myFunction(){
    // Note that 'this' here refers to window, not an element.
    // the function must be bound to the element we want to manipulate.
    this.setStyle('color', 'red');
};
var myBoundFunction = myFunction.bind(myElement);
myBoundFunction(); // makes myElement's text red
 
// To show how bind works the following example:
var myBoundFunction = myFunction.bind(anyVar);
// is roughly equivalent with
var myBoundFunction = function(){
    return myFunction.call(this);
};

See Also:

Function:pass

Function method: delay

Delays the execution of a function by a specified duration.

Syntax:

var timeoutID = myFunction.delay(delay[, bind[, args]]);

Arguments:

  1. delay - (number) The duration to wait (in milliseconds).
  2. bind - (object, optional) The object that the "this" of the function will refer to.
  3. args - (mixed, optional) The arguments passed (must be an array if the arguments are greater than one).

Returns:

  • (number) The JavaScript timeout id (for clearing delays).

Example:

var myFunction = function(){ alert('moo! Element id is: ' + this.id); };
 
//wait 50 milliseconds, then call myFunction and bind myElement to it
myFunction.delay(50, myElement); // alerts: 'moo! Element id is: ... '
 
//an anonymous function which waits a second and then alerts
(function(){ alert('one second later...'); }).delay(1000);
 
//to stop the delay, clearTimeout can be used like so:
var timer = myFunction.delay(50);
clearTimeout(timer);

See Also:

Function method: periodical

Executes a function in the specified intervals of time. Periodic execution can be stopped using the clearInterval function.

Syntax:

var intervalID = myFunction.periodical(period[, bind[, args]]);

Arguments:

  1. period - (number) The duration of the intervals between executions.
  2. bind - (object, optional) The object that the "this" of the function will refer to.
  3. args - (mixed, optional) The arguments passed (must be an array if the arguments are greater than one).

Returns:

  • (number) The Interval id (for clearing a periodical).

Example:

var Site = { counter: 0 };
var addCount = function(){ this.counter++; };
addCount.periodical(1000, Site); //adds the number of seconds at the Site.
 
// the interval can be stopped using the clearInterval function
var timer = myFunction.periodical(1000);
clearInterval(timer);

See Also:

Deprecated Functions

Function method: create

This function has been deprecated.

Function method: bindWithEvent

This function has been deprecated.

Example how you could replace this method:

myElement.addEvent('click', function(e){
    myFunction.call(bind, e);
});

Function method: run

This function has been deprecated.

Replacement example

fn.apply(thisArg, arguments); // Old API: fn.run(arguments, thisArg);

Comments

comments powered by Disqus

This documentation is released under a Attribution-NonCommercial-ShareAlike 3.0 License.