module:baja/coll/QueryCursor

module:baja/coll/QueryCursor

new (require("baja/coll/QueryCursor"))(source, curData)

Description:

  • Cursor for a Query.

Source:
Extends:
Parameters:
Name Type Description
source baja.coll.QueryResult
curData Object

Extends

Methods

after(func)

Description:

  • When the cursor is iterated, the before function will be called
    just after iteration has finished.

    When the function is called, this refers to the Cursor. The Cursor is also
    passed in as a argument to this function.

Source:
Parameters:
Name Type Description
func function

the after function.

before(func)

Description:

  • When the cursor is iterated, the before function will be called
    just before iteration starts.

    When the function is called, this refers to the Cursor. The Cursor is also
    passed in as a argument to this function.

Source:
Parameters:
Name Type Description
func function

the before function.

each(func)

Description:

  • Iterate through the Cursor and call a function for every item.

    When the function is called, this refers to the Cursor.

Source:
Overrides:
Parameters:
Name Type Description
func function

function called on every iteration with
the current row used as the first argument and row
index as the second argument.

get()

Description:

  • Return the current row.

Source:
Overrides:
Returns:

the cursor value (null if none available)

getSource() → {baja.coll.QueryResult}

Description:

  • Return the underlying Cursor's data source.

Source:
Returns:
Type
baja.coll.QueryResult