@types/axios

What is @types/axios?

@types/axios provides TypeScript type definitions for the axios HTTP client, enabling developers to use axios with TypeScript and benefit from type checking and autocompletion.

What are @types/axios's main functionalities?

Basic GET Request

This feature allows you to make a basic GET request to a specified URL and handle the response or any errors that occur.

const axios = require('axios');
axios.get('https://api.example.com/data')
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error);
  });

POST Request with Data

This feature allows you to make a POST request to a specified URL with a data payload and handle the response or any errors that occur.

const axios = require('axios');
axios.post('https://api.example.com/data', {
  key1: 'value1',
  key2: 'value2'
})
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error);
  });

Setting Custom Headers

This feature allows you to set custom headers for a request, such as an Authorization header for authenticated requests.

const axios = require('axios');
axios.get('https://api.example.com/data', {
  headers: {
    'Authorization': 'Bearer token'
  }
})
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error);
  });

Handling Response Types

This feature allows you to specify the response type for a request, such as 'json', 'text', 'blob', etc.

const axios = require('axios');
axios.get('https://api.example.com/data', {
  responseType: 'json'
})
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error);
  });

Interceptors

This feature allows you to set up interceptors to run code or modify requests/responses before they are handled by then or catch.

const axios = require('axios');
axios.interceptors.request.use(config => {
  console.log('Request was sent');
  return config;
}, error => {
  return Promise.reject(error);
});
axios.interceptors.response.use(response => {
  console.log('Response received');
  return response;
}, error => {
  return Promise.reject(error);
});

Other packages similar to @types/axios

node-fetch

node-fetch is a lightweight module that brings window.fetch to Node.js. It is similar to axios in that it allows you to make HTTP requests, but it is more minimalistic and does not include features like interceptors or automatic JSON transformation.

request

request is a simplified HTTP client for Node.js with support for various features like custom headers, cookies, and multipart form data. It is more feature-rich compared to node-fetch but is now deprecated in favor of more modern alternatives like axios.

superagent

superagent is a small, progressive client-side HTTP request library that is also compatible with Node.js. It offers a similar feature set to axios, including support for promises, custom headers, and interceptors.

README

This is a stub types definition for axios (https://github.com/mzabriskie/axios). axios provides its own type definitions, so you don't need @types/axios installed!