nestjs

library0.0.1jsnpmunverified

NestJS is a progressive, open-source Node.js framework for building efficient, reliable, and scalable server-side applications, released under an MIT License. It leverages TypeScript extensively, combining elements of Object-Oriented Programming (OOP), Functional Programming (FP), and Functional Reactive Programming (FRP) to provide a structured and opinionated development experience. Built on top of robust HTTP server frameworks like Express (default) and Fastify, it provides an out-of-the-box application architecture that helps developers create highly testable, loosely coupled, and easily maintainable applications. The current stable version is 11.1.19, with regular releases bringing new features, bug fixes, and performance enhancements. Key differentiators include its strong adherence to Angular-inspired modularity, dependency injection system, and a rich ecosystem for various application types like REST APIs, GraphQL APIs, and microservices.

web-framework http-networking auth-security database

npm install nestjs

package ↗homepage ↗

INSTALL

IMPORT

SIG · NESTJS

nestjs

web-frameworkjavascriptv0.0.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

NestFactory

✓ import { NestFactory } from '@nestjs/core';

✗ import { NestFactory } from 'nestjs';

Used to create a NestJS application instance, typically in main.ts. The core functionality is separate from common utilities.

Module

✓ import { Module } from '@nestjs/common';

✗ import { Module } from '@nestjs/core';

The `@Module()` decorator is from `@nestjs/common`, not `@nestjs/core`. It defines modules, controllers, and providers.

Controller, Get, Post

✓ import { Controller, Get, Post } from '@nestjs/common';

✗ import { Controller } from '@nestjs/core'; // And other decorators

All fundamental decorators like `@Controller()`, `@Get()`, `@Post()`, `@Injectable()`, etc., are exported from `@nestjs/common`.

This quickstart demonstrates a basic NestJS application with a service, controller, and module, showcasing dependency injection and routing. It creates a simple CRUD API for 'items', listening on port 3000.

import { NestFactory } from '@nestjs/core'; import { Module, Controller, Get, Post, Body, Param, HttpStatus, HttpException, Injectable } from '@nestjs/common'; // 1. Define a Service (Provider) @Injectable() class AppService { private items: { id: number; name: string }[] = []; constructor() { this.items.push({ id: 1, name: 'Item 1' }); } getAllItems(): { id: number; name: string }[] { return this.items; } getItemById(id: number): { id: number; name: string } | undefined { return this.items.find(item => item.id === id); } createItem(name: string): { id: number; name: string } { const newItem = { id: Date.now(), name }; this.items.push(newItem); return newItem; } } // 2. Define a Controller @Controller('items') class AppController { constructor(private readonly appService: AppService) {} @Get() getAllItems(): { id: number; name: string }[] { return this.appService.getAllItems(); } @Get(':id') getItem(@Param('id') id: string): { id: number; name: string } { const foundItem = this.appService.getItemById(parseInt(id, 10)); if (!foundItem) { throw new HttpException('Item not found', HttpStatus.NOT_FOUND); } return foundItem; } @Post() createItem(@Body('name') name: string): { id: number; name: string } { if (!name) { throw new HttpException('Name is required', HttpStatus.BAD_REQUEST); } return this.appService.createItem(name); } } // 3. Define the Root Module @Module({ imports: [], controllers: [AppController], providers: [AppService], }) class AppModule {} // 4. Bootstrap the Application async function bootstrap() { const app = await NestFactory.create(AppModule); await app.listen(process.env.PORT ?? 3000); console.log(`Application is running on: http://localhost:${process.env.PORT ?? 3000}`); } bootstrap();

Debug

Known issues

breakingNestJS v10 dropped support for Node.js v12. Applications must run on Node.js v16 or higher.

fix

Upgrade your Node.js environment to version 16 or newer. Update your package.json `engines` field.

affects: >=10.0.0

breakingThe `CacheModule` was moved from `@nestjs/common` to a standalone package `@nestjs/cache-manager` in v10.

