dojo/store/Cache.js

• Provides:

  • dojo.store.Cache

• dojo.store.__CacheArgs

  • type

    Function

  • summary

    These are additional options for how caching is handled.

• dojo.store.__CacheArgs.constructor

  • constructor - constructor
  • type

    Function

  • summary

    These are additional options for how caching is handled.

• dojo.store.__CacheArgs.isLoaded

  • optional
  • type

    Function

  • summary

    This is a function that will be called for each item in a query response to determine
    if it is cacheable. If isLoaded returns true, the item will be cached, otherwise it
    will not be cached. If isLoaded is not provided, all items will be cached.

• dojo.store.Cache

  • type

    Function

  • example

    	var master = new dojo.store.Memory(data);
    	var cacher = new dojo.store.Memory();
    	var store = new dojo.store.Cache(master, cacher);

  • parameters:
    • masterStore: (typeof This)

      is the authoritative store, all uncached requests or non-safe requests will
      be made against this store.

    • cachingStore: (typeof This)

      is the caching store that will be used to store responses for quick access.
      Typically this should be a local store.

    • options: (typeof dojo.store.__CacheArgs)

      These are additional options for how caching is handled.

  • summary

    The Cache store wrapper takes a master store and a caching store,
    caches data from the master into the caching store for faster
    lookup. Normally one would use a memory store for the caching
    store and a server store like JsonRest for the master store.

• dojo.store.Cache.query

  • parameters:
    • query: (typeof Object|String)

      The object or string containing query information. Dependent on the query engine used.

    • directives: (typeof dojo.store.util.SimpleQueryEngine.__queryOptions)

      An optional keyword arguments object with additional parameters describing the query.

  • summary

    Query the underlying master store and cache any results.

  • return_summary

    dojo.store.util.QueryResults
    A QueryResults object that can be used to iterate over.

  • type

    Function

• dojo.store.Cache.get

  • parameters:
    • id: (typeof Number)

      The identifier for the object in question.

    • directives: (typeof dojo.store.__GetOptions)

      Any additional parameters needed to describe how the get should be performed.

  • summary

    Get the object with the specific id.

  • return_summary

    dojo.store.util.QueryResults
    A QueryResults object.

  • type

    Function

• dojo.store.Cache.add

  • parameters:
    • object: (typeof Object)

      The object to add to the store.

    • directives: (typeof dojo.store.__AddOptions)

      Any additional parameters needed to describe how the add should be performed.

  • summary

    Add the given object to the store.

  • return_summary

    Number
    The new id for the object.

  • type

    Function

• dojo.store.Cache.put

  • parameters:
    • object: (typeof Object)

      The object to put to the store.

    • directives: (typeof dojo.store.__PutOptions)

      Any additional parameters needed to describe how the put should be performed.

  • summary

    Put the object into the store (similar to an HTTP PUT).

  • return_summary

    Number
    The new id for the object.

  • type

    Function

• dojo.store.Cache.remove

  • parameters:
    • id: (typeof Number)

      The identifier for the object in question.

    • directives: (typeof dojo.store.__RemoveOptions)

      Any additional parameters needed to describe how the remove should be performed.

  • summary

    Remove the object with the specific id.

  • type

    Function

• dojo.store.Cache.evict

  • parameters:
    • id: (typeof Number)

      The identifier for the object in question.

  • summary

    Remove the object with the given id from the underlying caching store.

  • type

    Function

• dojo.store

  • type

    Object

• dojo

  • type

    Object