NestJS Undici

NestJS Undici is a powerful HTTP client module for NestJS applications, built on top of @nodejs/undici. It provides a simple and efficient way to make HTTP requests in your NestJS applications.

Features

• 🚀 Built on top of @nodejs/undici
• 🔄 Full TypeScript support
• ⚡ High-performance HTTP client
• 🔒 Secure by default
• 🛠️ Easy to configure and use
• 📦 Lightweight and dependency-free
• 🔍 Built-in request/response interceptors
• 🔄 Automatic retry mechanism
• 📝 Comprehensive documentation

Installation

1# Using npm
2npm install nestjs-undici
3
4# Using yarn
5yarn add nestjs-undici

Quick Start

1. Import the HttpModule in your root module:

1import { Module } from '@nestjs/common';
2import { HttpModule } from 'nestjs-undici';
3
4@Module({
5  imports: [
6    HttpModule.register({
7      // Optional configuration
8      headers: {
9        'Content-Type': 'application/json',
10      },
11    }),
12  ],
13})
14export class AppModule {}

2. Inject and use the HttpService in your service:

1import { Injectable } from '@nestjs/common';
2import { HttpService } from 'nestjs-undici';
3
4@Injectable()
5export class AppService {
6  constructor(private readonly httpService: HttpService) {}
7
8  async getUsers() {
9    const response = await this.httpService
10      .request('https://api.example.com/users')
11      .toPromise();
12    
13    return response.data;
14  }
15}

Configuration

The HttpModule can be configured using the register or registerAsync methods:

Synchronous Configuration

1HttpModule.register({
2  headers: {
3    'Content-Type': 'application/json',
4  },
5  timeout: 5000,
6  retry: {
7    attempts: 3,
8    delay: 1000,
9  },
10});

Asynchronous Configuration

1HttpModule.registerAsync({
2  useFactory: async (configService: ConfigService) => ({
3    headers: {
4      'Authorization': await configService.get('API_KEY'),
5    },
6  }),
7  inject: [ConfigService],
8});

Advanced Usage

Making HTTP Requests

1// GET request
2const response = await this.httpService
3  .request('https://api.example.com/users')
4  .toPromise();
5
6// POST request
7const response = await this.httpService
8  .request('https://api.example.com/users', {
9    method: 'POST',
10    body: JSON.stringify({ name: 'John Doe' }),
11  })
12  .toPromise();

Using Interceptors

1import { Injectable } from '@nestjs/common';
2import { HttpService, HttpInterceptor } from 'nestjs-undici';
3
4@Injectable()
5export class AuthInterceptor implements HttpInterceptor {
6  intercept(request: Request) {
7    request.headers.set('Authorization', 'Bearer token');
8    return request;
9  }
10}
11
12// Register the interceptor
13HttpModule.register({
14  interceptors: [AuthInterceptor],
15});

API Reference

For detailed API documentation, please visit our documentation site.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you find this package useful, please consider giving it a ⭐️ on GitHub.