@joktec/http v0.0.176
Table of Contents
Introduction
@joktec/http
is a library used for making HTTP requests, based on NestJS. It is a wrapper for axios
and @nestjs/axios
, providing an easy-to-use interface for creating HTTP clients with NestJS.
Installation
To install this library, use either npm
or yarn
:
npm install -S @joktec/core @joktec/http
# or
yarn add -S @joktec/core @joktec/http
Getting Started
Configuration
@joktec/http
uses a configuration file to set up the default options for the HTTP client. Create a config.yml file in the root of your project, and add the following configuration options:
http:
baseURL: https://mydomain.com
method: GET
timeout: 30000
auth:
username: myuser
password: mypass
raxConfig:
retry: 3
Update the values according to your HTTP client details. The raxConfig option is using the retry-axios package to automatically retry failed requests.
Module
Once you have provided the configuration, you can import the MongoModule
in your AppModule
:
import { CoreModule, Module } from '@joktec/core';
import { HttpModule } from '@joktec/http';
@Module({
imports: [CoreModule, HttpModule],
})
export class AppModule {}
Service
You can then use the HttpService and do any request:
import { Injectable } from '@joktec/core';
import { HttpService, Client, HttpResponse, HttpFormData } from '@joktec/http';
import { firstValueFrom } from 'rxjs';
@Injectable()
export class MyService {
constructor(private readonly httpService: HttpService) {}
async request(): Promise<HttpResponse<T>> {
return firstValueFrom(this.httpService.request<T>({
// ... input config
}));
}
async upload(): Observable<HttpResponse<T>> {
const data: HttpFormData = new HttpFormData();
return firstValueFrom(this.httpService.upload<T>({
// ... input config
}, data));
}
}
Reference
Contributing
Contributions to @joktec/http
are welcome. If you would like to contribute, please fork the repository, make your changes, and submit a pull request.
Please make sure to update tests as appropriate.
8 months ago
8 months ago
8 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
9 months ago
10 months ago
11 months ago
11 months ago
11 months ago
10 months ago
1 year ago
12 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago