Merge pull request #18 from AddSearch/new-setting-to-cache-response

add new method: "setCacheResponseTime"

Author: anttiai

README.md

@@ -108,6 +108,24 @@ term **add**
 client.setPostfixWildcard(false);  
 ```
 
+
+#### Set enableLogicalOperators
+```js
+// (default: false)
+// enableLogicalOperators(true) = Support user specified logical operators (and/or/not) in the search query like "cat and dog"
+// enableLogicalOperators(false) = Treat logical operators in the search query as literal strings
+client.enableLogicalOperators(true);
+```
+
+#### Set cacheResponseTime
+Caching the response, define the time-to-live of the cache.
+
+```js
+// Specify time-to-live value in seconds
+client.setCacheResponseTime(3600);  
+```
+
+
 ### Pagination
 Set page number, page size and sorting parameters. It's possible to order results by:
 - relevance (descending)
@@ -197,13 +215,6 @@ client.setFilterObject(filter);
 client.setResultType('organic');
 ```
 
-#### Set enableLogicalOperators
-```js
-// (default: false)
-// enableLogicalOperators(true) = Support user specified logical operators (and/or/not) in the search query like "cat and dog"
-// enableLogicalOperators(false) = Treat logical operators in the search query as literal strings
-client.enableLogicalOperators(true);
-```
 
 ### Facets
 ```js

src/apifetch.js

@@ -80,7 +80,8 @@ var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRe
         settingToQueryParam(settings.jwt, 'jwt') +
         settingToQueryParam(settings.resultType, 'resultType') +
         settingToQueryParam(settings.userToken, 'userToken') +
-        settingToQueryParam(settings.numFacets, 'numFacets');
+        settingToQueryParam(settings.numFacets, 'numFacets') +
+        settingToQueryParam(settings.cacheResponseTime, 'cacheResponseWithTtlSeconds');
 
       // Add custom field filters
       if (settings.customFieldFilters) {

src/index.js

@@ -154,6 +154,7 @@ var client = function(sitekey, privatekey) {
   this.setShuffleAndLimitTo = function(shuffleAndLimitTo) { this.settings.setShuffleAndLimitTo(shuffleAndLimitTo); }
   this.setFuzzyMatch = function(fuzzy) { this.settings.setFuzzyMatch(fuzzy); }
   this.setPostfixWildcard = function(wildcard) { this.settings.setPostfixWildcard(wildcard); }
+  this.setCacheResponseTime = function(cacheResponseTime) { this.settings.setCacheResponseTime(cacheResponseTime) }
   this.setCollectAnalytics = function(collectAnalytics) { this.settings.setCollectAnalytics(collectAnalytics); }
   this.setThrottleTime = function(delay) { this.settings.setThrottleTime(delay); }
   this.setStatsSessionId = function(id) { this.sessionId = id; }

src/settings.js

@@ -19,7 +19,8 @@ var settings = function() {
     autocomplete: {
       size: 10
     },
-    enableLogicalOperators: false
+    enableLogicalOperators: false,
+    cacheResponseTime: null
   };
 
   this.getSettings = function() {
@@ -73,6 +74,10 @@ var settings = function() {
     this.settings.enableLogicalOperators = enableLogicalOperators;
   }
 
+  this.setCacheResponseTime = function(cacheResponseTime) {
+    this.settings.cacheResponseTime = cacheResponseTime;
+  }
+
   this.setPostfixWildcard = function(wildcard) {
     this.settings.postfixWildcard = wildcard;
   }