Gathering detailed insights and metrics for @algolia/client-search
Gathering detailed insights and metrics for @algolia/client-search
⚡️ A fully-featured and blazing-fast JavaScript API client to interact with Algolia.
Installations
npm install @algolia/client-searchDeveloper
Developer Guide
BETA
Module System
ESM
Min. Node Version
>= 14.0.0
Typescript Support
Yes
Node Version
22.11.0
NPM Version
10.9.0
Statistics
1,330 Stars
1,144 Commits
222 Forks
97 Watching
16 Branches
273 Contributors
Updated on 26 Nov 2024
Bundle Size
39.87 kB
Minified
8.39 kB
Minified + Gzipped
Languages
TypeScript (99.61%)
JavaScript (0.39%)
Total Downloads
Cumulative downloads
Total Downloads
188,735,212
Last day
4.3%
458,803
Compared to previous day
Last week
5%
2,353,967
Compared to previous week
Last month
2%
9,759,298
Compared to previous month
Last year
63.2%
83,039,668
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
The perfect starting point to integrate Algolia within your JavaScript project
Documentation • InstantSearch • Community Forum • Stack Overflow • Report a bug • FAQ • Support
✨ Features
- Thin & minimal low-level HTTP client to interact with Algolia's API
- Works both on the browser and node.js
- UMD and ESM compatible, you can use it with any module loader
- Built with TypeScript
💡 Getting Started
To get started, you first need to install algoliasearch (or any other available API client package). All of our clients comes with type definition, and are available for both browser and node environments.
With a package manager
1yarn add algoliasearch@5.15.0 2# or 3npm install algoliasearch@5.15.0 4# or 5pnpm add algoliasearch@5.15.0
Without a package manager
Add the following JavaScript snippet to the of your website:
1// for the full client 2<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.15.0/dist/algoliasearch.umd.js"></script> 3 4// for the lite client 5<script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.15.0/dist/lite/builds/browser.umd.js"></script>
Usage
You can now import the Algolia API client in your project and play with it.
1import { algoliasearch } from 'algoliasearch'; 2 3const client = algoliasearch('YOUR_APP_ID', 'YOUR_API_KEY'); 4 5// or with the lite client 6import { liteClient } from 'algoliasearch/lite'; 7 8const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
For full documentation, visit the Algolia JavaScript API Client.
❓ Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client. You can also open a GitHub issue
📄 License
The Algolia JavaScript API Client is an open-sourced software licensed under the MIT license.
No vulnerabilities found.
Reason
30 commit(s) and 22 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/do-not-edit-this-repository.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/issue.yml:8
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: no jobLevel write permissions found
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/do-not-edit-this-repository.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/algolia/algoliasearch-client-javascript/do-not-edit-this-repository.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issue.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/algolia/algoliasearch-client-javascript/issue.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/algolia/algoliasearch-client-javascript/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/algolia/algoliasearch-client-javascript/release.yml/main?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Score
4.8
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More