Skip to content
⚠️ This article was written in 2020. Some content may be outdated.

NestJS: Introduction to Enterprise Node.js Framework

When it comes to getting started with NestJS—an enterprise-grade Node.js framework—many developers only stay at the API-call level. This article tries to approach it from a production angle, discussing the real problems you'll face and how to solve them.

Basic Principles ​

Let's start with the basic implementation:

javascript
const express = require('express')
const app = express()

app.use(express.json())

class AppError extends Error {
  constructor(status, message) {
    super(message); this.statusCode = status
  }
}

const asyncHandler = (fn) => (req, res, next) =>
  Promise.resolve(fn(req, res, next)).catch(next)

app.get('/api/users/:id', asyncHandler(async (req, res) => {
  const user = await User.findById(req.params.id)
  if (!user) throw new AppError(404, '用户不存在')
  res.json({ data: user })
}))

This snippet shows the basic usage. In a real project, you'll also need to handle errors and edge cases.

Advanced Features ​

Building on that, we can optimize further:

javascript
const fs = require('fs')
const { Transform, pipeline } = require('stream')
const { promisify } = require('util')
const pipelineAsync = promisify(pipeline)

const csvToJson = new Transform({
  transform(chunk, encoding, callback) {
    const lines = chunk.toString().split('\n')
    const headers = lines[0].split(',')
    for (let i = 1; i < lines.length; i++) {
      if (!lines[i].trim()) continue
      const values = lines[i].split(',')
      const obj = {}
      headers.forEach((h, idx) => obj[h.trim()] = values[idx]?.trim())
      this.push(JSON.stringify(obj) + '\n')
    }
    callback()
  }
})

This pattern is especially handy in large projects, and it noticeably cuts maintenance cost.

Project Practice ​

In a real project, the usage gets a bit more involved:

javascript
const express = require('express')
const app = express()

app.use(express.json())

class AppError extends Error {
  constructor(status, message) {
    super(message); this.statusCode = status
  }
}

const asyncHandler = (fn) => (req, res, next) =>
  Promise.resolve(fn(req, res, next)).catch(next)

app.get('/api/users/:id', asyncHandler(async (req, res) => {
  const user = await User.findById(req.params.id)
  if (!user) throw new AppError(404, '用户不存在')
  res.json({ data: user })
}))

This way, the code becomes both more testable and more extensible.

Best Practices ​

Here is a complete example:

javascript
const fs = require('fs')
const { Transform, pipeline } = require('stream')
const { promisify } = require('util')
const pipelineAsync = promisify(pipeline)

const csvToJson = new Transform({
  transform(chunk, encoding, callback) {
    const lines = chunk.toString().split('\n')
    const headers = lines[0].split(',')
    for (let i = 1; i < lines.length; i++) {
      if (!lines[i].trim()) continue
      const values = lines[i].split(',')
      const obj = {}
      headers.forEach((h, idx) => obj[h.trim()] = values[idx]?.trim())
      this.push(JSON.stringify(obj) + '\n')
    }
    callback()
  }
})

Mind the edge-case handling—that's critical in production.

Summary ​

  • Getting started with NestJS—an enterprise-grade Node.js framework—isn't a silver bullet; choose it based on your project's scale and tech stack.
  • Understanding the underlying principles matters more than memorizing the API.
  • Before using it in production, be sure to verify compatibility.

MIT Licensed