website·Indexed 30 days ago
https://fkc-alt.github.io/http-typedi/A framework for building HTTP services featuring dependency injection, modular architecture, and a robust set of decorators. It includes built-in support for guards, interceptors, pipes (such as ParseIntPipe and ValidationPipe), and controllers with versioning and routing capabilities.
The http-typedi library provides a set of modular utility services designed to handle common client-side development tasks and reduce boilerplate code. The available utility interfaces include:
UploadService: For handling file uploads.RequestService: For managing network requests.UtilsService: For general-purpose utility functions.http-typedi is a lightweight, out-of-the-box TypeScript library for HTTP requests. Key features include:
Interceptors in http-typedi are inspired by Aspect-Oriented Programming (AOP) and allow developers to inject cross-cutting logic into function executions. They can be used to:
canActivate() function in guards receives an instance of ExecutionContext. ExecutionContext extends ArgumentsHost, meaning it provides access to the request object and other arguments, while adding detailed information about the current execution process. This allows developers to build generic guards that can operate across multiple controllers, methods, and different execution contexts.@Injectable() decorator to mark a class as a provider and inject the built-in RequestService to perform the actual server requests.import { Injectable, RequestService } from 'http-typedi'
import { DemoReq, DemoRes } from './interfaces/demo.interface'
@Injectable()
export default class DemoService {
constructor(private requestService: RequestService) {}
private readonly url: string = 'http://localhost:8080'
public getDemoDetail(param: DemoReq): ServerRes<DemoRes> {
return this.requestService.request(param)
}
}A Data Transfer Object (DTO) is an object specifically designed to transport data between different layers of an application. By using DTOs, developers can decouple the internal data structures of a layer from the data being transmitted, which leads to a clearer system architecture.
Key benefits include:
app.module.ts file. Available global configuration areas include route mapping, route prefixes, interceptors, exception handlers, and delay timers.@Sleep() decorator to introduce a delay in processing a route request. The decorator accepts a single number argument representing the delay duration in milliseconds (ms). This decorator must be imported from the http-typedi package.import { Controller, PostMapping, Sleep } from 'http-typedi';
import { DemoService } from './demo.service';
import { DemoReq, DemoRes } from './interfaces/demo.interface';
@Controller('demo')
export class DemoController {
constructor(private demoService: DemoService) {}
@PostMapping('updateDetail')
@Sleep(1000) // Delays the request by 1000ms (1 second)
async updateDemoDetail(demo: DemoReq): ServerRes<DemoRes> {
return this.demoService.updateDemoDetail(demo);
}
}In http-typedi, a Module is a class decorated with @Module(). This decorator provides the metadata necessary for the framework to organize the application tree. Every application must have at least one root module, which serves as the entry point for the application structure. For larger applications, multiple modules should be used to group closely related features.
By default, modules encapsulate their providers. A provider can only be injected if it is a direct part of the current module or if it has been exported from an imported module. Exported providers act as the module's public API.
To perform a manual network request using RequestService, pass a RequestConfig object to the .request() method.
Data Transmission Rule:
method is GET, use the params field to send data.data field to send data.const result = this.requestService.request<TData, Record<string, any>>(configure);