Gallery

Modules

Documentation

Context Navigation

YUI Library is not responsible for bugs or support with this module. It is available as a free service. For support please contact the module owner with the provided links.

Async Command (gallery-async-command) on cdn

Last Updated: 06/21/12

+ 0 -

Steven Olmsted

YUI Contributor

See 42 more by this user.

Created: 12/1/11
Last CDN Push: 06/20/12
Build Tag: gallery-2012.06.20-20-07
Project: YUI 3
License: YUI BSD
YUI Version: 3.5.1
Free for use.

This module along with gallery-async is a rewrite of gallery-asyncronouscommandqueue.

Y.AsyncCommand is a class that represents an asynchronous function and manages its execution state. This provides a common way to track when the function is executed, when it completes, if it succeeds or fails, and if it returns an error or a response value.

If you haven't seen gallery-async, start there: http://yuilibrary.com/gallery/show/Async
It does more useful things with commands and provides convenient syntax so you may not ever need to deal with AsyncCommand instances directly.

Y.AsyncCommand

Attributes:

args - initOnly - Array of arguments to be passed to the command function.
completed - readOnly - Boolean value indicating the completed status of the command.
ctx - initOnly - Execution context for the command function.
error - readOnly - Error value passed to the failure event.
failed - readOnly - Boolean value indicating the failed status of the command.
fn - initOnly - The command function to execute. This function receives a special success callback function as the first parameter. The success callback function has a method parameter called fail. One of these callback functions must be called in order to complete the command.
started - readOnly - Boolean value indicating the started status of the command.
value - readOnly - Value passed to the success event.

Events:

complete - fireOnce - Fired when the command function completes. (After failure or success.)
failure - fireOnce - Fired when the command function fails.
start - fireOnce - Fired when the command function starts.
success - fireOnce - Fired when the command function succeeds.

Methods:

run - chainable - Execute the command function. No Parameters.

Code Sample

<script src="http://yui.yahooapis.com/3.5.1/build/yui/yui-min.js"></script>

YUI({
    //Last Gallery Build of this module
    gallery: 'gallery-2012.06.20-20-07'
}).use('gallery-async-command', function(Y) {
    new Y.AsyncCommand({
        fn: function (success) {
            // Do something asynchronous
            Y.later(5000, null, function () {
                // Make sure to call either success() or success.fail()
                success('Woot!  It worked!');
            });
        }
    }).run().on('complete', function (eventFacade) {
        alert(eventFacade.value);
    });
});