re:re:actable
Урок 032 минуты чтения

Как создать Express-проект на TypeScript?

На этой странице
Кратко

Для учебного проекта достаточно Express, TypeScript, типов для Node.js и Express, а также tsx для удобного запуска TypeScript во время разработки.

Вопрос

Как с нуля создать Express-проект на TypeScript? Какие пакеты, скрипты и настройки tsconfig нужны?

Создание проекта

mkdir express-api
cd express-api
npm init -y

Установим обычные зависимости:

npm install express dotenv

Установим средства разработки:

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

Express написан на JavaScript, поэтому его описания типов устанавливаются отдельным пакетом @types/express.

package.json

{
  "name": "express-api",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "scripts": {
    "dev": "tsx watch src/server.ts",
    "type-check": "tsc --noEmit",
    "build": "tsc",
    "start": "node dist/server.js"
  }
}

"type": "module" включает ES-модули с import и export.

tsconfig.json

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "rootDir": "src",
    "outDir": "dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "noUncheckedIndexedAccess": true
  },
  "include": ["src"]
}

Почему локальные импорты заканчиваются на .js

При module: "NodeNext" в TypeScript пишут расширение будущего JavaScript-файла:

import { app } from "./app.js";

Исходный файл при этом называется app.ts. После сборки он станет app.js, и Node.js сможет найти его без особых правил.

Первая структура

express-api/
├── src/
│   ├── app.ts
│   └── server.ts
├── .env
├── .gitignore
├── package.json
└── tsconfig.json

.gitignore

node_modules/
dist/
.env

Файл .env может содержать пароль базы данных, поэтому его нельзя отправлять в репозиторий.

Проверка

npm run type-check
npm run dev

Современный Node.js умеет запускать часть TypeScript напрямую, но tsx остаётся понятным вариантом для разработки и автоматически перезапускает сервер после изменения файлов.

Что важно помнить

  • Типы Express ставятся отдельно: @types/express и @types/node.
  • С module: "NodeNext" локальные импорты пишутся с расширением .js, даже если исходник — .ts.
  • tsx watch только запускает код и не проверяет типы — для этого отдельный скрипт tsc --noEmit.
  • .env, dist и node_modules добавляются в .gitignore с первого коммита.

Мини-шпаргалка

  • express — сам фреймворк.
  • @types/express — типы Express.
  • tsx watch перезапускает сервер при изменениях.
  • tsc проверяет типы и создаёт JavaScript.
  • ES-модули включаются через "type": "module".
  • Локальные импорты с NodeNext пишутся с расширением .js.

Документация

Express: Installing, Express: Hello world, TypeScript: Choosing compiler options, tsx.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам