1.6.0 โข Published 2 months ago
@odg/axios v1.6.0
Table of Contents
๐ Benefits
- ๐ Speed performance Inversion of control
- ๐จ Code Quality
- ๐ Use Interface
- ๐งช Teste with 100% coverage
๐ Libraries
๐ Dependencies
- Node.js 16 or later
- Yarn Optional/Recommended
- ODG Message
- ODG TsConfig Last Version
- ODG Exception Last Version
โฉ Get Started
๐ Installation
yarn add @odg/message @odg/axios axios
๐ป Usage
For simple example usage, you can use Inversify for Dependency Injection
import { type MessageInterface, type ResponseInterface } from "@odg/message";
class Test {
public constructor(
private readonly requester: MessageInterface
) {
}
public async example(): Promise<ResponseInterface<
unknown, // Reques Body
Record<string, unknown>, // Response Body
>> {
return this.requester.request({
url: "https://api.github.com/users/ODGodinho",
});
}
}
const test = new Test(new AxiosMessage({
// default options axios
}));
console.log(await test.example());
๐ Start Project
First install dependencies with the following command
yarn install
# or
npm install
๐จ Build and Run
To build the project, you can use the following command
if you change files, you need to run
yarn build
andyarn start
again
yarn build && yarn start
# or
yarn dev
๐งช Teste Code
To Test execute this command
yarn test
# or
yarn test:watch