@3kles/3kles-corebe
TypeScript icon, indicating that this package has built-in type declarations

3.2.3 • Public • Published

3KLES -COREBE

This package contains interface and class to create Express Application

API

IGenericAPI is an interface with four methods:

  • buildRequest: Method to build the request api from parameters and data
  • executeRequest: Method to execute the request
  • processResponse: Method called to manage response
  • processError: Method called to manage error response

In this module there is a class HttpApi that implement IGenericApi to manage http/s request protocol.

App

IGenericApp is an interface defined as below:

  • initAppVariable: Method to init variable (Exemple from dotenv)
  • initModule: Method to load module
  • initError: Method to manage error
  • initRoute: Method to set main router
  • startApp: Start app with port number

Router

IGenericRouter is an interface defined as below:

  • addController:Method to add route from controller

Controller

IGenericController is an interface defined as below:

  • execute: Method to execute request from type
  • setService:Method to set IGenericService
  • getParameters:Method to get service parameters
  • updateParamFromRequest:Method to update controller parameters from request

Service

IGenericService is an interface defined as below:

  • execute: Method to execute request from parameters
  • getParameters:Method to get service parameters

Package Sidebar

Install

npm i @3kles/3kles-corebe

Weekly Downloads

124

Version

3.2.3

License

ISC

Unpacked Size

1.15 MB

Total Files

52

Last publish

Collaborators

  • freazgo
  • jchaut
  • cdasilvacosta
  • qcampos