Added the cacheImagesOutput( url )

Kicks out the encoded string for a URL

Author: paulprins

README.md

@@ -1,6 +1,6 @@
 #jQuery Cache Images plugin  
 
-Plugin for jQuery that allows for the easy caching of image files in the browsers localstorage. The local storage approach allows the media to persist across sessions, while the browser manages all of the cross-domain privacy protections.  
+Plugin for jQuery that allows for the easy caching of image files in the browsers localStorage. The local storage approach allows the media to persist across sessions, while the browser manages all of the cross-domain privacy protections.  
 
 ## Using the Plugin  
 The plugin can be used two ways. It can either be applied to a specific element in the DOM, or you can apply it to a container that will have images within it. Both approached will bind the Cache Image plugin to all future changes that occur to those elements or their children.  
@@ -18,7 +18,7 @@ Each of these is optional.
 `$('img#AnElement').cacheImages();`  
 Any selector here works, however it will bind to only existing elements. If you need to have the caching work on future dynamically created elements use the second approach.
 
-### Attached to a Parent Container  *Coming Soon*
+### *Attached to a Parent Container  **Coming Soon***
 `$('div#AwesomeContainer').cacheImages();`
 This will watch for changes to the parent and all child elements for changes that involve images. The plugin will step in, cache the image into local storage, and reveil the image to the user.
 
@@ -29,10 +29,16 @@ Allows you to easily drop caching into your dom additions. It will look at the c
 ### Manually caching an image  
 `cacheImagesFetchURL('http://upload.wikimedia.org/wikipedia/commons/9/92/Muraltmuur.jpg');`  
 
-Attempts to cache that image into your clients browser local storage. This can be very helpful if you have an app where you are storying data into webSQL or IndexedDB and want to grab images during an initial sync, but those images might not be needed until later. By caching the images earily you ensure that they would be available along with the other data.  
+Attempts to cache that image into your clients browser local storage. This can be very helpful if you have an app where you are storying data into webSQL or IndexedDB and want to grab images during an initial sync, but those images might not be needed until later. By caching the images early you ensure that they would be available along with the other data.  
 
 These images would later be automatically placed due to element or parent binding, or you could manually place them (see below).
 
+### Manually retrieving an image
+`cacheImagesOutput('http://upload.wikimedia.org/wikipedia/commons/9/92/Muraltmuur.jpg');`  
+  
+If you need to use an image in your inline css, or in another context where you just need the encoded string you should use this function. It will return the encoded string if it has already been cached, or it will return the default (if that is already encoded), or null. This will not fetch the URL since that is an asynchronous event that cannot return your output.
+
+
 # Credits and Thanks  
 * Based Heavily off of @doomhz plugin [jQueryImageCache](https://github.com/doomhz/jQuery-Image-Cache)
 * Utilizing base64 encoding from @mathias [Encoding XHR image data](http://jsperf.com/encoding-xhr-image-data/33)

jquery.cacheImages.js

@@ -213,6 +213,27 @@
 	window.cacheImagesFetchURL = function( url ){
 		$('body').append( $('<img style="display: none;" />').addClass('cacheImagesRemove').cacheImages({url: url}) );
 	};
+	/*
+	 *	Manually cache an image into the local storage
+	 */
+	window.cacheImagesOutput = function( url ){
+		var tempKey = window.cacheImagesConfig.storagePrefix + ':' + url;
+		if( window.localStorage.getItem( tempKey ) != null ){
+			return window.localStorage.getItem( tempKey );	// Image exists in the cache
+		}else{
+			
+			if( /^data:image/.test( window.cacheImagesConfig.defaultImage ) === true ){
+				return window.cacheImagesConfig.defaultImage;	// this is an encoded string
+			}
+
+			tempKey = window.cacheImagesConfig.storagePrefix + ':' + window.cacheImagesConfig.defaultImage;
+			if( window.localStorage.getItem( tempKey ) != null ){
+				return window.localStorage.getItem( tempKey );	// Default URL was already cached
+			}
+		}
+
+		return null;	// Neither the image or the cached version existsed
+	};
 	/*
 	 *	Will remove all of the cached images from their localStorage
 	 */