@types/algoliasearch
Advanced tools
Comparing version 3.30.12 to 3.30.13
@@ -13,3 +13,11 @@ // Type definitions for algoliasearch-client-js 3.30.1 | ||
type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>> | ||
import { | ||
QueryParameters, | ||
ClientOptions, | ||
MultiResponse, | ||
SearchForFacetValues, | ||
Response, | ||
BrowseParameters, | ||
BrowseResponse | ||
} from '../index'; | ||
@@ -73,2 +81,3 @@ declare namespace algoliasearch { | ||
} | ||
/** | ||
@@ -168,477 +177,2 @@ * Interface for the index algolia object | ||
} | ||
/** | ||
* Interface describing available options when initializing a client | ||
*/ | ||
interface ClientOptions { | ||
/** | ||
* Timeout for requests to our servers, in milliseconds | ||
* default: 15s (node), 2s (browser) | ||
* https://github.com/algolia/algoliasearch-client-js#client-options | ||
*/ | ||
timeout?: number; | ||
/** | ||
* Protocol to use when communicating with algolia | ||
* default: current protocol(browser), https(node) | ||
* https://github.com/algolia/algoliasearch-client-js#client-options | ||
*/ | ||
protocol?: string; | ||
/** | ||
* (node only) httpAgent instance to use when communicating with servers. | ||
* https://github.com/algolia/algoliasearch-client-js#client-options | ||
*/ | ||
httpAgent?: any; | ||
/** | ||
* read: array of read hosts to use to call servers, computed automatically | ||
* write: array of read hosts to use to call servers, computed automatically | ||
* https://github.com/algolia/algoliasearch-client-js#client-options | ||
*/ | ||
hosts?: { read?: string[]; write?: string[] }; | ||
/** | ||
* enable the experimental feature: caching requests instead of responses | ||
* see https://github.com/algolia/algoliasearch-client-javascript/pull/694 | ||
*/ | ||
_useRequestCache?: boolean | ||
} | ||
interface BrowseResponse { | ||
cursor?: string; | ||
hits: {}[]; | ||
params: string; | ||
query: string; | ||
processingTimeMS: number; | ||
} | ||
type BrowseParameters = Omit< | ||
QueryParameters, | ||
| "typoTolerance" | ||
| "distinct" | ||
| "facets" | ||
| "getRankingInfo" | ||
| "attributesToHighlight" | ||
| "attributesToSnippet" | ||
> | ||
interface QueryParameters { | ||
/** | ||
* Query string used to perform the search | ||
* default: '' | ||
* https://www.algolia.com/doc/api-reference/api-parameters/query/ | ||
*/ | ||
query?: string; | ||
/** | ||
* Filter the query with numeric, facet or/and tag filters | ||
* default: "" | ||
* https://www.algolia.com/doc/api-reference/api-parameters/filters/ | ||
*/ | ||
filters?: string; | ||
/** | ||
* A string that contains the list of attributes you want to retrieve in order to minimize the size of the JSON answer. | ||
* default: * | ||
* https://www.algolia.com/doc/api-reference/api-parameters/attributesToRetrieve/ | ||
*/ | ||
attributesToRetrieve?: string[]; | ||
/** | ||
* List of attributes you want to use for textual search | ||
* default: attributeToIndex | ||
* https://www.algolia.com/doc/api-reference/api-parameters/restrictSearchableAttributes/ | ||
*/ | ||
restrictSearchableAttributes?: string[]; | ||
/** | ||
* You can use facets to retrieve only a part of your attributes declared in attributesForFaceting attributes | ||
* default: [] | ||
* https://www.algolia.com/doc/api-reference/api-parameters/facets/ | ||
*/ | ||
facets?: string[]; | ||
/** | ||
* Limit the number of facet values returned for each facet. | ||
* default: 100 | ||
* https://www.algolia.com/doc/api-reference/api-parameters/maxValuesPerFacet/ | ||
*/ | ||
maxValuesPerFacet?: number; | ||
/** | ||
* Default list of attributes to highlight. If set to null, all indexed attributes are highlighted. | ||
* default: null | ||
* https://www.algolia.com/doc/api-reference/api-parameters/attributesToHighlight/ | ||
*/ | ||
attributesToHighlight?: string[]; | ||
/** | ||
* Default list of attributes to snippet alongside the number of words to return | ||
* default: null | ||
* https://www.algolia.com/doc/api-reference/api-parameters/attributesToSnippet/ | ||
*/ | ||
attributesToSnippet?: string[]; | ||
/** | ||
* Specify the string that is inserted before the highlighted parts in the query result | ||
* default: <em> | ||
* https://www.algolia.com/doc/api-reference/api-parameters/highlightPreTag/ | ||
*/ | ||
highlightPreTag?: string; | ||
/** | ||
* Specify the string that is inserted after the highlighted parts in the query result | ||
* default: </em> | ||
* https://www.algolia.com/doc/api-reference/api-parameters/highlightPostTag/ | ||
*/ | ||
highlightPostTag?: string; | ||
/** | ||
* String used as an ellipsis indicator when a snippet is truncated. | ||
* default: … | ||
* https://www.algolia.com/doc/api-reference/api-parameters/snippetEllipsisText/ | ||
*/ | ||
snippetEllipsisText?: string; | ||
/** | ||
* If set to true, restrict arrays in highlights and snippets to items that matched the query at least partially else return all array items in highlights and snippets | ||
* default: false | ||
* https://www.algolia.com/doc/api-reference/api-parameters/restrictHighlightAndSnippetArrays/ | ||
*/ | ||
restrictHighlightAndSnippetArrays?: boolean; | ||
/** | ||
* Pagination parameter used to select the number of hits per page | ||
* default: 20 | ||
* https://www.algolia.com/doc/api-reference/api-parameters/hitsPerPage/ | ||
*/ | ||
hitsPerPage?: number; | ||
/** | ||
* Pagination parameter used to select the page to retrieve. | ||
* default: 0 | ||
* https://www.algolia.com/doc/api-reference/api-parameters/page/ | ||
*/ | ||
page?: number; | ||
/** | ||
* Offset of the first hit to return | ||
* default: null | ||
* https://www.algolia.com/doc/api-reference/api-parameters/offset/ | ||
*/ | ||
offset?: number; | ||
/** | ||
* Number of hits to return. | ||
* default: null | ||
* https://www.algolia.com/doc/api-reference/api-parameters/length/ | ||
*/ | ||
length?: number; | ||
/** | ||
* The minimum number of characters needed to accept one typo. | ||
* default: 4 | ||
* https://www.algolia.com/doc/api-reference/api-parameters/minWordSizefor1Typo/ | ||
*/ | ||
minWordSizefor1Typo?: number; | ||
/** | ||
* The minimum number of characters needed to accept two typo. | ||
* fault: 8 | ||
* https://www.algolia.com/doc/api-reference/api-parameters/minWordSizefor2Typos/ | ||
*/ | ||
minWordSizefor2Typos?: number; | ||
/** | ||
* This option allows you to control the number of typos allowed in the result set: | ||
* default: true | ||
* 'true' The typo tolerance is enabled and all matching hits are retrieved | ||
* 'false' The typo tolerance is disabled. All results with typos will be hidden. | ||
* 'min' Only keep results with the minimum number of typos | ||
* 'strict' Hits matching with 2 typos are not retrieved if there are some matching without typos. | ||
* https://www.algolia.com/doc/api-reference/api-parameters/typoTolerance/ | ||
*/ | ||
typoTolerance?: boolean; | ||
/** | ||
* If set to false, disables typo tolerance on numeric tokens (numbers). | ||
* default: | ||
* https://www.algolia.com/doc/api-reference/api-parameters/allowTyposOnNumericTokens/ | ||
*/ | ||
allowTyposOnNumericTokens?: boolean; | ||
/** | ||
* If set to true, plural won't be considered as a typo | ||
* default: false | ||
* https://www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/ | ||
*/ | ||
ignorePlurals?: boolean; | ||
/** | ||
* List of attributes on which you want to disable typo tolerance | ||
* default: [] | ||
* https://www.algolia.com/doc/api-reference/api-parameters/disableTypoToleranceOnAttributes/ | ||
*/ | ||
disableTypoToleranceOnAttributes?: string[]; | ||
/** | ||
* Search for entries around a given location | ||
* default: "" | ||
* https://www.algolia.com/doc/api-reference/api-parameters/aroundLatLng/ | ||
*/ | ||
aroundLatLng?: string; | ||
/** | ||
* Search for entries around a given latitude/longitude automatically computed from user IP address. | ||
* default: "" | ||
* https://www.algolia.com/doc/api-reference/api-parameters/aroundLatLngViaIP/ | ||
*/ | ||
aroundLatLngViaIP?: string; | ||
/** | ||
* Control the radius associated with a geo search. Defined in meters. | ||
* default: null | ||
* You can specify aroundRadius=all if you want to compute the geo distance without filtering in a geo area | ||
* https://www.algolia.com/doc/api-reference/api-parameters/aroundRadius/ | ||
*/ | ||
aroundRadius?: number | 'all'; | ||
/** | ||
* Control the precision of a geo search | ||
* default: null | ||
* https://www.algolia.com/doc/api-reference/api-parameters/aroundPrecision/ | ||
*/ | ||
aroundPrecision?: number; | ||
/** | ||
* Define the minimum radius used for a geo search when aroundRadius is not set. | ||
* default: null | ||
* https://www.algolia.com/doc/api-reference/api-parameters/minimumAroundRadius/ | ||
*/ | ||
minimumAroundRadius?: number; | ||
/** | ||
* Search entries inside a given area defined by the two extreme points of a rectangle | ||
* default: null | ||
* https://www.algolia.com/doc/api-reference/api-parameters/insideBoundingBox/ | ||
*/ | ||
insideBoundingBox?: number[][]; | ||
/** | ||
* Selects how the query words are interpreted | ||
* default: 'prefixLast' | ||
* 'prefixAll' All query words are interpreted as prefixes. This option is not recommended. | ||
* 'prefixLast' Only the last word is interpreted as a prefix (default behavior). | ||
* 'prefixNone' No query word is interpreted as a prefix. This option is not recommended. | ||
* https://www.algolia.com/doc/api-reference/api-parameters/queryType/ | ||
*/ | ||
queryType?: "prefixAll"|"prefixLast"|"prefixNone"; | ||
/** | ||
* Search entries inside a given area defined by a set of points | ||
* defauly: '' | ||
* https://www.algolia.com/doc/api-reference/api-parameters/insidePolygon/ | ||
*/ | ||
insidePolygon?: number[][]; | ||
/** | ||
* This option is used to select a strategy in order to avoid having an empty result page | ||
* default: 'none' | ||
* 'lastWords' When a query does not return any results, the last word will be added as optional | ||
* 'firstWords' When a query does not return any results, the first word will be added as optional | ||
* 'allOptional' When a query does not return any results, a second trial will be made with all words as optional | ||
* 'none' No specific processing is done when a query does not return any results | ||
* https://www.algolia.com/doc/api-reference/api-parameters/removeWordsIfNoResults/ | ||
*/ | ||
removeWordsIfNoResults?: "none"|"lastWords"|"firstWords"|"allOptional"; | ||
/** | ||
* Enables the advanced query syntax | ||
* default: false | ||
* https://www.algolia.com/doc/api-reference/api-parameters/advancedSyntax/ | ||
*/ | ||
advancedSyntax?: boolean; | ||
/** | ||
* A string that contains the comma separated list of words that should be considered as optional when found in the query | ||
* default: [] | ||
* https://www.algolia.com/doc/api-reference/api-parameters/optionalWords/ | ||
*/ | ||
optionalWords?: string[]; | ||
/** | ||
* Remove stop words from the query before executing it | ||
* default: false | ||
* true|false: enable or disable stop words for all 41 supported languages; or | ||
* a list of language ISO codes (as a comma-separated string) for which stop words should be enable | ||
* https://www.algolia.com/doc/api-reference/api-parameters/removeStopWords/ | ||
*/ | ||
removeStopWords?: boolean|string[]; | ||
/** | ||
* List of attributes on which you want to disable the computation of exact criteria | ||
* default: [] | ||
* https://www.algolia.com/doc/api-reference/api-parameters/disableExactOnAttributes/ | ||
*/ | ||
disableExactOnAttributes?: string[]; | ||
/** | ||
* This parameter control how the exact ranking criterion is computed when the query contains one word | ||
* default: attribute | ||
* 'none': no exact on single word query | ||
* 'word': exact set to 1 if the query word is found in the record | ||
* 'attribute': exact set to 1 if there is an attribute containing a string equals to the query | ||
* https://www.algolia.com/doc/api-reference/api-parameters/exactOnSingleWordQuery/ | ||
*/ | ||
exactOnSingleWordQuery?: "attribute"|"none"|"word"; | ||
/** | ||
* Specify the list of approximation that should be considered as an exact match in the ranking formula | ||
* default: ['ignorePlurals', 'singleWordSynonym'] | ||
* 'ignorePlurals': alternative words added by the ignorePlurals feature | ||
* 'singleWordSynonym': single-word synonym (For example "NY" = "NYC") | ||
* 'multiWordsSynonym': multiple-words synonym | ||
* https://www.algolia.com/doc/api-reference/api-parameters/alternativesAsExact/ | ||
*/ | ||
alternativesAsExact?: Array<"ignorePlurals"|"singleWordSynonym"|"multiWordsSynonym">; | ||
/** | ||
* If set to 1, enables the distinct feature, disabled by default, if the attributeForDistinct index setting is set. | ||
* https://www.algolia.com/doc/api-reference/api-parameters/distinct/ | ||
*/ | ||
distinct?: number|boolean; | ||
/** | ||
* If set to true, the result hits will contain ranking information in the _rankingInfo attribute. | ||
* default: false | ||
* https://www.algolia.com/doc/api-reference/api-parameters/getRankingInfo/ | ||
*/ | ||
getRankingInfo?: boolean; | ||
/** | ||
* @deprecated Use `numericAttributesForFiltering` instead | ||
* All numerical attributes are automatically indexed as numerical filters | ||
* default: '' | ||
* https://www.algolia.com/doc/api-reference/api-parameters/numericAttributesForFiltering/ | ||
*/ | ||
numericAttributesToIndex?: string[]; | ||
/** | ||
* All numerical attributes are automatically indexed as numerical filters | ||
* default: '' | ||
* https://www.algolia.com/doc/api-reference/api-parameters/numericAttributesForFiltering/ | ||
*/ | ||
numericAttributesForFiltering?: string[]; | ||
/** | ||
* @deprecated please use filters instead | ||
* A string that contains the comma separated list of numeric filters you want to apply. | ||
* https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/ | ||
*/ | ||
numericFilters?: string[]; | ||
/** | ||
* @deprecated | ||
* | ||
* Filter the query by a set of tags. | ||
* Default: [] | ||
* https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/ | ||
*/ | ||
tagFilters?: string[]; | ||
/** | ||
* Filter the query by a set of facets. | ||
* Default: [] | ||
* https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/ | ||
*/ | ||
facetFilters?: string[]|string[][]; | ||
/** | ||
* If set to false, this query will not be taken into account in the analytics feature. | ||
* default true | ||
* https://www.algolia.com/doc/api-reference/api-parameters/analytics/ | ||
*/ | ||
analytics?: boolean; | ||
/** | ||
* If set to true, enables the Click Analytics feature | ||
* default false | ||
* https://www.algolia.com/doc/api-reference/api-parameters/clickAnalytics/ | ||
*/ | ||
clickAnalytics?: boolean; | ||
/** | ||
* If set, tag your query with the specified identifiers | ||
* default: [] | ||
* https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/ | ||
*/ | ||
analyticsTags?: string[]; | ||
/** | ||
* If set to false, the search will not use the synonyms defined for the targeted index. | ||
* default: true | ||
* https://www.algolia.com/doc/api-reference/api-parameters/synonyms/ | ||
*/ | ||
synonyms?: boolean; | ||
/** | ||
* If set to false, words matched via synonym expansion will not be replaced by the matched synonym in the highlighted result. | ||
* default: true | ||
* https://www.algolia.com/doc/api-reference/api-parameters/replaceSynonymsInHighlight/ | ||
*/ | ||
replaceSynonymsInHighlight?: boolean; | ||
/** | ||
* Configure the precision of the proximity ranking criterion | ||
* default: 1 | ||
* https://www.algolia.com/doc/api-reference/api-parameters/minProximity/ | ||
*/ | ||
minProximity?: number; | ||
nbShards?: number; | ||
userData?: string | object; | ||
/** | ||
* Controls how facet values are sorted. | ||
* https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/ | ||
*/ | ||
sortFacetValuesBy?: 'count' | 'alpha'; | ||
/** | ||
* Sets the languages to be used by language-specific settings and functionalities | ||
* such as ignorePlurals, removeStopWords, and CJK word-detection. | ||
* https://www.algolia.com/doc/api-reference/api-parameters/queryLanguages/ | ||
*/ | ||
queryLanguages?: Array<'af' | 'ar' | 'az' | 'bg' | 'bn' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'fi' | 'fo' | 'fr' | 'ga' | 'gl' | 'he' | 'hi' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kk' | 'ko' | 'ku' | 'ky' | 'lt' | 'lv' | 'mi' | 'mn' | 'mr' | 'ms' | 'mt' | 'nb' | 'nl' | 'no' | 'ns' | 'pl' | 'ps' | 'pt' | 'pt-br' | 'qu' | 'ro' | 'ru' | 'sk' | 'sq' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tl' | 'tn' | 'tr' | 'tt' | 'uk' | 'ur' | 'uz' | 'zh'>; | ||
} | ||
namespace SearchForFacetValues { | ||
interface Parameters extends QueryParameters { | ||
/** | ||
* The facet to search in | ||
*/ | ||
facetName: string; | ||
/** | ||
* The query for the search in this facet | ||
*/ | ||
facetQuery: string; | ||
} | ||
interface Response { | ||
facetHits: { value: string; highlighted: string; count: number }[]; | ||
exhaustiveFacetsCount: boolean; | ||
processingTimeMS: number; | ||
} | ||
} | ||
interface Response<T=any> { | ||
/** | ||
* Contains all the hits matching the query | ||
* https://www.algolia.com/doc/api-reference/api-methods/search/?language=javascript#response | ||
*/ | ||
hits: T[]; | ||
/** | ||
* Current page | ||
* https://www.algolia.com/doc/api-reference/api-methods/search/?language=javascript#response | ||
*/ | ||
page: number; | ||
/** | ||
* Number of total hits matching the query | ||
* https://www.algolia.com/doc/api-reference/api-methods/search/?language=javascript#response | ||
*/ | ||
nbHits: number; | ||
/** | ||
* Number of pages | ||
* https://www.algolia.com/doc/api-reference/api-methods/search/?language=javascript#response | ||
*/ | ||
nbPages: number; | ||
/** | ||
* Number of hits per pages | ||
* https://www.algolia.com/doc/api-reference/api-methods/search/?language=javascript#response | ||
*/ | ||
hitsPerPage: number; | ||
/** | ||
* Engine processing time (excluding network transfer) | ||
* https://www.algolia.com/doc/api-reference/api-methods/search/?language=javascript#response | ||
*/ | ||
processingTimeMS: number; | ||
/** | ||
* Query used to perform the search | ||
* https://www.algolia.com/doc/api-reference/api-methods/search/?language=javascript#response | ||
*/ | ||
query: string; | ||
/** | ||
* GET parameters used to perform the search | ||
* https://www.algolia.com/doc/api-reference/api-methods/search/?language=javascript#response | ||
*/ | ||
params: string; | ||
facets?: { | ||
[facetName: string]: { [facetValue: string]: number }; | ||
}; | ||
facets_stats?: { | ||
[facetName: string]: { | ||
avg: number, | ||
max: number, | ||
min: number, | ||
sum: number, | ||
}; | ||
}; | ||
/** | ||
* The index name is only set when searching multiple indices. | ||
* https://www.algolia.com/doc/api-reference/api-methods/multiple-queries/?language=javascript#response | ||
*/ | ||
index?: string; | ||
/** | ||
* The cursor is only set when browsing the index. | ||
* https://www.algolia.com/doc/api-reference/api-methods/browse/ | ||
*/ | ||
cursor?: string; | ||
} | ||
interface MultiResponse<T=any> { | ||
results: Response<T>[]; | ||
} | ||
} | ||
@@ -649,4 +183,4 @@ | ||
apiKey: string, | ||
options?: algoliasearch.ClientOptions | ||
options?: ClientOptions | ||
): algoliasearch.Client; | ||
export = algoliasearch; |
{ | ||
"name": "@types/algoliasearch", | ||
"version": "3.30.12", | ||
"version": "3.30.13", | ||
"description": "TypeScript definitions for algoliasearch-client-js", | ||
@@ -57,4 +57,4 @@ "license": "MIT", | ||
"dependencies": {}, | ||
"typesPublisherContentHash": "0e4cc2942bf9a81faea580031bf30c20a96f2712693c55ebe5b3e5d784957dfb", | ||
"typesPublisherContentHash": "8be2b6b2c4b57aa3d8092280f1c2055cec78a3afecde2c130d737b484e1b71d5", | ||
"typeScriptVersion": "2.8" | ||
} |
@@ -5,3 +5,3 @@ # Installation | ||
# Summary | ||
This package contains type definitions for algoliasearch-client-js ( https://github.com/algolia/algoliasearch-client-js ). | ||
This package contains type definitions for algoliasearch-client-js (https://github.com/algolia/algoliasearch-client-js). | ||
@@ -12,3 +12,3 @@ # Details | ||
Additional Details | ||
* Last updated: Tue, 21 May 2019 20:01:27 GMT | ||
* Last updated: Thu, 11 Jul 2019 22:55:19 GMT | ||
* Dependencies: none | ||
@@ -18,2 +18,2 @@ * Global values: none | ||
# Credits | ||
These definitions were written by Baptiste Coquelle <https://github.com/cbaptiste>, Haroen Viaene <https://github.com/haroenv>, Samuel Vaillant <https://github.com/samouss>, Kai Eichinger <https://github.com/keichinger>, Nery Ortez <https://github.com/neryortez>, Antoine Rousseau <https://github.com/antoinerousseau>, Luca Pasquale <https://github.com/lucapasquale>, Alexandre Deve <https://github.com/adeve>. | ||
These definitions were written by Baptiste Coquelle <https://github.com/cbaptiste>, Haroen Viaene <https://github.com/haroenv>, Samuel Vaillant <https://github.com/samouss>, Kai Eichinger <https://github.com/keichinger>, Nery Ortez <https://github.com/neryortez>, Antoine Rousseau <https://github.com/antoinerousseau>, Luca Pasquale <https://github.com/lucapasquale>, and Alexandre Deve <https://github.com/adeve>. |
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
71826
2133