dojo/store/util/QueryResults.js

• Provides:

  • dojo.store.util.QueryResults

• dojo.store.util.QueryResults

  • type

    Function

  • parameters:
    • results: (typeof )
  • source: [view]
     if(!results){
      return results;
     }
     // if it is a promise it may be frozen
     if(results.then){
      results = dojo.delegate(results);
     }
     function addIterativeMethod(method){
      if(!results[method]){
       results[method] = function(){
        var args = arguments;
        return dojo.when(results, function(results){
         Array.prototype.unshift.call(args, results);
         return dojo.store.util.QueryResults(dojo[method].apply(dojo, args));
        });
       };
      }
     }
     addIterativeMethod("forEach");
     addIterativeMethod("filter");
     addIterativeMethod("map");
     if(!results.total){
      results.total = dojo.when(results, function(results){
       return results.length;
      });
     }
     return results;
  • summary

    A function that wraps the results of a store query with additional
    methods.

  • description

    QueryResults is a basic wrapper that allows for array-like iteration
    over any kind of returned data from a query.  While the simplest store
    will return a plain array of data, other stores may return deferreds or
    promises; this wrapper makes sure that *all* results can be treated
    the same.
    
    Additional methods include `forEach`, `filter` and `map`.

  • return_summary

    Object
    An array-like object that can be used for iterating over.

  • example

    Query a store and iterate over the results.
    
    	store.query({ prime: true }).forEach(function(item){
    		//	do something
    	});

  • chains:
    • Array.prototype.unshift: (call)

• dojo.store.util

  • type

    Object

  • summary

• dojo.store

  • type

    Object

  • summary

• dojo

  • type

    Object

  • summary