Functions — github.com/algolia/algoliasearch-client-javascript

hub / github.com/algolia/algoliasearch-client-javascript / functions

Functions600 in github.com/algolia/algoliasearch-client-javascript

⨍ Functions 600◇ Types & classes 20

↓ 1 callersFunctionisRetryable

({ isTimedOut, status }: Omit<Response, 'content'>)

packages/client-common/src/transporter/responses.ts:7

↓ 1 callersFunctionisSuccess

({ status }: Pick<Response, 'status'>)

packages/client-common/src/transporter/responses.ts:11

↓ 1 callersFunctioniterLines

* Yields individual lines from a byte stream. * * Handles \r, \n, and \r\n line endings, including \r\n split across chunks. * Uses offset tracking

packages/client-common/src/sse.ts:83

↓ 1 callersFunctionmakeTransporter

(opts: { compress?: (data: string) => Promise<Uint8Array>; compression?: 'gzip'; logger?: Logger; onRe

packages/client-common/src/__tests__/transporter/compression.test.ts:20

↓ 1 callersFunctionpublish

()

scripts/publish.ts:3

↓ 1 callersFunctionpushToStackTrace

(response: Response)

packages/client-common/src/transporter/createTransporter.ts:171

↓ 1 callersFunctionreadableStreamToAsyncIterable

* Converts a ReadableStream into an AsyncIterable via getReader(). * Fallback for environments where ReadableStream lacks Symbol.asyncIterator.

packages/client-common/src/sse.ts:49

↓ 1 callersFunctionretry

(previousResponse?: TResponse | undefined)

packages/client-common/src/createIterablePromise.ts:20

↓ 1 callersFunctionretry

( retryableHosts: Host[], getTimeout: (timeoutsCount: number, timeout: number) => number, )

packages/client-common/src/transporter/createTransporter.ts:143

↓ 1 callersFunctionretryableRequest

( request: Request, requestOptions: RequestOptions, isRead: boolean, )

packages/client-common/src/transporter/createTransporter.ts:77

↓ 1 callersFunctionsetNamespace

(namespace: Record<string, any>)

packages/client-common/src/cache/createBrowserLocalStorageCache.ts:20

↓ 1 callersFunctionstackTraceWithoutCredentials

(stackTrace: StackFrame[])

packages/client-common/src/transporter/stackTrace.ts:3

↓ 1 callersFunctiontoAsyncIterable

* Normalizes the input to an AsyncIterable<Uint8Array>. * Prefers Symbol.asyncIterator if available; falls back to getReader().

packages/client-common/src/sse.ts:66

↓ 1 callersFunctiontoStream

Encode each string argument as a separate Uint8Array chunk in an AsyncIterable.

packages/client-common/src/__tests__/sse.test.ts:8

↓ 1 callersFunctionwaitForBatch

(start: number, end: number)

packages/ingestion/src/ingestionClient.ts:277

Function[Symbol.asyncIterator]

()

packages/client-common/src/__tests__/sse.test.ts:11

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/client-personalization/src/personalizationClient.ts:90

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/abtesting/src/abtestingV3Client.ts:96

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/client-search/src/searchClient.ts:221

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/composition/src/compositionClient.ts:140

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/client-abtesting/src/abtestingClient.ts:94

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/ingestion/src/ingestionClient.ts:213

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/advanced-personalization/src/advancedPersonalizationClient.ts:97

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/client-query-suggestions/src/querySuggestionsClient.ts:94

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/client-analytics/src/analyticsClient.ts:124

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/agent-studio/src/agentStudioClient.ts:158

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/recommend/src/recommendClient.ts:121

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/client-insights/src/insightsClient.ts:87

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/monitoring/src/monitoringClient.ts:89

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/algoliasearch/lite/src/liteClient.ts:114

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/algoliasearch/builds/browser.ts:302

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/algoliasearch/builds/node.ts:302

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/algoliasearch/builds/worker.ts:302

Function_ua

* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.

packages/algoliasearch/builds/fetch.ts:302

FunctionabtestingClient

( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )

packages/client-abtesting/builds/browser.ts:24

FunctionabtestingClient

( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )

packages/client-abtesting/builds/worker.ts:21

FunctionabtestingClient

( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )

packages/client-abtesting/builds/fetch.ts:23

FunctionabtestingV3Client

( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )

packages/abtesting/builds/browser.ts:24

FunctionabtestingV3Client

( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )

packages/abtesting/builds/worker.ts:21

FunctionabtestingV3Client

( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )

packages/abtesting/builds/fetch.ts:23

FunctionaccountCopyIndex

* Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`. *

packages/client-search/builds/node.ts:116

FunctionaccountCopyIndex

* Helper: Copies the given `sourceIndexName` records, rules and synonyms to an other Algolia application for the given `destinationIndexName`. *

packages/client-search/builds/fetch.ts:117

Functionadd

(options: AlgoliaAgentOptions)

packages/client-common/src/createAlgoliaAgent.ts:6

FunctionaddABTests

* Creates a new A/B test. * * Required API Key ACLs: * - editSettings * @param addABTestsRequest - The addABTestsRequest object.

packages/abtesting/src/abtestingV3Client.ts:132

FunctionaddABTests

* Creates a new A/B test. * * Required API Key ACLs: * - editSettings * @param addABTestsRequest - The addABTestsRequest object.

packages/client-abtesting/src/abtestingClient.ts:130

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/client-personalization/src/personalizationClient.ts:100

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/abtesting/src/abtestingV3Client.ts:106

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/client-search/src/searchClient.ts:231

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/composition/src/compositionClient.ts:150

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/client-abtesting/src/abtestingClient.ts:104

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/ingestion/src/ingestionClient.ts:223

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/advanced-personalization/src/advancedPersonalizationClient.ts:107

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/client-query-suggestions/src/querySuggestionsClient.ts:104

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/client-analytics/src/analyticsClient.ts:134

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/agent-studio/src/agentStudioClient.ts:168

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/recommend/src/recommendClient.ts:131

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/client-insights/src/insightsClient.ts:97

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/monitoring/src/monitoringClient.ts:99

FunctionaddAlgoliaAgent

* Adds a `segment` to the `x-algolia-agent` sent with every requests. * * @param segment - The algolia agent (user-agent) segment to add.

packages/algoliasearch/lite/src/liteClient.ts:124

FunctionaddApiKey

* Creates a new API key with specific permissions and restrictions. * * Required API Key ACLs: * - admin * @param apiKey - The ap

packages/client-search/src/searchClient.ts:776

FunctionaddOrUpdateObject

* If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. If you want to use

packages/client-search/src/searchClient.ts:807

FunctionadvancedPersonalizationClient

( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )

packages/advanced-personalization/builds/browser.ts:24

FunctionadvancedPersonalizationClient

( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )

packages/advanced-personalization/builds/node.ts:23

FunctionadvancedPersonalizationClient

( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )

packages/advanced-personalization/builds/worker.ts:21

FunctionadvancedPersonalizationClient

( appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined, )

packages/advanced-personalization/builds/fetch.ts:23

FunctionagentStudioClient

( appId: string, apiKey: string, options?: ClientOptions | undefined, )

packages/agent-studio/builds/browser.ts:19

FunctionagentStudioClient

( appId: string, apiKey: string, options?: ClientOptions | undefined, )

packages/agent-studio/builds/worker.ts:16

FunctionagentStudioClient

( appId: string, apiKey: string, options?: ClientOptions | undefined, )

packages/agent-studio/builds/fetch.ts:22

Functionaggregator

(response: SearchRulesResponse)

packages/client-search/builds/fetch.ts:171

FunctionanalyticsClient

( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )

packages/client-analytics/builds/browser.ts:24

FunctionanalyticsClient

( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )

packages/client-analytics/builds/worker.ts:21

FunctionanalyticsClient

( appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined, )

packages/client-analytics/builds/fetch.ts:23

FunctionappendSource

* Adds a source to the list of allowed sources. * * Required API Key ACLs: * - admin * @param source - Source to add. * @par

packages/client-search/src/searchClient.ts:842

FunctionassignUserId

* Assigns or moves a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID. *

packages/client-search/src/searchClient.ts:874

Functionbatch

* Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - A

packages/client-search/src/searchClient.ts:913

FunctionbatchAssignUserIds

* Assigns multiple user IDs to a cluster. **You can\'t move users with this operation**. * * Required API Key ACLs: * - admin *

packages/client-search/src/searchClient.ts:947

FunctionbatchDictionaryEntries

* Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries. * * Required API Key ACLs: * - editSett

packages/client-search/src/searchClient.ts:987

FunctionbatchRecommendRules

* Create or update a batch of Recommend Rules Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectI

packages/recommend/src/recommendClient.ts:160

Functionbrowse

* Retrieves records from an index, up to 1,000 per request. Searching returns _hits_ (records augmented with highlighting and ranking details). Brows

packages/client-search/src/searchClient.ts:1029

FunctionbrowseObjects

* Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index. * * @summary Helper method that iterates on

packages/client-search/src/searchClient.ts:400

FunctionbrowseRules

* Helper: Iterate on the `searchRules` method of the client to allow aggregating rules of an index. * * @summary Helper method that iterates

packages/client-search/src/searchClient.ts:434

FunctionbrowseSynonyms

* Helper: Iterate on the `searchSynonyms` method of the client to allow aggregating rules of an index. * * @summary Helper method that itera

packages/client-search/src/searchClient.ts:472

FunctionbulkCreateAllowedDomains

* Add multiple allowed domain patterns. Duplicates are skipped. * * Required API Key ACLs: * - editSettings * @param bulkCreateAl

packages/agent-studio/src/agentStudioClient.ts:196

FunctionbulkDeleteAllowedDomains

* Delete allowed domains by id list. * * Required API Key ACLs: * - editSettings * @param bulkDeleteAllowedDomains - The bulkDele

packages/agent-studio/src/agentStudioClient.ts:234

FunctionchunkedBatch

* Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests. * * @summary Helper: C

packages/client-search/src/searchClient.ts:519

FunctionchunkedPush

* Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `push` requests by leveraging the Transformation p

packages/ingestion/src/ingestionClient.ts:255

Functionclear

()

packages/client-common/src/cache/createBrowserLocalStorageCache.ts:109

Functionclear

()

packages/client-common/src/cache/createNullCache.ts:25

Functionclear

()

packages/client-common/src/cache/createMemoryCache.ts:37

Functionclear

()

packages/client-common/src/cache/createFallbackableCache.ts:37

FunctionclearCache

* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.

packages/client-personalization/src/personalizationClient.ts:83

FunctionclearCache

* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.

packages/abtesting/src/abtestingV3Client.ts:89

FunctionclearCache

* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.

packages/client-search/src/searchClient.ts:214

FunctionclearCache

* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.

packages/composition/src/compositionClient.ts:133

FunctionclearCache

* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.

packages/client-abtesting/src/abtestingClient.ts:87

FunctionclearCache

* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.

packages/ingestion/src/ingestionClient.ts:206

FunctionclearCache

* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.

packages/advanced-personalization/src/advancedPersonalizationClient.ts:90

FunctionclearCache

* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.

packages/client-query-suggestions/src/querySuggestionsClient.ts:87

FunctionclearCache

* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.

packages/client-analytics/src/analyticsClient.ts:117

FunctionclearCache

* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.

packages/agent-studio/src/agentStudioClient.ts:151

← previous next →101–200 of 600, ranked by callers