mirror of
https://github.com/Snigdha-OS/documentation.git
synced 2025-09-07 19:25:13 +02:00
72 lines
2.6 KiB
JavaScript
72 lines
2.6 KiB
JavaScript
'use strict';
|
|
|
|
var AlgoliaSearchHelper = require('./src/algoliasearch.helper');
|
|
var SearchParameters = require('./src/SearchParameters');
|
|
var SearchResults = require('./src/SearchResults');
|
|
|
|
/**
|
|
* The algoliasearchHelper module is the function that will let its
|
|
* contains everything needed to use the Algoliasearch
|
|
* Helper. It is a also a function that instanciate the helper.
|
|
* To use the helper, you also need the Algolia JS client v3.
|
|
* @example
|
|
* //using the UMD build
|
|
* var client = algoliasearch('latency', '6be0576ff61c053d5f9a3225e2a90f76');
|
|
* var helper = algoliasearchHelper(client, 'bestbuy', {
|
|
* facets: ['shipping'],
|
|
* disjunctiveFacets: ['category']
|
|
* });
|
|
* helper.on('result', function(event) {
|
|
* console.log(event.results);
|
|
* });
|
|
* helper
|
|
* .toggleFacetRefinement('category', 'Movies & TV Shows')
|
|
* .toggleFacetRefinement('shipping', 'Free shipping')
|
|
* .search();
|
|
* @example
|
|
* // The helper is an event emitter using the node API
|
|
* helper.on('result', updateTheResults);
|
|
* helper.once('result', updateTheResults);
|
|
* helper.removeListener('result', updateTheResults);
|
|
* helper.removeAllListeners('result');
|
|
* @module algoliasearchHelper
|
|
* @param {AlgoliaSearch} client an AlgoliaSearch client
|
|
* @param {string} index the name of the index to query
|
|
* @param {SearchParameters|object} opts an object defining the initial config of the search. It doesn't have to be a {SearchParameters}, just an object containing the properties you need from it.
|
|
* @param {SearchResultsOptions|object} searchResultsOptions an object defining the options to use when creating the search results.
|
|
* @return {AlgoliaSearchHelper} The helper instance
|
|
*/
|
|
function algoliasearchHelper(client, index, opts, searchResultsOptions) {
|
|
return new AlgoliaSearchHelper(client, index, opts, searchResultsOptions);
|
|
}
|
|
|
|
/**
|
|
* The version currently used
|
|
* @member module:algoliasearchHelper.version
|
|
* @type {number}
|
|
*/
|
|
algoliasearchHelper.version = require('./src/version');
|
|
|
|
/**
|
|
* Constructor for the Helper.
|
|
* @member module:algoliasearchHelper.AlgoliaSearchHelper
|
|
* @type {AlgoliaSearchHelper}
|
|
*/
|
|
algoliasearchHelper.AlgoliaSearchHelper = AlgoliaSearchHelper;
|
|
|
|
/**
|
|
* Constructor for the object containing all the parameters of the search.
|
|
* @member module:algoliasearchHelper.SearchParameters
|
|
* @type {SearchParameters}
|
|
*/
|
|
algoliasearchHelper.SearchParameters = SearchParameters;
|
|
|
|
/**
|
|
* Constructor for the object containing the results of the search.
|
|
* @member module:algoliasearchHelper.SearchResults
|
|
* @type {SearchResults}
|
|
*/
|
|
algoliasearchHelper.SearchResults = SearchResults;
|
|
|
|
module.exports = algoliasearchHelper;
|