rename 'cache' option to 'useCache'

README.md

@@ -159,7 +159,7 @@ Additionaly after loading the SVG, the value of the `src` attribute of the `<img
 
 | Property name | Type | Default | Description |
 | ------------- | ---- | ------- | ----------- |
-| cache | boolean | `true` | If set to `true` the SVG will be cached using the absolute URL. The cache only persists for the lifetime of the page. Without caching images with the same absolute URL will trigger a new XMLHttpRequest but browser caching will still apply. |
+| useCache | boolean | `true` | If set to `true` the SVG will be cached using the absolute URL. The cache only persists for the lifetime of the page. Without caching images with the same absolute URL will trigger a new XMLHttpRequest but browser caching will still apply. |
 | copyAttributes | boolean | `true` | If set to `true` [attributes will be copied](#how-are-attributes-handled) from the `img` to the injected `svg` element. You may implement your own method for copying attributes in the `beforeInject` options hook. |
 | makeIdsUnique | boolean | `true` | If set to `true` the id of elements in the `<defs>` element that can be references by property values (for example 'clipPath') are made unique by appending the string "--inject-X", where X is a running number which increases with each injection. This is done to avoid duplicate ids in the DOM. |
 | beforeLoad | function(img) | `undefined` | Hook before SVG is loaded. The `img` element is passed as a parameter. If the hook returns a string it is used as the URL instead of the `img` element's `src` attribute. |
@@ -285,7 +285,7 @@ This example shows how to use SVGInject with mutiple options.
 
   <script>
     SVGInject.setOptions({
-      cache: false, // no caching
+      useCache: false, // no caching
       copyAttributes: false, // do not copy attributes from `<img>` to `<svg>`
       makeIdsUnique: false, // do not make ids used within the SVG unique
       afterLoad: function(svg) {

dist/svg-inject.js

@@ -26,7 +26,7 @@
   var DIV_ELEMENT = document[CREATE_ELEMENT]('div');
   var IS_SVG_SUPPORTED = typeof SVGRect != "undefined";
   var DEFAULT_OPTIONS = {
-    cache: TRUE,
+    useCache: TRUE,
     copyAttributes: TRUE,
     makeIdsUnique: TRUE
   };
@@ -304,7 +304,7 @@
      * elements.
      *
      * Options:
-     * cache: If set to `true` the SVG will be cached using the absolute URL. Default value is `true`.
+     * useCache: If set to `true` the SVG will be cached using the absolute URL. Default value is `true`.
      * copyAttributes: If set to `true` the attributes will be copied from `img` to `svg`. Dfault value
      *     is `true.
      * makeIdsUnique: If set to `true` the id of elements in the `<defs>` element that can be references by
@@ -352,10 +352,10 @@
           // URL path. Else use the imgElem src attribute value.
           var src = (options.beforeLoad && options.beforeLoad(imgElem)) || imgElem.src;
           var absUrl = getAbsoluteUrl(src);
-          var cache = options.cache;
+          var useCache = options.useCache;
 
           var setSvgLoadCacheValue = function(val) {
-            if (cache) {
+            if (useCache) {
               var svgLoad = svgLoadCache[absUrl];
               for (var i = 0; i < svgLoad[LENGTH]; ++i) {
                 svgLoad[i](val);
@@ -366,7 +366,7 @@
 
           removeEventListeners(imgElem);
 
-          if (cache) {
+          if (useCache) {
             var svgLoad = svgLoadCache[absUrl];
 
             var handleLoadValue = function(loadValue) {
@@ -404,7 +404,7 @@
                   // Invoke afterLoad hook which may modify the SVG element.
                   afterLoad(svgElem);
 
-                  if (cache) {
+                  if (useCache) {
                     // Update svgString because the SVG element can be modified in the afterLoad hook, so
                     // the modified SVG element is also used for all later cached injections
                     svgString = getXMLSerializer().serializeToString(svgElem);

examples/svg-inject.js

@@ -26,7 +26,7 @@
   var DIV_ELEMENT = document[CREATE_ELEMENT]('div');
   var IS_SVG_SUPPORTED = typeof SVGRect != "undefined";
   var DEFAULT_OPTIONS = {
-    cache: TRUE,
+    useCache: TRUE,
     copyAttributes: TRUE,
     makeIdsUnique: TRUE
   };
@@ -304,7 +304,7 @@
      * elements.
      *
      * Options:
-     * cache: If set to `true` the SVG will be cached using the absolute URL. Default value is `true`.
+     * useCache: If set to `true` the SVG will be cached using the absolute URL. Default value is `true`.
      * copyAttributes: If set to `true` the attributes will be copied from `img` to `svg`. Dfault value
      *     is `true.
      * makeIdsUnique: If set to `true` the id of elements in the `<defs>` element that can be references by
@@ -352,10 +352,10 @@
           // URL path. Else use the imgElem src attribute value.
           var src = (options.beforeLoad && options.beforeLoad(imgElem)) || imgElem.src;
           var absUrl = getAbsoluteUrl(src);
-          var cache = options.cache;
+          var useCache = options.useCache;
 
           var setSvgLoadCacheValue = function(val) {
-            if (cache) {
+            if (useCache) {
               var svgLoad = svgLoadCache[absUrl];
               for (var i = 0; i < svgLoad[LENGTH]; ++i) {
                 svgLoad[i](val);
@@ -366,7 +366,7 @@
 
           removeEventListeners(imgElem);
 
-          if (cache) {
+          if (useCache) {
             var svgLoad = svgLoadCache[absUrl];
 
             var handleLoadValue = function(loadValue) {
@@ -404,7 +404,7 @@
                   // Invoke afterLoad hook which may modify the SVG element.
                   afterLoad(svgElem);
 
-                  if (cache) {
+                  if (useCache) {
                     // Update svgString because the SVG element can be modified in the afterLoad hook, so
                     // the modified SVG element is also used for all later cached injections
                     svgString = getXMLSerializer().serializeToString(svgElem);