0Pricing
Node.js Backend Development Bootcamp · Aula

Configuração do tsconfig para Projetos de Servidor Node

Ajuste as opções do compilador, a resolução de módulos e os aliases de caminhos para uma configuração robusta de TypeScript no servidor.

Configuração do tsconfig para Projetos de Servidor Node é uma aula grátis de Node.js Backend Development Bootcamp no CoddyKit. Esta é a aula 2 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de Node.js Backend Development Bootcamp, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de Node.js Backend Development Bootcamp inclui 4 aulas no total.

Partes desta aula ainda não foram traduzidas e aparecem em inglês.

Why tsconfig Matters on the Server

When you run TypeScript on a Node.js backend, tsconfig.json is the single source of truth that controls how your code is type-checked and compiled to JavaScript.

  • compilerOptions tune the output, strictness, and module system.
  • include / exclude decide which files are part of the project.

A backend config differs from a frontend one: there is no DOM, no bundler, and Node loads the emitted JavaScript directly. Getting these options right prevents subtle runtime crashes and broken imports.

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "outDir": "dist",
    "rootDir": "src",
    "strict": true
  },
  "include": ["src/**/*"]
}

Picking the Right target

The target option controls which JavaScript version the compiler emits. On a backend you are not constrained by old browsers, only by your Node.js runtime.

  • Node 18 supports up to ES2022; Node 20+ supports ES2023.
  • A modern target means features like top-level await, class fields, and Array.at() compile to native code instead of bulky polyfills.

Match target to the lowest Node version you deploy to. Setting it too high can emit syntax your runtime cannot parse.

// Works natively when target is ES2022 on Node 18+
const nums = [10, 20, 30];
console.log(nums.at(-1)); // 30

class Cache {
  store = new Map(); // class field
  set(k, v) { this.store.set(k, v); return this; }
}
console.log(new Cache().set("a", 1).store.get("a")); // 1

module and moduleResolution

These two options decide how import and require statements are emitted and resolved.

  • module: what kind of module syntax the compiler emits.
  • moduleResolution: how TypeScript finds the files behind each import specifier.

For modern Node backends, "module": "NodeNext" with "moduleResolution": "NodeNext" is the recommended pair. It teaches TypeScript to respect Node's real resolution rules, including the type field in package.json and the difference between CommonJS and ESM.

{
  "compilerOptions": {
    "module": "NodeNext",
    "moduleResolution": "NodeNext"
  }
}

CommonJS vs ESM Decision

The single biggest decision for a Node backend is the module system. It is driven by the type field in package.json, not by tsconfig alone.

  • "type": "commonjs" (or omitted): files use require / module.exports.
  • "type": "module": files are ESM and use import / export.

With ESM you gain top-level await and a single import syntax, but you must write explicit file extensions in relative imports. With CommonJS you get broader compatibility with older libraries. Choose ESM for new projects unless a dependency forces CommonJS.

{
  "name": "my-api",
  "type": "module",
  "main": "dist/index.js"
}

ESM Needs File Extensions

This trips up almost everyone moving to ESM. When module is NodeNext and your package is "type": "module", relative imports in your source must include the .js extension, even though the file on disk ends in .ts.

TypeScript does not rewrite import paths, so the specifier you write is exactly what Node receives at runtime. You write .js because that is the file that will exist after compilation.

// src/user.service.ts
export function findUser(id) {
  return { id, name: "Ada" };
}

// src/index.ts  -- note the .js extension on a .ts file
import { findUser } from "./user.service.js";
console.log(findUser(7));

Turn On strict Mode

"strict": true is the most valuable option for backend reliability. It is an umbrella that enables a family of checks at once.

  • strictNullChecks: null and undefined are no longer assignable everywhere, catching missing-value bugs.
  • noImplicitAny: every value must have a known or inferable type.
  • strictFunctionTypes, strictBindCallApply, and more.

On a server these checks prevent whole classes of production crashes, like reading a property off an object that could be undefined.

function getPort(env) {
  // With strictNullChecks, env.PORT is string | undefined
  const raw = env.PORT;
  const port = raw ? Number(raw) : 3000;
  return port;
}
console.log(getPort({ PORT: "8081" })); // 8081
console.log(getPort({}));               // 3000

outDir, rootDir, and the Build Layout

These options keep your compiled output cleanly separated from your source.

  • rootDir: the base folder of your input files, usually src.
  • outDir: where emitted JavaScript lands, usually dist.

