AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    Queue Class

    Defined in: yui3/src/yui/js/queue-base.js:9
    Module: yui-base
    Parent Module: yui

    A simple FIFO queue. Items are added to the Queue with add(1..n items) and removed using next().

    Constructor

    Queue

    (
    • item
    )

    Defined in yui3/src/yui/js/queue-base.js:9

    Parameters:

    • item MIXED multiple

      0..n items to seed the queue.

    Index

    Methods

    Properties

    Methods

    _init

    () protected

    Defined in yui3/src/yui/js/queue-base.js:23

    Initialize the queue

    add

    (
    • item
    )
    Object

    Defined in yui3/src/yui/js/queue-base.js:60

    Add 0..n items to the end of the queue.

    Parameters:

    • item MIXED multiple

      0..n items.

    Returns:

    Object:

    this queue.

    indexOf

    (
    • needle
    )
    Number

    Provided by the queue-promote module.

    Defined in yui3/src/queue-promote/js/queue-promote.js:9

    Returns the current index in the queue of the specified item

    Parameters:

    • needle MIXED

      the item to search for

    Returns:

    Number:

    the index of the item or -1 if not found

    last

    () MIXED

    Defined in yui3/src/yui/js/queue-base.js:50

    Get the last in the queue. LIFO support.

    Returns:

    MIXED:

    the last item in the queue.

    next

    () MIXED

    Defined in yui3/src/yui/js/queue-base.js:40

    Get the next item in the queue. FIFO support

    Returns:

    MIXED:

    the next item in the queue.

    promote

    (
    • item
    )

    Provided by the queue-promote module.

    Defined in yui3/src/queue-promote/js/queue-promote.js:20

    Moves the referenced item to the head of the queue

    Parameters:

    • item MIXED

      an item in the queue

    remove

    (
    • item
    )

    Provided by the queue-promote module.

    Defined in yui3/src/queue-promote/js/queue-promote.js:34

    Removes the referenced item from the queue

    Parameters:

    • item MIXED

      an item in the queue

    size

    () Number

    Defined in yui3/src/yui/js/queue-base.js:73

    Returns the current number of queued items.

    Returns:

    Number:

    The size.

    Properties

    _q

    Array protected

    Defined in yui3/src/yui/js/queue-base.js:30

    The collection of enqueued items