@algolia/transporter

Basic Request

This code demonstrates how to create a basic transporter instance and make a GET request to list all indexes in an Algolia application.

const { createTransporter } = require('@algolia/transporter');

const transporter = createTransporter({
  hosts: [{ url: 'https://your-algolia-instance.algolia.net' }],
  headers: { 'X-Algolia-API-Key': 'your-api-key', 'X-Algolia-Application-Id': 'your-app-id' }
});

transporter.read({ method: 'GET', path: '/1/indexes' }).then(response => {
  console.log(response);
});

Handling Retries

This code shows how to configure the transporter to handle retries with specific timeout settings and retry policies.

const { createTransporter } = require('@algolia/transporter');

const transporter = createTransporter({
  hosts: [{ url: 'https://your-algolia-instance.algolia.net' }],
  headers: { 'X-Algolia-API-Key': 'your-api-key', 'X-Algolia-Application-Id': 'your-app-id' },
  timeouts: { connect: 1, read: 2, write: 30 },
  retry: { maxRetries: 3, delay: 1000 }
});

transporter.read({ method: 'GET', path: '/1/indexes' }).then(response => {
  console.log(response);
});

Custom Headers

This example demonstrates how to add custom headers to the transporter instance for making requests.

const { createTransporter } = require('@algolia/transporter');

const transporter = createTransporter({
  hosts: [{ url: 'https://your-algolia-instance.algolia.net' }],
  headers: { 'X-Algolia-API-Key': 'your-api-key', 'X-Algolia-Application-Id': 'your-app-id', 'Custom-Header': 'custom-value' }
});

transporter.read({ method: 'GET', path: '/1/indexes' }).then(response => {
  console.log(response);
});