Esta dependencia está pensada para ser utilizada en NestJs Starter, o cualquier proyecto que utilice una configuración centralizada, siguiendo la misma arquitectura del starter.

Glosario

• 🥳 Demo
• 📝 Requerimientos básicos
• 🛠️ Instalar dependencia
• 👨‍💻️ Uso
• ⚙️ Configuración
• 📤 Commits
• 📄 Changelog
• 📜 License MIT

📝 Requerimientos básicos

• NestJs Starter
• Node.js v14.15.4 or higher (Download)
• NPM v6.14.10 or higher
• NestJS v8.2.0 or higher (Documentación)

🛠️ Instalar dependencia

npm install @tresdoce/nestjs-httpclient

👨‍💻️ Uso

Importar HttpClientModule en el módulo que requiera utilizarlo, o bien se puede utilizarla de manera global en el app.module.ts.

// .src/app.module.ts

import { HttpClientModule } from '@tresdoce/nestjs-httpclient';

@Module({
  ...,
  imports: [
    ...,
  HttpClientModule,
  ...,
]
...,
})

export class AppModule {
}

Luego inyecte HttpClientService en el constructor de la clase que requiere realizar requests.

// ./src/app.service.ts

import { HttpClientService } from '@tresdoce/nestjs-httpclient';

export class AppService {
  constructor(private readonly httpClient: HttpClientService) {
  }
}

Realice el request utilizando el servicio instanciado en el constructor.

// ./src/app.service.ts
export class AppService {
...

  async getInfoFromApi() {
    try {
      const { status, data } = await this.httpClient.get('http://api.domain.com')
      return data;
    } catch (error) {
      return error;
    }
  }

...
}

⚙️ Configuración

Este módulo utiliza Axios y Axios-retry, por lo que puedes pasarle cualquier configuración de AxiosRequestConfig y/o AxiosRetryConfig por medio del método .register() como si fuera el httpModule original de NestJs.

import { HttpClientModule } from '@tresdoce/nestjs-httpclient';

@Module({
  imports: [
    HttpClientModule.register({
      timeout: 1000,
      retries: 5,
      ...
    }),
  ]
})

Configuración async

Cuando necesite pasar las opciones del módulo de forma asincrónica en lugar de estática, utilice el método .registerAsync() como si fuera el httpModule original de NestJs.

Hay varias formas para hacer esto.

• useFactory

Desde la configuración centralizada, debera crear un objeto de configuración para el módulo, y luego obtenerlo con la inyección del ConfigService.

HttpClientModule.registerAsync({
  imports: [ConfigModule],
  useFactory: async (configService: ConfigService) => configService.get('config.httpOptions'),
  inject: [ConfigService]
});

O también puede hacerlo asi.

HttpClientModule.registerAsync({
  useFactory: () => ({
    timeout: 1000,
    retries: 5,
    ...
  })
});

• useClass

HttpClientModule.registerAsync({
  useClass: HttpConfigService
});

Tenga en cuenta que en este ejemplo, el HttpConfigService tiene que implementar la interfaz HttpModuleOptionsFactory como se muestra a continuación.

@Injectable()
class HttpConfigService implements HttpModuleOptionsFactory {
  async createHttpOptions(): Promise<HttpModuleOptions> {
    const configurationData = await someAsyncMethod();
    return {
      timeout: configurationData.timeout,
      retries: 5,
      ...
    };
  }
}

• useExisting

Si desea reutilizar un proveedor de opciones existente en lugar de crear una copia dentro del HttpClientModule, utilice la sintaxis useExisting.

HttpClientModule.registerAsync({
  imports: [ConfigModule],
  useExisting: ConfigService,
});

📤 Commits

Para los mensajes de commits se toma como referencia conventional commits.

<type>[optional scope]: <description>

[optional body]

[optional footer]

• type: chore, docs, feat, fix, refactor (más comunes)
• scope: indica la página, componente, funcionalidad
• description: comienza en minúsculas y no debe superar los 72 caracteres.

📄 Changelog

All notable changes to this package will be documented in Changelog file.