@algolia/client-search 5.20.0 → 5.20.2
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 +1 -1
- 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 +1 -1
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +1 -1
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +1 -1
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +1 -1
- 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 +1 -1
- package/dist/src/searchClient.cjs.map +1 -1
- package/dist/src/searchClient.js +1 -1
- package/dist/src/searchClient.js.map +1 -1
- package/dist/worker.d.ts +3 -3
- package/package.json +9 -9
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.20.
|
|
44
|
+
yarn add @algolia/client-search@5.20.2
|
|
45
45
|
# or
|
|
46
|
-
npm install @algolia/client-search@5.20.
|
|
46
|
+
npm install @algolia/client-search@5.20.2
|
|
47
47
|
# or
|
|
48
|
-
pnpm add @algolia/client-search@5.20.
|
|
48
|
+
pnpm add @algolia/client-search@5.20.2
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
### Without a package manager
|
|
@@ -53,7 +53,7 @@ pnpm add @algolia/client-search@5.20.0
|
|
|
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.20.
|
|
56
|
+
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.20.2/dist/builds/browser.umd.js"></script>
|
|
57
57
|
```
|
|
58
58
|
|
|
59
59
|
### Usage
|
package/dist/browser.d.ts
CHANGED
|
@@ -1352,7 +1352,7 @@ type IndexSettingsAsSearchParams = {
|
|
|
1352
1352
|
*/
|
|
1353
1353
|
minProximity?: number;
|
|
1354
1354
|
/**
|
|
1355
|
-
* Properties to include in the API response of
|
|
1355
|
+
* Properties to include in the API response of search and browse requests. By default, all response properties are included. To reduce the response size, you can select which properties should be included. An empty list may lead to an empty API response (except properties you can\'t exclude). You can\'t exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search depends on the `hits` field. If you omit this field, searches won\'t return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.
|
|
1356
1356
|
*/
|
|
1357
1357
|
responseFields?: Array<string>;
|
|
1358
1358
|
/**
|
|
@@ -1493,7 +1493,7 @@ type Consequence = {
|
|
|
1493
1493
|
/**
|
|
1494
1494
|
* A JSON object with custom data that will be appended to the `userData` array in the response. This object isn\'t interpreted by the API and is limited to 1 kB of minified JSON.
|
|
1495
1495
|
*/
|
|
1496
|
-
userData?:
|
|
1496
|
+
userData?: Record<string, unknown>;
|
|
1497
1497
|
};
|
|
1498
1498
|
|
|
1499
1499
|
type TimeRange = {
|
|
@@ -3025,7 +3025,7 @@ type ReplaceAllObjectsOptions = {
|
|
|
3025
3025
|
scopes?: Array<ScopeType>;
|
|
3026
3026
|
};
|
|
3027
3027
|
|
|
3028
|
-
declare const apiClientVersion = "5.20.
|
|
3028
|
+
declare const apiClientVersion = "5.20.2";
|
|
3029
3029
|
declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
3030
3030
|
transporter: _algolia_client_common.Transporter;
|
|
3031
3031
|
/**
|