algoliasearch 5.40.0 → 5.41.0
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 +9 -10
- package/dist/algoliasearch.umd.js +1 -1
- package/dist/browser.d.ts +1 -1
- package/dist/browser.js.map +1 -1
- package/dist/browser.min.js +1 -1
- package/dist/browser.min.js.map +1 -1
- package/dist/fetch.d.ts +1 -1
- package/dist/fetch.js.map +1 -1
- package/dist/lite/browser.d.ts +7 -7
- package/dist/lite/builds/browser.js +1 -1
- package/dist/lite/builds/browser.js.map +1 -1
- package/dist/lite/builds/browser.min.js +1 -1
- package/dist/lite/builds/browser.min.js.map +1 -1
- package/dist/lite/builds/browser.umd.js +1 -1
- package/dist/lite/builds/node.cjs +1 -1
- package/dist/lite/builds/node.cjs.map +1 -1
- package/dist/lite/builds/node.js +1 -1
- package/dist/lite/builds/node.js.map +1 -1
- package/dist/lite/node.d.cts +7 -7
- package/dist/lite/node.d.ts +7 -7
- package/dist/lite/src/liteClient.cjs +1 -1
- package/dist/lite/src/liteClient.cjs.map +1 -1
- package/dist/lite/src/liteClient.js +1 -1
- package/dist/lite/src/liteClient.js.map +1 -1
- package/dist/node.cjs.map +1 -1
- package/dist/node.d.cts +1 -1
- package/dist/node.d.ts +1 -1
- package/dist/node.js.map +1 -1
- package/dist/worker.d.ts +1 -1
- package/dist/worker.js.map +1 -1
- package/package.json +22 -22
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your JavaScript project</h4>
|
|
7
7
|
|
|
8
8
|
<p align="center">
|
|
9
|
-
<a href="https://npmjs.
|
|
9
|
+
<a href="https://npmjs.com/package/algoliasearch"><img src="https://img.shields.io/npm/v/algoliasearch.svg?style=flat-square" alt="NPM version"></img></a>
|
|
10
10
|
<a href="http://npm-stat.com/charts.html?package=algoliasearch"><img src="https://img.shields.io/npm/dm/algoliasearch.svg?style=flat-square" alt="NPM downloads"></a>
|
|
11
11
|
<a href="https://www.jsdelivr.com/package/npm/algoliasearch"><img src="https://data.jsdelivr.com/v1/package/npm/algoliasearch/badge" alt="jsDelivr Downloads"></img></a>
|
|
12
12
|
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
|
|
@@ -14,12 +14,11 @@
|
|
|
14
14
|
</p>
|
|
15
15
|
|
|
16
16
|
<p align="center">
|
|
17
|
-
<a href="https://www.algolia.com/doc/libraries/javascript
|
|
17
|
+
<a href="https://www.algolia.com/doc/libraries/sdk/install#javascript" target="_blank">Documentation</a> •
|
|
18
18
|
<a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
|
|
19
19
|
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
|
|
20
20
|
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
|
|
21
21
|
<a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a> •
|
|
22
|
-
<a href="https://www.algolia.com/doc/libraries/javascript/v5/" target="_blank">FAQ</a> •
|
|
23
22
|
<a href="https://alg.li/support" target="_blank">Support</a>
|
|
24
23
|
</p>
|
|
25
24
|
|
|
@@ -38,11 +37,11 @@ All of our clients comes with type definition, and are available for both browse
|
|
|
38
37
|
### With a package manager
|
|
39
38
|
|
|
40
39
|
```bash
|
|
41
|
-
yarn add algoliasearch@5.
|
|
40
|
+
yarn add algoliasearch@5.41.0
|
|
42
41
|
# or
|
|
43
|
-
npm install algoliasearch@5.
|
|
42
|
+
npm install algoliasearch@5.41.0
|
|
44
43
|
# or
|
|
45
|
-
pnpm add algoliasearch@5.
|
|
44
|
+
pnpm add algoliasearch@5.41.0
|
|
46
45
|
```
|
|
47
46
|
|
|
48
47
|
### Without a package manager
|
|
@@ -51,10 +50,10 @@ Add the following JavaScript snippet to the <head> of your website:
|
|
|
51
50
|
|
|
52
51
|
```html
|
|
53
52
|
// for the full client
|
|
54
|
-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.
|
|
53
|
+
<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.41.0/dist/algoliasearch.umd.js"></script>
|
|
55
54
|
|
|
56
55
|
// for the lite client
|
|
57
|
-
<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.
|
|
56
|
+
<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.41.0/dist/lite/builds/browser.umd.js"></script>
|
|
58
57
|
```
|
|
59
58
|
|
|
60
59
|
### Usage
|
|
@@ -72,11 +71,11 @@ import { liteClient } from 'algoliasearch/lite';
|
|
|
72
71
|
const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
|
|
73
72
|
```
|
|
74
73
|
|
|
75
|
-
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/
|
|
74
|
+
For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/sdk/methods/search/)**.
|
|
76
75
|
|
|
77
76
|
## ❓ Troubleshooting
|
|
78
77
|
|
|
79
|
-
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://
|
|
78
|
+
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://support.algolia.com/hc/en-us/sections/15061037630609-API-Client-FAQs) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
|
|
80
79
|
|
|
81
80
|
## 📄 License
|
|
82
81
|
|