Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation for the transport option #1623

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for the transport option #1623

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/bloodhound.md
View file
Open in desktop
Expand Up @@ -272,6 +272,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