В чем разница между require(x) и import x в TypeScript и Node.js?

Основные различия между require и import

Главное различие между require и import в TypeScript/Node.js заключается в системе модулей, к которой они относятся. require — это часть CommonJS (CJS), которая использовалась в Node.js по умолчанию до версии 13. import — это часть ES-модулей (ESM), современного стандарта JavaScript для работы с модулями.

Ключевые отличия

• Синтаксис и статичность: import — статический, выполняется на этапе компиляции. require — динамический, может вызываться в любом месте кода.
• Типизация в TypeScript: import полностью поддерживает систему типов TypeScript. require часто возвращает any, если не настроены специальные декларации типов.
• Tree-shaking: import позволяет сборщикам (Webpack, Vite) удалять неиспользуемый код. require этого не поддерживает.
• Асинхронность: import() (динамический импорт) возвращает Promise, что удобно для ленивой загрузки. require — синхронный.

Примеры кода

Статический импорт (рекомендуемый способ):

// ✅ Правильно для TypeScript
import { readFile, writeFile } from 'fs/promises';
import express from 'express';

// TypeScript знает типы express и fs
const app = express();
app.get('/', async (req, res) => {
  const data = await readFile('./file.txt', 'utf-8');
  res.send(data);
});

Динамический импорт для ленивой загрузки:

// ✅ Используйте import() для динамической загрузки
async function loadModule(moduleName: string) {
  const module = await import(`./modules/${moduleName}`);
  return module.default;
}

// Используйте только когда модуль реально нужен
const logger = await loadModule('logger');

Проблема с require и типами:

// ❌ Так делать не стоит в TypeScript
const fs = require('fs');
// fs будет иметь тип any — теряется автодополнение и проверка типов

// ✅ Лучше использовать import или настроить типы
import fs from 'fs'; // fs имеет полную типизацию

Когда использовать require?

require может быть полезен в следующих случаях:

• В старых проектах на CommonJS, которые вы не хотите полностью переписывать.
• В скриптах конфигурации (например, webpack.config.js), которые выполняются в среде Node.js без TypeScript.
• Когда нужно динамически загрузить модуль на основе условия (хотя для этого лучше использовать import()).

Настройка проекта для использования import

Чтобы использовать import в Node.js с TypeScript, убедитесь, что в вашем tsconfig.json указано:

{
  "compilerOptions": {
    "module": "ESNext",        // или "ES2020", "ES2022"
    "moduleResolution": "node",
    "esModuleInterop": true,   // важно для совместимости с CommonJS
    "allowSyntheticDefaultImports": true
  }
}

Также в package.json добавьте "type": "module", чтобы Node.js понимал ES-модули.

Итог

В 2024 году для TypeScript-проектов рекомендуется использовать import — это современный стандарт, который дает лучшую типизацию, поддержку tree-shaking и совместимость с большинством инструментов. require оставьте для legacy-кода или специфических случаев, когда динамическая загрузка действительно необходима.