algoliasearch
- Version 5.23.4
- Published
- 1.39 MB
- 13 dependencies
- MIT license
Install
npm i algoliasearch
yarn add algoliasearch
pnpm add algoliasearch
Overview
A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.
Index
Functions
Type Aliases
Functions
function algoliasearch
algoliasearch: ( appId: string, apiKey: string, options?: ClientOptions) => Algoliasearch;
Type Aliases
type Algoliasearch
type Algoliasearch = SearchClient & { initAbtesting: ( initOptions: InitClientOptions & RegionOptions$1 ) => AbtestingClient; initAnalytics: ( initOptions: InitClientOptions & RegionOptions$2 ) => AnalyticsClient; initIngestion: ( initOptions: InitClientOptions & RegionOptions$3 ) => IngestionClient; initInsights: ( initOptions: InitClientOptions & RegionOptions$4 ) => InsightsClient; initMonitoring: (initOptions?: InitClientOptions) => MonitoringClient; initPersonalization: ( initOptions: InitClientOptions & RegionOptions$5 ) => PersonalizationClient; initQuerySuggestions: ( initOptions: InitClientOptions & RegionOptions$6 ) => QuerySuggestionsClient; initRecommend: (initOptions?: InitClientOptions) => RecommendClient;};
type InitClientOptions
type InitClientOptions = Partial<{ /** * App to target with the initialized client, defaults to the `algoliasearch` appId. */ appId: string; /** * API key of the targeted app ID, defaults to the `algoliasearch` apiKey. */ apiKey: string; options: ClientOptions;}>;
Options forwarded to the client initialized via the
init
method.
type Region
type Region = Region$1 | Region$2 | Region$3 | Region$4 | Region$5 | Region$6;
type RegionOptions
type RegionOptions = | RegionOptions$1 | RegionOptions$2 | RegionOptions$3 | RegionOptions$4 | RegionOptions$5 | RegionOptions$6;
Package Files (2)
Dependencies (13)
- @algolia/client-abtesting
- @algolia/client-analytics
- @algolia/client-common
- @algolia/client-insights
- @algolia/client-personalization
- @algolia/client-query-suggestions
- @algolia/client-search
- @algolia/ingestion
- @algolia/monitoring
- @algolia/recommend
- @algolia/requester-browser-xhr
- @algolia/requester-fetch
- @algolia/requester-node-http
Dev Dependencies (11)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/algoliasearch
.
- Markdown[](https://www.jsdocs.io/package/algoliasearch)
- HTML<a href="https://www.jsdocs.io/package/algoliasearch"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3916 ms. - Missing or incorrect documentation? Open an issue for this package.