jfq-shared-dtos

Introduction

jfq-shared-dtos is a package that provides shared Data Transfer Objects (DTOs) used across both the frontend and backend services of the Jones application. This package serves as the single source of truth for all DTOs used within the JFQ application, ensuring that both frontend and backend services adhere to the same contract when handling data.

Why Use Shared DTOs?

By centralizing DTOs into a shared package, we gain the following benefits:

• Consistency: The same DTO definitions are used across all services, ensuring consistency in the data structures.
• Type Safety: Using TypeScript allows us to maintain strict type checking, reducing the risk of bugs due to mismatched data structures.
• Scalability: As the application grows, having shared DTOs makes it easier to scale and maintain.
• Reduced Duplication: Sharing DTOs between frontend and backend reduces code duplication and allows for faster iteration when updating the data model.

Installation

To install the jfq-shared-dtos package in your project, run the following command:

# Using npm
npm install jfq-shared-dtos --save-dev

# Using yarn
yarn add jfq-shared-dtos --dev

Usage

Frontend Example

import { UserDTO } from 'jfq-shared-dtos';

const user: UserDTO = {
  id: '123',
  name: 'John Doe',
  email: '[email protected]',
};

Backend Example

import { UserDTO } from 'jfq-shared-dtos';

const createUser = (user: UserDTO) => {
  // Handle user creation logic
};