@algolia/client-search 5.23.3 → 5.23.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/browser.d.ts +3 -3
- package/dist/builds/browser.js +2 -2
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +1 -1
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +1 -1
- package/dist/builds/fetch.js +2 -2
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +2 -2
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +2 -2
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +2 -2
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +3 -3
- package/dist/node.d.cts +3 -3
- package/dist/node.d.ts +3 -3
- package/dist/src/searchClient.cjs +2 -2
- package/dist/src/searchClient.cjs.map +1 -1
- package/dist/src/searchClient.js +2 -2
- package/dist/src/searchClient.js.map +1 -1
- package/dist/worker.d.ts +3 -3
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -41,11 +41,11 @@ All of our clients comes with type definition, and are available for both browse
|
|
|
41
41
|
### With a package manager
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
|
-
yarn add @algolia/client-search@5.23.
|
|
44
|
+
yarn add @algolia/client-search@5.23.4
|
|
45
45
|
# or
|
|
46
|
-
npm install @algolia/client-search@5.23.
|
|
46
|
+
npm install @algolia/client-search@5.23.4
|
|
47
47
|
# or
|
|
48
|
-
pnpm add @algolia/client-search@5.23.
|
|
48
|
+
pnpm add @algolia/client-search@5.23.4
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
### Without a package manager
|
|
@@ -53,7 +53,7 @@ pnpm add @algolia/client-search@5.23.3
|
|
|
53
53
|
Add the following JavaScript snippet to the <head> of your website:
|
|
54
54
|
|
|
55
55
|
```html
|
|
56
|
-
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.23.
|
|
56
|
+
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.23.4/dist/builds/browser.umd.js"></script>
|
|
57
57
|
```
|
|
58
58
|
|
|
59
59
|
### Usage
|
package/dist/browser.d.ts
CHANGED
|
@@ -999,7 +999,7 @@ type Condition = {
|
|
|
999
999
|
*/
|
|
1000
1000
|
context?: string;
|
|
1001
1001
|
/**
|
|
1002
|
-
* Filters that trigger the rule. You can add
|
|
1002
|
+
* Filters that trigger the rule. You can add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter. You can\'t combine multiple filters with `OR` and you can\'t use numeric filters.
|
|
1003
1003
|
*/
|
|
1004
1004
|
filters?: string;
|
|
1005
1005
|
};
|
|
@@ -3028,7 +3028,7 @@ type ReplaceAllObjectsOptions = {
|
|
|
3028
3028
|
scopes?: Array<ScopeType>;
|
|
3029
3029
|
};
|
|
3030
3030
|
|
|
3031
|
-
declare const apiClientVersion = "5.23.
|
|
3031
|
+
declare const apiClientVersion = "5.23.4";
|
|
3032
3032
|
declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
3033
3033
|
transporter: _algolia_client_common.Transporter;
|
|
3034
3034
|
/**
|
|
@@ -3771,7 +3771,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
3771
3771
|
*/
|
|
3772
3772
|
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: SaveSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
|
|
3773
3773
|
/**
|
|
3774
|
-
* Sends multiple search requests to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
|
|
3774
|
+
* Sends multiple search requests to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters. Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
|
|
3775
3775
|
*
|
|
3776
3776
|
* Required API Key ACLs:
|
|
3777
3777
|
* - search
|
package/dist/builds/browser.js
CHANGED
|
@@ -16,7 +16,7 @@ import {
|
|
|
16
16
|
getAlgoliaAgent,
|
|
17
17
|
shuffle
|
|
18
18
|
} from "@algolia/client-common";
|
|
19
|
-
var apiClientVersion = "5.23.
|
|
19
|
+
var apiClientVersion = "5.23.4";
|
|
20
20
|
function getDefaultHosts(appId) {
|
|
21
21
|
return [
|
|
22
22
|
{
|
|
@@ -1998,7 +1998,7 @@ function createSearchClient({
|
|
|
1998
1998
|
return transporter.request(request, requestOptions);
|
|
1999
1999
|
},
|
|
2000
2000
|
/**
|
|
2001
|
-
* Sends multiple search requests to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
|
|
2001
|
+
* Sends multiple search requests to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters. Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
|
|
2002
2002
|
*
|
|
2003
2003
|
* Required API Key ACLs:
|
|
2004
2004
|
* - search
|