@algolia/client-search 5.5.3 → 5.6.1
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 +15 -6
- package/dist/browser.d.ts +1 -1
- package/dist/builds/browser.js +3 -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 +3 -3
- package/dist/builds/fetch.js +3 -1
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +2 -1
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +3 -1
- package/dist/builds/node.js.map +1 -1
- package/dist/fetch.d.ts +1 -1
- package/dist/node.d.cts +1 -1
- package/dist/node.d.ts +1 -1
- 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/package.json +7 -7
package/README.md
CHANGED
|
@@ -32,24 +32,33 @@
|
|
|
32
32
|
|
|
33
33
|
## 💡 Getting Started
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
> [!TIP]
|
|
36
|
+
> This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/client-search` if you already have `algoliasearch` installed.
|
|
36
37
|
|
|
38
|
+
To get started, you first need to install @algolia/client-search (or any other available API client package).
|
|
37
39
|
All of our clients comes with type definition, and are available for both browser and node environments.
|
|
38
40
|
|
|
41
|
+
### With a package manager
|
|
42
|
+
|
|
43
|
+
|
|
39
44
|
```bash
|
|
40
|
-
yarn add @algolia/client-search
|
|
45
|
+
yarn add @algolia/client-search@5.6.1
|
|
46
|
+
# or
|
|
47
|
+
npm install @algolia/client-search@5.6.1
|
|
41
48
|
# or
|
|
42
|
-
|
|
49
|
+
pnpm add @algolia/client-search@5.6.1
|
|
43
50
|
```
|
|
44
51
|
|
|
45
|
-
Without a package manager
|
|
52
|
+
### Without a package manager
|
|
46
53
|
|
|
47
54
|
Add the following JavaScript snippet to the <head> of your website:
|
|
48
55
|
|
|
49
56
|
```html
|
|
50
|
-
<script src="https://cdn.jsdelivr.net/npm/
|
|
57
|
+
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.6.1/dist/builds/browser.umd.js"></script>
|
|
51
58
|
```
|
|
52
59
|
|
|
60
|
+
### Usage
|
|
61
|
+
|
|
53
62
|
You can now import the Algolia API client in your project and play with it.
|
|
54
63
|
|
|
55
64
|
```js
|
|
@@ -58,7 +67,7 @@ import { searchClient } from '@algolia/client-search';
|
|
|
58
67
|
const client = searchClient('YOUR_APP_ID', 'YOUR_API_KEY');
|
|
59
68
|
```
|
|
60
69
|
|
|
61
|
-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
|
|
70
|
+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/)**.
|
|
62
71
|
|
|
63
72
|
## ❓ Troubleshooting
|
|
64
73
|
|
package/dist/browser.d.ts
CHANGED
|
@@ -2956,7 +2956,7 @@ type UpdatedRuleResponse = {
|
|
|
2956
2956
|
taskID: number;
|
|
2957
2957
|
};
|
|
2958
2958
|
|
|
2959
|
-
declare const apiClientVersion = "5.
|
|
2959
|
+
declare const apiClientVersion = "5.6.1";
|
|
2960
2960
|
declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
2961
2961
|
transporter: _algolia_client_common.Transporter;
|
|
2962
2962
|
/**
|
package/dist/builds/browser.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// builds/browser.ts
|
|
2
2
|
import {
|
|
3
|
+
createNullLogger,
|
|
3
4
|
createMemoryCache,
|
|
4
5
|
createFallbackableCache,
|
|
5
6
|
createBrowserLocalStorageCache,
|
|
@@ -18,7 +19,7 @@ import {
|
|
|
18
19
|
ApiError,
|
|
19
20
|
createIterablePromise
|
|
20
21
|
} from "@algolia/client-common";
|
|
21
|
-
var apiClientVersion = "5.
|
|
22
|
+
var apiClientVersion = "5.6.1";
|
|
22
23
|
function getDefaultHosts(appId) {
|
|
23
24
|
return [
|
|
24
25
|
{
|
|
@@ -2366,6 +2367,7 @@ function searchClient(appId, apiKey, options) {
|
|
|
2366
2367
|
read: DEFAULT_READ_TIMEOUT_BROWSER,
|
|
2367
2368
|
write: DEFAULT_WRITE_TIMEOUT_BROWSER
|
|
2368
2369
|
},
|
|
2370
|
+
logger: createNullLogger(),
|
|
2369
2371
|
requester: createXhrRequester(),
|
|
2370
2372
|
algoliaAgents: [{ segment: "Browser" }],
|
|
2371
2373
|
authMode: "WithinQueryParameters",
|