Skip to content

Commit

Permalink
docs(instantiate): use existing signature of toggleRefine (algolia/al…
Browse files Browse the repository at this point in the history
…goliasearch-helper-js#621)

The way this was documented throws an error

see https://codesandbox.io/s/o7k7w28n86
  • Loading branch information
Haroenv authored Sep 21, 2018
1 parent 22b69f6 commit 1c83408
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions packages/algoliasearch-helper/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@ var SearchResults = require('./src/SearchResults');
* helper.on('result', function(result) {
* console.log(result);
* });
* helper.toggleRefine('Movies & TV Shows')
* .toggleRefine('Free shipping')
* .search();
* helper
* .toggleRefine('category', 'Movies & TV Shows')
* .toggleRefine('shipping', 'Free shipping')
* .search();
* @example
* // The helper is an event emitter using the node API
* helper.on('result', updateTheResults);
Expand Down

0 comments on commit 1c83408

Please sign in to comment.