Problems with nodejs + koa + typescript integration and automatic restart

Version Notes

Node.js: 16.13.1

Create a project

Create the following directory structure

project
├── src
│ └── server.ts
├── package.json
└── tsconfig.json

package.json can be generated using yarn init -y
tsconfig.json can be generated using tsc --init ( typescript package needs to be installed globally or in the project to use the tsc command)

Install Dependencies

Notice:

• The @tsconfig/node16 package needs to change according to the version of Node.js The version installed on my computer is 16.xx , so I use @tsconfig/node16 . Please refer to the instructions in tsconfig/bases for details. Of course, you don’t need to install this package at all. The advantages of this package are public availability and mainstream recommended configuration.
• If typescript has been installed globally, remove it from the command below
• concurrently is a toolkit for executing multiple commands concurrently
• nodemon is a toolkit that monitors file changes and automatically restarts programs

yarn add koa
yarn add typescript @tsconfig/node16 @types/node @types/koa concurrently nodemon -D

Filling content

src/server.ts

import Koa from 'koa';

const server: Koa = new Koa();
const port: number = 3000;

server.use((ctx: Koa.DefaultContext) => {
    ctx.body = 'hi koa';
});

server.listen(port, () => {
    console.log(`Node.js v${process.versions.node}`);
});

tsconfig.json

Note: The value of the extends field is replaced according to the package name you installed @tsconfig/node**

{
  "extends": "@tsconfig/node16/tsconfig.json",
  "compilerOptions": {
    "baseUrl": ".",
    "rootDir": "src",
    "outDir": "dist",
    "noImplicitAny": true,
  },
  "include": [
    "src/**/*"
  ]
}

package.json

"scripts": {
  "build-ts": "tsc",
  "build": "yarn build-ts",
  "debug": "yarn build && yarn watch-debug",
  "serve-debug": "nodemon --inspect dist/server.js",
  "serve": "node dist/server.js",
  "start": "yarn serve",
  "watch-debug": "concurrently -k -p \"[{name}]\" -n \"TypeScript,Node\" -c \"yellow.bold,cyan.bold,green.bold\" \"npm:watch-ts\" \"npm:serve-debug\"",
  "watch-node": "nodemon dist/server.js",
  "watch-ts": "tsc -w",
  "watch": "concurrently -k -p \"[{name}]\" -n \"TypeScript,Node\" -c \"yellow.bold,cyan.bold,green.bold\" \"npm:watch-ts\" \"npm:watch-node\""
}

run

All our source code is in the src directory, and js files compiled by tsc are in dist directory, which is the path specified in the tsconfig.json file

Local development: If there is no dist directory, you need to execute yarn build to compile and generate, and then execute yarn watch

Deployment production: execute yarn build , yarn serve or yarn start in sequence (serve and start are the same command)

References

microsoft/TypeScript-Node-Starter

This is the end of this article about nodejs + koa + typescript integration and automatic restart. For more related nodejs koa typescript content, please search for previous articles on 123WORDPRESS.COM or continue to browse the following related articles. I hope you will support 123WORDPRESS.COM in the future!