NestJS Axios (@nestjs/axios)

To use the NestJS Axios module, you must install both the @nestjs/axios wrapper and the underlying axios library via npm.

$ npm i --save @nestjs/axios axios

Use the register static method to configure the HttpModule with a fixed configuration object. This method allows you to set a global flag to make the module available throughout your entire application. The provided configuration is used to create a custom Axios instance via Axios.create(config) which is then provided under the AXIOS_INSTANCE_TOKEN.

@Module({
  imports: [HttpModule.register({ 
    global: true, 
    timeout: 5000 
  })],
})
export class MyModule {}

The HttpService class provides a wrapper around AxiosInstance, converting standard Axios promise-based requests into RxJS Observable streams. This allows you to integrate HTTP calls seamlessly into NestJS reactive patterns.

All request methods return an Observable<AxiosResponse<T>>. You can use standard RxJS operators (like map, catchError, or switchMap) to handle the response data or errors.

import { HttpService } from '@nestjs/axios';
import { map } from 'rxjs';

// Inside a NestJS service or controller
constructor(private readonly httpService: HttpService) {}

async getData() {
  const { data } = await this.httpService.get('https://api.example.com/data').toPromise();
  return data;
}

// Or using RxJS operators
this.httpService.get('https://api.example.com/data').pipe(
  map(response => response.data)
).subscribe(data => console.log(data));

When importing HttpModule, you can provide static configuration using the HttpModuleOptions type. This type extends AxiosRequestConfig, allowing you to pass any standard Axios configuration (like baseURL, timeout, headers, etc.). Additionally, you can set the global property to true to register the module globally within your NestJS application.

// Example of the shape of HttpModuleOptions
const options: HttpModuleOptions = {
  baseURL: 'https://api.example.com',
  timeout: 5000,
  global: true,
};

If you need to access the raw AxiosInstance to use features not explicitly wrapped by HttpService (or to configure interceptors directly), you can use the axiosRef getter.

const axiosInstance = this.httpService.axiosRef;

The @nestjs/axios package exports the core components required to integrate Axios into a NestJS application. To use Axios within your NestJS services, you must import and register HttpModule in your module definitions and then inject HttpService into your classes.

import { HttpModule } from '@nestjs/axios';
import { HttpService } from '@nestjs/axios';
import { Module } from '@nestjs/common';

@Module({
  imports: [HttpModule],
  providers: [MyService],
})
export class MyModule {}

If you prefer to use a class to provide your HTTP configuration, implement the HttpModuleOptionsFactory interface. This interface requires a createHttpOptions() method that returns either HttpModuleOptions or a Promise<HttpModuleOptions>.

import { HttpModuleOptionsFactory, HttpModuleOptions } from '@nestjs/axios';

export class MyHttpConfigFactory implements HttpModuleOptionsFactory {
  createHttpOptions(): HttpModuleOptions {
    return {
      baseURL: 'https://api.example.com',
    };
  }
}

// Usage in a module
@Module({
  imports: [
    HttpModule.registerAsync({
      useClass: MyHttpConfigFactory,
    }),
  ],
})
export class MyModule {}

If you need to access the configuration options passed to the HttpModule during its initialization, you can inject them using the HTTP_MODULE_OPTIONS token.

@Injectable()
export class MyService {
  constructor(@Inject(HTTP_MODULE_OPTIONS) private readonly options: HttpModuleOptions) {}
}