fix

Install `@nestjs/cache-manager` and `cache-manager` packages (`npm i @nestjs/cache-manager cache-manager`). Update imports from `@nestjs/common` to `@nestjs/cache-manager` for `CacheModule`.

affects: >=10.0.0

breakingNestJS CLI plugins (for `@nestjs/swagger` and `@nestjs/graphql`) require TypeScript >= v4.8 since v10 due to AST breaking changes.

fix

Ensure your project uses TypeScript v4.8 or higher. Update your `typescript` dependency in `package.json`.

affects: >=10.0.0

breakingNestJS v11 defaults to Express v5, which includes breaking changes in its path route matching algorithm, particularly for wildcards (`*`) and optional characters (`?`).

fix

Review Express v5 migration guides, specifically regarding route syntax. Wildcards now require names (e.g., `/*splat` instead of `/*`), and optional segments use braces (`/:file{.:ext}`).

affects: >=11.0.0

gotchaCircular dependencies can occur in NestJS modules and providers, leading to cryptic error messages and runtime issues.

fix

Use `forwardRef()` for modules or services when a circular dependency is unavoidable. Refactor your application design to reduce coupling if possible.

affects: >=4.0.0

gotchaForgetting to apply `@Injectable()` to a provider (service) or including it in a module's `providers` array will prevent dependency injection from working, resulting in `Can't resolve dependencies` errors.

fix

Always decorate services with `@Injectable()` and ensure they are listed in the `providers` array of their respective module. If the service is used in another module, it must also be in the `exports` array of its defining module and the `imports` array of the consuming module.

affects: >=4.0.0

Errors

Common errors & fixes

Nest can't resolve dependencies of the [Service Name] (?). Please make sure that the argument [Dependency Name] at index [index] is available in the [Module Name] context.

A provider (service) or controller attempts to inject a dependency that is not available in its module's `providers` array, or the dependency's module has not been imported or exported correctly.

fix

1. Ensure the dependency class is decorated with `@Injectable()`. 2. Add the dependency to the `providers` array of the current module. 3. If the dependency is from another module, ensure that module exports the dependency, and the current module imports that module.

Error: Nest circular dependency detected

Two or more modules or providers have a direct or indirect dependency on each other, forming a cycle.

fix

Use `forwardRef(() => MyModule)` when importing modules or `forwardRef(() => MyService)` when injecting providers in a constructor to break the circular dependency. Consider refactoring to reduce tight coupling.

SyntaxError: Cannot use import statement outside a module

Although NestJS code uses ESM `import` syntax, the transpiled output typically runs as CommonJS. This error can occur if a third-party library is truly ESM-only and NestJS's build configuration doesn't handle it, or if you're trying to use `require()` for a module that NestJS compiles as ESM.

fix

Ensure your `tsconfig.json` `module` option is set to `CommonJS` for Node.js environments. For ESM-only dependencies, you might need to configure your build tool (e.g., Webpack, SWC) to transpile them correctly, or configure Node.js to run in ESM mode (which requires specific NestJS setup). NestJS 10+ targets ES2021 by default.

TypeError: Cannot read properties of undefined (reading 'create')

Often occurs when `NestFactory.create` is called with an `AppModule` that is `undefined`, usually due to an incorrect import path or a forgotten `export` statement for `AppModule`.

fix

Verify that `AppModule` is correctly imported in `main.ts` (e.g., `import { AppModule } from './app.module';`) and that `AppModule` class is `exported` from its file.

Upgrade

Version history

0.0.1latest on npm

Audit

Dependencies

@nestjs/platform-expressoptionalDefault HTTP server platform, often implicitly used.

reflect-metadatarequiredRequired for decorators and TypeScript-based dependency injection. Must be imported once at the application's entry point.

rxjsoptionalUsed for reactive programming patterns, especially with Interceptors and Guards.

Agent activity

15 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://www.npmjs.com/package/nestjs ↗

homepagehttps://nestjs.com ↗