Deprecate useFuzzyMatch in favor of setFuzzyMatch. Set default value to "auto"

Author: anttiai

README.md

@@ -71,8 +71,8 @@ client.setSuggestionsSize(20);
 
 #### Search with fuzzy matching
 ```js
-// Enable/disable fuzzy matching for typo tolerance (default "true")
-client.useFuzzyMatch(false);
+// Enable/disable fuzzy matching. Possible values true/false/"auto" (default: "auto")
+client.setFuzzyMatch(false);
 ```
 
 #### Set JSON Web Token (for authentication)
@@ -149,10 +149,18 @@ client.removeCustomFieldFilter('city');
 ```
 
 #### Manage paging
+Set page number, page size and sorting parameters. It's possible to order results by:
+- relevance (descending)
+- date (ascending or descending)
+- custom field value (ascending or descending. E.g. *custom_fields.price*)
 ```js
 // Defaults: page "1", pageSize "10", sortBy "relevance", sortOrder "desc"
 client.setPaging(page, pageSize, sortBy, sortOrder);
+```
+
+Other functions.
 
+```js
 // Next page (call search function to fetch results)
 client.nextPage();
 

src/index.js

@@ -66,7 +66,6 @@ var client = function(sitekey) {
    */
   this.getSettings = function() { return this.settings.getSettings(); }
   this.setLanguage = function(lang) { this.settings.setLanguage(lang); }
-  this.useFuzzyMatch = function(use) { this.settings.useFuzzyMatch(use); }
   this.setCategoryFilters = function(categories) { this.settings.setCategoryFilters(categories); }
   this.addCustomFieldFilter = function(fieldName, value) { this.settings.addCustomFieldFilter(fieldName, value); }
   this.removeCustomFieldFilter = function(fieldName, value) { this.settings.removeCustomFieldFilter(fieldName, value); }
@@ -84,7 +83,11 @@ var client = function(sitekey) {
   this.setPersonalizationEvents = function(events) { this.settings.setPersonalizationEvents(events); }
   this.setFilterObject = function(filter) { this.settings.setFilterObject(filter); }
   this.setShuffleAndLimitTo = function(shuffleAndLimitTo) { this.settings.setShuffleAndLimitTo(shuffleAndLimitTo); }
+  this.setFuzzyMatch = function(fuzzy) { this.settings.setFuzzyMatch(fuzzy); }
   //this.hitClicked = function(docid, position) { sendClickHit(this.sitekey, this.settings.getSettings().keyword, docid, position); }
+
+  // Deprecated
+  this.useFuzzyMatch = function(use) { this.settings.setFuzzyMatch(use); }
 }
 
 module.exports = client;

src/settings.js

@@ -4,7 +4,7 @@ var settings = function() {
   this.settings = {
     keyword: '*',
     callback: null,
-    fuzzy: true,
+    fuzzy: 'auto',
     paging: {
       page: 1,
       pageSize: 10,
@@ -44,7 +44,10 @@ var settings = function() {
     this.settings.lang = language;
   }
 
-  this.useFuzzyMatch = function(fuzzy) {
+  this.setFuzzyMatch = function(fuzzy) {
+    if (fuzzy !== true && fuzzy !== false && fuzzy !== 'auto') {
+      throw "fuzzy matching can be true, false, or 'auto'";
+    }
     this.settings.fuzzy = fuzzy;
   }