Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Commit

Permalink
remove jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
eunjae-lee committed Dec 23, 2020
1 parent 7bec235 commit 5aa1206
Showing 1 changed file with 2 additions and 22 deletions.
24 changes: 2 additions & 22 deletions src/algoliasearch.helper.js
Original file line number Diff line number Diff line change
Expand Up @@ -250,26 +250,6 @@ AlgoliaSearchHelper.prototype.searchOnce = function(options, cb) {
});
};

/**
* @typedef Answer
* @type {object}
* @property {string} extract the extracted value with highlights
* @property {string} extractAttribute the attribute used to extract the answer
* @property {number} score the score indicating how well it was matched
*/

/**
* @typedef AnswerHit
* @type {object}
* @property {Answer} _answer the object describing why the hit was chosen
*/

/**
* @typedef AnswersResult
* @type {object}
* @property {AnswerHit[]} hits the answer hits
*/

/**
* Start the search for answers with the parameters set in the state.
* This method returns a promise.
Expand All @@ -278,7 +258,7 @@ AlgoliaSearchHelper.prototype.searchOnce = function(options, cb) {
* @param {string[]} options.queryLanguages - The languages in the query. Currently only supports ['en'].
* @param {number} options.nbHits - Maximum number of answers to retrieve from the Answers Engine. Cannot be greater than 1000.
*
* @return {promise.<AnswersResult>} the answer results
* @return {promise} the answer results
*/
AlgoliaSearchHelper.prototype.findAnswers = function(options) {
var state = this.state;
Expand All @@ -302,7 +282,7 @@ AlgoliaSearchHelper.prototype.findAnswers = function(options) {
}
);

var errorMessage = 'search for answers was called, but this client does not have a function client.initIndex(index).findAnswers'
var errorMessage = 'search for answers was called, but this client does not have a function client.initIndex(index).findAnswers';
if (typeof this.client.initIndex !== 'function') {
throw new Error(errorMessage);
}
Expand Down

0 comments on commit 5aa1206

Please sign in to comment.