Table of Contents

• 🎇 Benefits
• 📗 Libraries
• 📁 Dependencies
• ⏩ Get Started
  • 🔘 Use Template
  • 💻 Usage
  • 📍 Start Project
  • 📨 Build and Run
  • 🧪 Teste Code

🎇 Benefits

• 🚀 Speed performance Inversion of control
• 🚨 Code Quality
• 🎇 Use Interface
• 🧪 Teste with 100% coverage

📗 Libraries

• Node.js 16
• Typescript
• Eslint
• ODG-Linter-JS
• EditorConfig
• ReviewDog

📁 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 and yarn start again

yarn build && yarn start
# or
yarn dev

🧪 Teste Code

To Test execute this command

yarn test
# or
yarn test:watch