dojo/AdapterRegistry.js

• Provides:

  • dojo.AdapterRegistry

• dojo.AdapterRegistry

  • type

    Function

  • parameters:
    • returnWrappers: (typeof Boolean)
  • summary

    A registry to make contextual calling/searching easier.

  • description

    Objects of this class keep list of arrays in the form [name, check,
    wrap, directReturn] that are used to determine what the contextual
    result of a set of checked arguments is. All check/wrap functions
    in this registry should be of the same arity.

  • example

    	// create a new registry
    	var reg = new dojo.AdapterRegistry();
    	reg.register("handleString",
    		dojo.isString,
    		function(str){
    			// do something with the string here
    		}
    	);
    	reg.register("handleArr",
    		dojo.isArray,
    		function(arr){
    			// do something with the array here
    		}
    	);
    
    	// now we can pass reg.match() *either* an array or a string and
    	// the value we pass will get handled by the right function
    	reg.match("someValue"); // will call the first function
    	reg.match(["someValue"]); // will call the second

• dojo.AdapterRegistry.register

  • parameters:
    • name: (typeof String)

      a way to identify this matcher.

    • check: (typeof Function)

      a function that arguments are passed to from the adapter's
      match() function.  The check function should return true if the
      given arguments are appropriate for the wrap function.

    • wrap: (typeof Function)
    • directReturn: (typeof Boolean)

      If directReturn is true, the value passed in for wrap will be
      returned instead of being called. Alternately, the
      AdapterRegistry can be set globally to "return not call" using
      the returnWrappers property. Either way, this behavior allows
      the registry to act as a "search" function instead of a
      function interception library.

    • override: (typeof Boolean)

      If override is given and true, the check function will be given
      highest priority. Otherwise, it will be the lowest priority
      adapter.

  • summary

    register a check function to determine if the wrap function or
    object gets selected

  • type

    Function

• dojo.AdapterRegistry.match

  • summary

    Find an adapter for the given arguments. If no suitable adapter
    is found, throws an exception. match() accepts any number of
    arguments, all of which are passed to all matching functions
    from the registered pairs.

  • type

    Function

• dojo.AdapterRegistry.unregister

  • parameters:
    • name
  • summary

    Remove a named adapter from the registry

  • type

    Function

• dojo.AdapterRegistry.pairs

  • type

    Array

• dojo.AdapterRegistry.returnWrappers

  • type

    bool

• dojo

  • type

    Object