Partage et réutilisation du code
Découvrez des stratégies pour maximiser la réutilisation du code entre le client et le serveur, notamment pour les types et les utilitaires.
Partage et réutilisation du code est une leçon tRPC End-to-End Type Safe APIs gratuite sur CoddyKit. Ceci est la leçon 2 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage tRPC End-to-End Type Safe APIs, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours tRPC End-to-End Type Safe APIs comprend 4 leçons au total.
Certaines parties de cette leçon n'ont pas encore été traduites et s'affichent en anglais.
Why Share Code?
In a tRPC monorepo, you often have multiple applications (client, server, admin panel) that need to interact with the same data structures or perform similar tasks.
Code sharing is a powerful technique that helps reduce duplication, ensure consistency, and improve the overall maintainability of your project.
Types Across Client & Server
One of tRPC's biggest advantages is end-to-end type safety. This means your frontend automatically knows the types of data your backend sends and receives.
This magic relies heavily on sharing TypeScript types and interfaces between your client and server applications.
Defining a Shared Type
Let's create a simple User interface in a dedicated packages/types directory. This package will be imported by both your server and client.
/* packages/types/src/user.ts */
export interface User {
id: string;
name: string;
email: string;
}Server-side Shared Types
Now, we can use this User type to define the expected output of a tRPC query on our backend. This ensures the data sent from the server strictly adheres to the User structure.
/* packages/server/src/router/user.ts */
import { publicProcedure, router } from '../trpc';
import { User } from '@my-monorepo/types'; // Import shared type
export const userRouter = router({
getUsers: publicProcedure
.query(async () => {
const users: User[] = [
{ id: '1', name: 'Alice', email: 'alice@example.com' },
{ id: '2', name: 'Bob', email: 'bob@example.com' },
];
return users; // tRPC infers return type as User[]
}),
});Client-side Shared Types
On the client, tRPC automatically infers the types for users based on the server's definition. While explicit import isn't always needed for inference, it improves clarity and allows you to use the type for local client-side state or props.
/* packages/client/src/components/UserList.tsx */
import { trpc } from '../utils/trpc';
import { User } from '@my-monorepo/types'; // Optional, but good practice
function UserList() {
const { data: users, isLoading } = trpc.user.getUsers.useQuery();
if (isLoading) return <div>Loading users...</div>;
return (
<div>
{users?.map((user: User) => ( // 'user' is typed as User
<p key={user.id}>{user.name} ({user.email})</p>
))}
</div>
);
}Sharing Utility Functions
Beyond types, many other pieces of code can be shared. This includes common utility functions, constants, validation schemas (like Zod schemas), or even shared UI components if you're using a component library.
Sharing these helps maintain a consistent user experience and reduces redundant code across your applications.
Creating a Utility Package
Let's create a simple utility function in a packages/utils directory that formats a full name. We'll also include a shared constant.
/* packages/utils/src/format.ts */
export function formatFullName(firstName: string, lastName: string): string {
return `${firstName} ${lastName}`;
}
export const APP_NAME = 'CoddyKit Learn'; // Example constantServer-side Utilities
You can import and use these shared utility functions directly in your tRPC backend procedures. This ensures consistent logic, regardless of whether it's triggered by an API call or internal server processes.
/* packages/server/src/router/profile.ts */
import { publicProcedure, router } from '../trpc';
import { formatFullName } from '@my-monorepo/utils'; // Import shared utility
import { z } from 'zod'; // Assuming Zod is configured
export const profileRouter = router({
getUserProfile: publicProcedure
.input(z.object({ firstName: z.string(), lastName: z.string() }))
.query(({ input }) => {
const fullName = formatFullName(input.firstName, input.lastName);
return { greeting: `Hello, ${fullName}!` };
}),
});Client-side Utilities
Similarly, your client-side application can import and use the exact same utility functions and constants. This guarantees that calculations or displayed text are consistent with the server's logic.
/* packages/client/src/components/Greeting.tsx */
import { formatFullName, APP_NAME } from '@my-monorepo/utils'; // Import shared utility
function Greeting() {
const firstName = "Jane";
const lastName = "Doe";
const formattedName = formatFullName(firstName, lastName);
return (
<div>
<h1>Welcome to {APP_NAME}!</h1>
<p>User: {formattedName}</p>
</div>
);
}Best Practices for Shared Code
- Granularity: Create small, focused shared packages (e.g.,
types,utils,ui). - Dependencies: Shared packages should have minimal external dependencies to avoid bloating other apps.
- Avoid Circular Deps: Be careful not to create circular dependencies between shared packages or between app and shared packages.
- Testing: Test shared code thoroughly, as changes can affect multiple applications.
Shared Code Benefits
Which of the following are primary benefits of sharing types and utility functions between client and server in a tRPC monorepo?
Recap: Sharing is Caring!
We explored how sharing types and utility functions in a tRPC monorepo is key to maximizing efficiency. This approach reduces duplication, enhances type safety, and improves overall maintainability across your client and server applications. By structuring your project carefully, you can build robust and consistent full-stack applications.
Questions Fréquemment Posées
La leçon « Partage et réutilisation du code » est-elle gratuite ?
Oui — le texte complet de « Partage et réutilisation du code » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours tRPC End-to-End Type Safe APIs, passe à CoddyKit PRO. Le cours tRPC End-to-End Type Safe APIs comprend 4 leçons au total.
Qu'est-ce que j'apprendrai dans « Partage et réutilisation du code » ?
Découvrez des stratégies pour maximiser la réutilisation du code entre le client et le serveur, notamment pour les types et les utilitaires. Tu pratiques tRPC End-to-End Type Safe APIs avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.
Dois-je avoir de l'expérience pour commencer tRPC End-to-End Type Safe APIs ?
Aucune expérience préalable n'est requise. tRPC End-to-End Type Safe APIs sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 2 sur 4.
Combien de temps prend la leçon « Partage et réutilisation du code » ?
La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.
Peux-tu écrire et exécuter du code dans cette leçon tRPC End-to-End Type Safe APIs ?
Oui. Chaque leçon tRPC End-to-End Type Safe APIs inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.
Toutes les leçons de ce cours
- Configurer un monorepo tRPC
- Partage et réutilisation du code
- Étendre les fonctionnalités de tRPC
- Versionnage et publication de paquets tRPC partagés