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

Update bloodhound.md #224

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

Update bloodhound.md #224

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/bloodhound.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,14 @@ Clears the internal search index that's powered by `local`, `prefetch`, and
engine.clear();
```

#### Bloodhound#clearRemoteCache()

Clears the remote transport cache.

```javascript
engine.clearRemoteCache();
```

### Options

When instantiating a Bloodhound suggestion engine, there are a number of
Expand Down Expand Up @@ -293,6 +301,8 @@ When configuring `remote`, the following options are available.
* `rateLimitWait` – The time interval in milliseconds that will be used by
`rateLimitBy`. Defaults to `300`.

* `cache` – Cache remote results. Defaults to `true`.

* `transform` – A function with the signature `transform(response)` that allows
you to transform the remote response before the Bloodhound instance operates
on it. Defaults to the [identity function].
Expand Down