Merge pull request corejavascript#130 from cpius/patch-1

jlbooker · web-flow · commit c93a8b5ccd21 · 2017-03-21T10:16:48.000-04:00
Add documentation for the transport option
diff --git a/doc/bloodhound.md b/doc/bloodhound.md
@@ -297,6 +297,17 @@ When configuring `remote`, the following options are available.
    you to transform the remote response before the Bloodhound instance operates 
    on it. Defaults to the [identity function].
 
+* `transport` – A function with the signature `transport(options, onSuccess, onError)`
+  that allows you to specify a custom transport:
+  ```javascript
+  transport: function (options, onSuccess, onError) {
+    // Modify the options or replace the next line
+    $.ajax(options)
+      .done(function(data, textStatus, request) { onSuccess(data); })
+      .fail(function(request, textStatus, errorThrown) { onError(errorThrown); });
+  }
+  ```
+
 <!-- section links -->
 
 [identity function]: http://en.wikipedia.org/wiki/Identity_function
