Tipagem do process.env com TypeScript

360d atrás

Ion

---

0 0

O objeto proccess.env guarda as variáveis de ambiente de uma aplicação #NodeJS. Muitas vezes, é interessante ter a definição de tipos desse objeto, para manter a confiabilidade e segurança do código e melhorar a experiência de desenvolvimento.

Pré-requisitos

Ter um projeto com TypeScript devidamente configurado. E certificar de ter o @types/node instalado:

npm i -D @types/node

Criar arquivo de declaração global

Agora precisamos criar um arquivo global para declaração de tipos no diretório root do projeto #TypeScript, por exemplo, crie um arquivo src/global.d.ts.

Agora, dentro do namespace NodeJS, vamos definir os tipos da interface ProcessEnv:

declare namespace NodeJS {
  interface ProcessEnv {
    DATABASE_URL: string;
    ENV: 'DEV' | 'PROD';
    SECRET: string;
  }
}

Você pode definir quantas propriedades forem necessárias dentro de ProcessEnv, nós definimos: DATABASE_URL, ENV e SECRET.

Agora, em todo o seu código process.env vai ter a tipagem definida.