A specialized queue class that supports scheduling callbacks to execute sequentially, iteratively, even asynchronously.
Callbacks can be function refs or objects with the following keys. Only
the fn key is required.
fn -- The callback functioncontext -- The execution context for the callbackFn.args -- Arguments to pass to callbackFn.timeout -- Millisecond delay before executing callbackFn.
(Applies to each iterative execution of callback)iterations -- Number of times to repeat the callback.
until -- Repeat the callback until this function returns
true. This setting trumps iterations.autoContinue -- Set to false to prevent the AsyncQueue from
executing the next callback in the Queue after
the callback completes.id -- Name that can be used to get, promote, get the
indexOf, or delete this callback._defAddFne
Default functionality for the "add" event. Adds the callbacks
in the event facade to the queue. Callbacks successfully added to the
queue are present in the event's added property in the
after phase.
e
Event
the event object
_defExecFne
Default functionality for the "execute" event. Executes the callback function
e
Event
the event object
_defPromoteFne
Default functionality for the "promote" event. Promotes the named callback to the head of the queue.
The event object will contain a property "callback", which holds the id of a callback or the callback object itself.
e
Event
the custom event
_defRemoveFne
Default functionality for the "remove" event. Removes the callback from the queue.
The event object will contain a property "callback", which holds the id of a callback or the callback object itself.
e
Event
the custom event
_defShiftFne
Default functionality for the "shift" event. Shifts the callback stored in the event object's callback property from the queue if it is the first item.
e
Event
The event object
_executecallback
Handles the execution of callbacks. Returns a boolean indicating whether it is appropriate to continue running.
callback
Object
the callback object to execute
whether the run loop should continue
_getFullTypetype
Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.
NOTE: This method, unlike _getType, does no checking of the value passed in, and is designed to be used with the low level _publish() method, for critical path implementations which need to fast-track publish for performance reasons.
type
String
The short type to prefix
The prefixed type, if a prefix is set, otherwise the type passed in
_getTypeIf the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_hasPotentialSubscribersfullType
fullType
String
The fully prefixed type name
Whether the event has potential subscribers or not
_initInitializes the AsyncQueue instance properties and events.
_initEventsInitializes the instance events.
_monitorwhat
eventType
o
This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> click_attach, click_detach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring turned on or off (publish can't be turned off before it it published) by setting the events 'monitor' config.
what
String
'attach', 'detach', 'fire', or 'publish'
eventType
String | CustomEvent
The prefixed name of the event being monitored, or the CustomEvent object.
o
Object
Information about the event interaction, such as fire() args, subscription category, publish config
_parseTypeReturns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_preparecallback
Creates a wrapper function to execute the callback using the aggregated configuration generated by combining the static AsyncQueue.defaults, the instance defaults, and the specified callback settings.
The wrapper function is decorated with the callback configuration as properties for runtime modification.
a decorated function wrapper to execute the callback
_publishfullType
etOpts
ceOpts
The low level event publish implementation. It expects all the massaging to have been done
outside of this method. e.g. the type to fullType conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.
The published event. If called without etOpts or ceOpts, this will
be the default CustomEvent instance, and can be configured independently.
_schedulecallback
Schedules the execution of asynchronous callbacks.
callback
Object
the callback object to execute
whether the run loop should continue
addcallback
Add any number of callbacks to the end of the queue. Callbacks may be provided as functions or objects.
the AsyncQueue instance
addTargeto
Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified.
Events can only bubble if emitFacade is true.
Included in the event-custom-complex submodule.
o
EventTarget
the target to add
aftertype
fn
[context]
[arg*]
Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.
A subscription handle capable of detaching the subscription
beforeExecutes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.
For DOM and custom events: type, callback, context, 0-n arguments
For methods: callback, object (method host), methodName, context, 0-n arguments
detach handle
bubbleevt
Propagate an event. Requires the event-custom-complex module.
evt
CustomEvent
the custom event to propagate
the aggregated return value from Event.Custom.fire
detachtype
fn
context
Detach one or more listeners the from the specified event
type
String | Object
Either the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events.
fn
Function
The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
context
Object
The custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)
the host
detachAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
firetype
arguments
Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters.
The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.
If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.
type
String | Object
The type of the event, or an object that contains a 'type' property.
arguments
Object*
an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.
True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.
getCallbackid
Retrieve a callback by its id. Useful to modify the configuration while the queue is running.
id
String
the id assigned to the callback
the callback object
getEventtype
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
the custom event or null
getTargetsReturns an array of bubble targets for this object.
EventTarget[]
indexOfcallback
Returns the current index of a callback. Pass in either the id or callback function from getCallback.
index of the callback or -1 if not found
isRunningDetermines if the queue is waiting for a callback to complete execution.
true if queue is waiting for a from any initiated transactions
nextReturns the next callback needing execution. If a callback is configured to repeat via iterations or until, it will be returned until the completion criteria is met.
When the queue is empty, null is returned.
the callback to execute
ontype
fn
[context]
[arg*]
Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.
Callback functions for events published with emitFacade = true will
receive an EventFacade as the first argument (typically named "e").
These callbacks can then call e.preventDefault() to disable the
behavior published to that event's defaultFn. See the EventFacade
API for all available properties and methods. Subscribers to
non-emitFacade events will receive the arguments passed to fire()
after the event name.
To subscribe to multiple events at once, pass an object as the first argument, where the key:value pairs correspond to the eventName:callback, or pass an array of event names as the first argument to subscribe to all listed events with the same callback.
Returning false from a callback is supported as an alternative to
calling e.preventDefault(); e.stopPropagation();. However, it is
recommended to use the event methods whenever possible.
A subscription handle capable of detaching that subscription
oncetype
fn
[context]
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to on except the
listener is immediatelly detached when it is executed.
A subscription handle capable of detaching the subscription
onceAftertype
fn
[context]
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to after except the
listener is immediatelly detached when it is executed.
A subscription handle capable of detaching that subscription
parseTypetype
[pre]
Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.
an array containing:
pausePause the execution of the queue after the execution of the current callback completes. If called from code outside of a queued callback, clears the timeout for the pending callback. Paused queue can be restarted with q.run()
the AsyncQueue instance
promotecallback
Promotes the named callback to the top of the queue. If a callback is currently executing or looping (via until or iterations), the promotion is scheduled to occur after the current callback has completed.
the AsyncQueue instance
publishtype
opts
Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either case the custom event is returned.
type
String
the type, or name of the event
opts
Object
optional config params. Valid properties are:
the custom event
removecallback
Removes the callback from the queue. If the queue is active, the removal is scheduled to occur after the current callback has completed.
the AsyncQueue instance
runSets the queue in motion. All queued callbacks will be executed in order unless pause() or stop() is called or if one of the callbacks is configured with autoContinue: false.
the AsyncQueue instance
stopStop and clear the queue after the current execution of the current callback completes.
the AsyncQueue instance
subscribesubscribe to an event
unsubscribedetach a listener
unsubscribeAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
_runningUsed to indicate the queue is currently executing a callback.
defaultsStatic default values used to populate callback configuration properties. Preconfigured defaults include:
autoContinue: trueiterations: 1timeout: 10 (10ms between callbacks)until: (function to run until iterations <= 0)defaultsCallback defaults for this instance. Static defaults that are not overridden are also included.
completeEvent fired when there is no remaining callback in the running queue. Also fired after stop().