Introdução à extensão de módulos

A extensão de módulos permite ampliar ou modificar módulos existentes, possibilitando adicionar propriedades ou métodos personalizados a bibliotecas ou módulos no TypeScript.

Isso é especialmente útil ao trabalhar com bibliotecas de terceiros que precisam de funcionalidades adicionais ou tipos personalizados.

O que é extensão de módulos?

A extensão de módulos envolve reabrir um módulo existente e adicionar ou modificar seus tipos ou funcionalidades usando a sintaxe declare module.

Exemplo básico de extensão de módulos

Veja um exemplo de extensão do módulo express para adicionar uma propriedade personalizada ao objeto Request:

import 'express';

declare module 'express' {
  interface Request {
    user?: { id: string; role: string };
  }
}

Usando módulos estendidos

Depois de estender o módulo, você pode usar a funcionalidade ampliada na sua aplicação:

import express from 'express';

const app = express();

app.use((req, res, next) => {
  req.user = { id: '123', role: 'admin' };
  next();
});

app.get('/', (req, res) => {
  res.send(`User ID: ${req.user?.id}`);
});

Adicionando tipos personalizados a módulos de terceiros

A extensão de módulos é frequentemente usada para adicionar tipos personalizados a bibliotecas de terceiros que não abrangem completamente seu caso de uso.

Cuidados com a extensão de módulos

Ao estender um módulo:

• Certifique-se de não substituir tipos existentes sem intenção.
• Documente suas alterações para facilitar a manutenção do código.
• Use a extensão de módulos somente quando necessário para evitar poluir os tipos globais.

Casos de uso no mundo real

A extensão de módulos é comumente usada para:

• Ampliar bibliotecas de terceiros para incluir propriedades específicas da aplicação.
• Adicionar propriedades personalizadas de intermediação em estruturas como Express.js.
• Adaptar módulos aos requisitos específicos do projeto.

Tarefa prática

Amplie o objeto Request do módulo express para incluir um método personalizado isAuthenticated. Use esse método em uma função de intermediação de exemplo.

Parabéns!

Você aprendeu a usar a extensão de módulos para ampliar ou modificar módulos existentes no TypeScript. Pratique essa habilidade para personalizar bibliotecas de terceiros e aprimorar suas aplicações!