Setting rootDir guarantees the directory structure under src is mirrored exactly under dist. Without it, TypeScript infers the root from your files and a stray file outside src can shift the whole output tree, breaking your main path.

{
  "compilerOptions": {
    "rootDir": "src",
    "outDir": "dist",
    "sourceMap": true,
    "declaration": false
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

Path Aliases with baseUrl and paths

Deep relative imports like ../../../config/db are fragile. Path aliases let you write stable, readable specifiers.

  • baseUrl: the directory from which non-relative imports are resolved.
  • paths: a map of alias patterns to real folders.

A common convention is to map @/* to src/*, so any module can import from @/services/user.service.js regardless of its own depth.

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@/*": ["src/*"]
    }
  }
}

Aliases Don't Exist at Runtime

Here is the critical gotcha: paths only affects type-checking. The TypeScript compiler does not rewrite @/services/user.service.js into a real relative path in the emitted JavaScript.

So Node will fail at runtime with a module-not-found error unless you bridge the gap. Common solutions:

  • A runtime resolver like tsconfig-paths (CommonJS) or a loader.
  • A bundler such as tsup or esbuild that inlines the aliases.
  • A post-build step that rewrites the paths.

Always remember: tsconfig describes types; the runtime needs its own plan for aliases.

Node Types and Speeding Up Builds

To use globals like process, Buffer, and the fs module with full typing, install @types/node and let TypeScript pick them up.

  • types: restrict which global type packages are included (for example, just ["node"]).
  • skipLibCheck: skip type-checking of .d.ts files in dependencies, dramatically cutting build time.
  • esModuleInterop: lets you write import express from "express" for CommonJS default exports.
{
  "compilerOptions": {
    "types": ["node"],
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "resolveJsonModule": true
  }
}

A Complete Backend tsconfig

Putting it all together, here is a robust starting point for a modern ESM Node.js backend. It compiles src to dist, enforces strictness, and uses Node-native resolution.

Pair this with "type": "module" in package.json and a build script of tsc -p tsconfig.json. Remember to handle path aliases at runtime if you enable paths.

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "rootDir": "src",
    "outDir": "dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "resolveJsonModule": true,
    "sourceMap": true,
    "types": ["node"],
    "baseUrl": ".",
    "paths": { "@/*": ["src/*"] }
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

Quick Check

Test your understanding of path aliases in a Node backend build.

Recap

You now know how to configure tsconfig.json for a server-side TypeScript project.

  • target: match your lowest Node version (ES2022 for Node 18+).
  • module / moduleResolution: use NodeNext for honest Node resolution.
  • type field in package.json drives CommonJS vs ESM; ESM relative imports need .js extensions.
  • strict: turn it on to catch null and any bugs before production.
  • rootDir / outDir: keep a clean src to dist build layout.
  • paths: great for readability, but aliases must be resolved at runtime by a loader or bundler.

With these options dialed in, your Node backend gets reliable type safety and a predictable build.

Perguntas Frequentes

A aula “Configuração do tsconfig para Projetos de Servidor Node” é grátis?

Sim — o texto completo de “Configuração do tsconfig para Projetos de Servidor Node” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de Node.js Backend Development Bootcamp, atualize para CoddyKit PRO. O curso de Node.js Backend Development Bootcamp inclui 4 aulas no total.

O que vou aprender em “Configuração do tsconfig para Projetos de Servidor Node”?

Ajuste as opções do compilador, a resolução de módulos e os aliases de caminhos para uma configuração robusta de TypeScript no servidor. Você pratica Node.js Backend Development Bootcamp com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.

Preciso ter experiência prévia para começar Node.js Backend Development Bootcamp?

Nenhuma experiência prévia é necessária. Node.js Backend Development Bootcamp no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 2 de 4.

Quanto tempo leva a aula “Configuração do tsconfig para Projetos de Servidor Node”?

A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.

Posso escrever e executar código nesta aula de Node.js Backend Development Bootcamp?

Sim. Cada aula de Node.js Backend Development Bootcamp inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.

Todas as aulas deste curso

  1. Migração de CommonJS para Módulos ES Nativos
  2. Configuração do tsconfig para Projetos de Servidor Node
  3. Configuração de Ambiente Segura quanto aos Tipos e Validação em Execução
  4. Iteração Rápida com tsx, Recarga Automática e Mapas de Origem
← Voltar para Node.js Backend Development Bootcamp