Neron Lib

Description

Neron Lib is a comprehensive library designed to facilitate the development of microservices by providing a centralized collection of interfaces, types, classes, enums, and DTOs. It enables seamless communication and sharing of data structures among microservices within the Neron API ecosystem.

View Neron repository here

Install

You can install the library using npm, yarn or pnpm:

npm install neron-lib
# o
yarn add neron-lib
# o
pnpm install neron-lib

Usage Example

import { IJwtPayload } from 'neron-lib';

// Using the imported types
const userCredentials: IJwtPayload = {
  id: '508e0b91-239d-499f-bf05-20122a671617',
  email: '[email protected]',
};

console.log({ authResult });

Structure

The library follows a structure organized by microservice, where each folder contains its own interfaces, types, classes, enums, dtos, etc. The index.ts file in each folder serves to export all relevant elements of the microservice.

📦 neron-lib
┣ 📂 ms-auth
┃ ┣ 📜 index.ts
┃ ┣ 📜 auth.interface.ts
┃ ┣ 📜 auth-type.ts
┃ ┗ ...
┣ 📂 ms-users
┃ ┣ 📜 index.ts
┃ ┣ 📜 user.interface.ts
┃ ┣ 📜 user-type.ts
┃ ┗ ...
┣ ...
┗ 📜 index.ts