How can you use TypeScript with server-side frameworks like Express.js or NestJS?

TypeScript is a superset of JavaScript that allows you to write statically-typed code. It can be seamlessly integrated with server-side frameworks like Express.js or NestJS. In this answer, I will provide a detailed explanation of how to use TypeScript with these frameworks, including a basic setup and configuration.

1. Express.js with TypeScript:

To use TypeScript with Express.js, you need to follow these steps:

Step 1: Install the required packages:

You need to install ‘typescript‘, ‘@types/express‘, ‘@types/node‘, and ‘ts-node‘ as development dependencies. Run the following command to do so:

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

Step 2: Initialize a TypeScript project:

Create a ‘tsconfig.json‘ file in your project’s root folder and include the following configuration:

{
  "compilerOptions": {
    "target": "es6",
    "module": "commonjs",
    "outDir": "./built",
    "sourceMap": true,
    "esModuleInterop": true,
    "strict": true
  },
  "include": ["src/**/*.ts"],
  "exclude": ["node_modules"]
}

This configures TypeScript to compile your code into the ‘./built‘ folder using the ES6 target and CommonJS module system.

Step 3: Write your Express.js application using TypeScript:

Create an ‘src‘ folder in your project’s root folder and create a ‘server.ts‘ file inside it. Write your Express.js application using TypeScript:

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

const app = express();
const port = 3000;

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

app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

Step 4: Update your ‘package.json‘ scripts:

Add the following scripts to your ‘package.json‘:

"scripts": {
  "start": "ts-node src/server.ts",
  "build": "tsc",
  "serve": "node built/server.js"
}

Now you can run the following commands:

- ‘npm start‘: Run your TypeScript Express.js application directly.

- ‘npm run build‘: Compile your TypeScript code into the ‘./built‘ folder.

- ‘npm run serve‘: Run the compiled JavaScript Express.js application from the ‘./built‘ folder.

2. NestJS with TypeScript:

NestJS is a framework that’s built with TypeScript by default, so there isn’t a separate setup process needed. Just follow these steps:

Step 1: Install the NestJS CLI:

npm install -g @nestjs/cli

Step 2: Create a new NestJS project:

nest new project-name

Replace ‘project-name‘ with your desired project name.

Step 3: Run the NestJS application:

Navigate to the newly created folder and run the following command:

npm run start:dev

This will run your NestJS application in development mode with TypeScript.

So, integrating TypeScript with server-side frameworks like Express.js and NestJS is straightforward. It significantly improves code maintainability, enables autocompletion, and provides better error handling possibilities.