@nestjs/axios

What is @nestjs/axios?

The @nestjs/axios package is a module for the NestJS framework that provides integration with Axios, a popular HTTP client, for making HTTP requests from your NestJS applications. It simplifies the process of sending HTTP requests and handling responses, allowing developers to easily communicate with external APIs or services.

What are @nestjs/axios's main functionalities?

HTTP GET Request

This feature allows you to perform HTTP GET requests to retrieve data from a specified resource. The code sample demonstrates how to make a GET request to an external API and log the response data.

this.httpService.get('https://api.example.com/data').subscribe(response => console.log(response.data));

HTTP POST Request

This feature enables you to send HTTP POST requests to a specified resource, allowing you to submit data to be processed by the resource. The code sample shows how to make a POST request with a JSON body and log the response.

this.httpService.post('https://api.example.com/data', { key: 'value' }).subscribe(response => console.log(response.data));

Interceptors

Interceptors allow you to intercept requests or responses before they are handled by then or catch. This feature is useful for logging, authentication, or any other global request/response modification. The code sample demonstrates how to log a message every time a request is sent.

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

Other packages similar to @nestjs/axios

axios

Axios is a promise-based HTTP client for the browser and node.js. It provides a simple API for making HTTP requests and is the underlying library used by @nestjs/axios. While Axios can be used directly in any JavaScript application, @nestjs/axios wraps it in a module to integrate it seamlessly with the NestJS framework.

node-fetch

node-fetch is a light-weight module that brings window.fetch to Node.js. It offers an alternative to Axios for making HTTP requests. Unlike @nestjs/axios, which is designed specifically for NestJS applications, node-fetch provides a more general approach and can be used in various Node.js environments.

got

Got is a human-friendly and powerful HTTP request library for Node.js. It provides a simpler and more intuitive API compared to Axios, with features like retries, streams, and pagination built-in. While Got is not specifically tailored for NestJS like @nestjs/axios, it can be used in any Node.js application for making HTTP requests.

README

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Axios module for Nest.

The HttpModule module exposes Axios-based methods to perform HTTP requests. This library also transforms the resulting HTTP responses into Observables (from RxJS).

Installation

$ npm i --save @nestjs/axios axios

Quick Start

Overview & Tutorial

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.