Api clients / JavaScript / V3 / Methods

Jan. 22, 2021

Configuring Timeouts | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

Required API Key: no ACL required

Method signature

client.setTimeouts({
  connect: integer connectTimeout,
  read: integer readTimeout,
  write: integer writeTimeout
})

See code examples

About this method

Override the pre-configured timeouts.

Network & DNS resolution can be slow. That is why we have pre-configured timeouts. We do not advise to change them, but it could make sense to change them in some special cases.

Note: Not all parameters are available for every language. See Parameters below.

Examples

Copy

Copy
$config = SearchConfig::create('YourApplicationID', 'YourAdminAPIKey');
$config->setConnectTimeout(2);
$config->setReadTimeout(30);
$config->setWriteTimeout(30);

SearchClient::createWithConfig($config);

Copy
Algolia::Client.new({
  application_id: 'YourApplicationID',
  api_key: 'YourAdminAPIKey',
  connect_timeout: 2,
  send_timeout: 30,
  receive_timeout: 30,
  batch_timeout: 120,  # send_timeout override for batches
  search_timeout: 5    # send_timeout override for queries
})

Copy
// at init time:
const client = algoliasearch(appId, apiKey, {
  timeouts: {
    connect: 1000,
    read: 2 * 1000,
    write: 30 * 1000
  }
});

// after initialization:
client.setTimeouts({
  connect: 1000,
  read: 2 * 1000,
  write: 30 * 1000
});

// timers in JavaScript are specified in milliseconds

Copy
config = SearchConfig('YourApplicationID', 'YourAdminAPIKey')
config.connect_timeout = 2
config.read_timeout = 30
config.write_timeout =  30

client = SearchClient.create_with_config(config)

Copy
APIClient client = new ApiClient(...);
client.setConnectTimeout(2000); // connection timeout
client.setReadTimeout(30000); // read timeout
client.setSearchTimeout(5000) // read timeout for search requests
client.setHostDownDelay(5000); // delay before retrying a host we know was down

Copy
SearchConfig configuration =
new SearchConfig.Builder("YourApplicationID", "YourAdminAPIKey")
  .setReadTimeOut(4000) // milliseconds
  .setWriteTimeOut(4000) 
  .setConnectTimeOut(4000)
  .build();

SearchClient client = DefaultSearchClient.create(configuration);

Copy
config := search.Configuration{
  AppID:        "YourApplicationID",
  APIKey:       "YourAdminAPIKey",
  ReadTimeout:  30 * time.Second,
  WriteTimeout: 30 * time.Second,
}

client := search.NewClientWithConfig(config)

Copy
val configuration = AlgoliaClientConfiguration(
  httpConnectTimeoutMs = 2 * 1000,
  httpReadTimeoutMs = 2 * 1000,
  httpRequestTimeoutMs = 2 * 1000,
  dnsTimeoutMs = 2 * 100,
  hostDownTimeoutMs = 5 * 60 * 1000
)
new AlgoliaClient(applicationId, apiKey, configuration = configuration)

Copy
val configuration = ConfigurationSearch(
    applicationID = ApplicationID("YourApplicationID"),
    apiKey = APIKey("YourAdminAPIKey"),
    readTimeout = 30,
    writeTimeout = 30
)
ClientSearch(configuration)

Parameters

`connectTimeout`	type: integer default: Optional Timeout for the tcp session to connect. Available in all languages except Swift, C#, and Kotlin.
`readTimeout`	type: integer default: Optional Timeout for the read on the tcp socket. Available in all languages.
`writeTimeout`	type: integer default: Optional Same as requestTimeout but applies only to write operations. Only available for the following languages: javascript, kotlin, csharp.
`hostDownDelay`	type: integer default: Optional The expected period of time for a down host to get back up again. Impacts the time between API Client retries. Only available for Android, C#, Java, Go, and Scala.
`dnsTimeout`	type: integer default: Optional Timeout for the dns resolution. Only available for Scala. This timeout exists as connectTimeout in the other clients. If both conectTimeout and dnsTimeout are set in Scala client, the shorter of the two is used.
`searchBatchTimeout`	type: integer default: Optional Same as requestTimeout but applies only to batch operations. Only available for Ruby.
`searchReadTimeout`	type: integer default: Optional Same as requestTimeout but applies only to search operations. Only available for Ruby and Swift.
`requestTimeout`	type: integer default: Optional HTTP timeout for the request. Only available for Scala.

Response

No response.

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

Configuring Timeouts | JavaScript API Client V3 (Deprecated)

About this method

Examples

Parameters

Response

Did you find this page helpful?

On this page