Instalando

Antes de começar, certifique-se de ter Node.js 18 ou superior instalado. Em seguida, crie um diretório para a sua aplicação e navegue até ele.

mkdir myapp
cd myapp

Use o comando npm init para criar um arquivo package.json para sua aplicação. Para obter mais informações sobre como funciona o arquivo package.json, veja Especificações da manipulação do package.json do npm.

npm init

yarn init

pnpm init

bun init

Este comando avisa você para várias coisas, como o nome e a versão de seu aplicativo. Por enquanto, você simplesmente pode clicar em RETURN para aceitar os padrões para a maioria deles, com a seguinte exceção:

entry point: (index.js)

Digite app.js, ou o que quiser que o nome do arquivo principal seja. Se você quer que seja index.js, pressione RETURN para aceitar o nome de arquivo padrão sugerido.

Agora, instale o Express no diretório myapp e salve-o na lista de dependências. Por exemplo:

npm install express

yarn add express

pnpm add express

bun add express

Para instalar o Express temporariamente e não adicioná-lo à lista de dependências:

npm install express --no-save

bun add express --no-save

TypeScript

Express is written in JavaScript and does not bundle its own type definitions. To use it with TypeScript, install TypeScript together with the community-maintained types for Express and Node.js (from DefinitelyTyped) as development dependencies:

npm install --save-dev typescript @types/express @types/node

yarn add --dev typescript @types/express @types/node

pnpm add --save-dev typescript @types/express @types/node

bun add --dev typescript @types/express @types/node

Add a tsconfig.json. These options mirror how Node.js runs TypeScript and make the compiler reject non-erasable syntax (such as enums, namespaces, and parameter properties) that Node cannot strip:

{
  "compilerOptions": {
    "target": "esnext",
    "module": "nodenext",
    "rewriteRelativeImportExtensions": true,
    "erasableSyntaxOnly": true,
    "verbatimModuleSyntax": true,
    "noEmit": true,
    "strict": true,
    "skipLibCheck": true
  }
}

Write your application in TypeScript, annotating the request and response objects:

import express, { type Express, type Request, type Response } from 'express';

const app: Express = express();

app.get('/', (req: Request, res: Response) => {
  res.send('Hello World!');
});

app.listen(3000);

You do not need to annotate everything. When you pass a handler directly to a route method or to app.use(), Express infers the types of req, res, and next, and it infers route parameters from the path, so req.params.id is a string in app.get('/users/:id', ...). Add explicit types only where TypeScript has no context to infer from: error-handling middleware, whose (err, req, res, next) signature is not inferred, and handlers you define separately from the route. In those cases, annotate the parameters or type the whole function as RequestHandler or ErrorRequestHandler.

Run the file directly with Node.js, which strips the TypeScript types and runs the result without a build step:

node src/app.ts