NestJS

https://docs.nestjs.com/
Admin
NestJS is a progressive Node.js framework for building efficient, reliable, and scalable server-side...
Tokens:790,959
Snippets:5,318
Trust Score:9.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### Clone and start TypeScript starter project with Git

Source: https://docs.nestjs.com/application/application/logger

Clones the Nest TypeScript starter repository, installs project dependencies, and starts the development server. Replace the repository URL with javascript-starter.git for plain JavaScript.

```bash

$ git clone https://github.com/nestjs/typescript-starter.git project
$ cd project
$ npm install
$ npm run start

```

--------------------------------

### Install @nestjs/microservices

Source: https://docs.nestjs.com/microservices/basics

Install the @nestjs/microservices package to start building microservices.

```bash
$ npm i --save @nestjs/microservices
```

--------------------------------

### Run npm run start

Source: https://docs.nestjs.com/cli/scripts

Runs the start script defined in package.json, which executes the locally installed nest binary's start command. This is the recommended way to start a Nest application to ensure all developers use the same version of the CLI.

```bash
$ npm run start
```

--------------------------------

### Install @nestjs/webhooks

Source: https://docs.nestjs.com/http/webhooks

Install the @nestjs/webhooks package to get started with the webhooks tutorial.

```bash
$ npm i --save @nestjs/webhooks
```

--------------------------------

### Install and register @fastify/helmet with Fastify

Source: https://docs.nestjs.com/security/helmet

Install @fastify/helmet for Fastify and register it as a plugin with app.register(). It is a Fastify plugin, not middleware, so it must be registered before other calls to app.use() or setup functions that may call app.use().

```bash
$ npm i @fastify/helmet
```

```typescript
// main.ts
import helmet from '@fastify/helmet';

await app.register(helmet);
```

--------------------------------

### Install @fastify/compress

Source: https://docs.nestjs.com/http/compression

Install the @fastify/compress plugin for Fastify.

```bash
$ npm i --save @fastify/compress
```

--------------------------------

### nest info command and example output

Source: https://docs.nestjs.com/cli/usages

Displays information about installed Nest packages and system details. The output includes OS, Node, NPM versions, Nest CLI version, and platform package versions.

```bash
$ nest info
```

```bash
 _   _             _      ___  _____  _____  _     _____
| \ | |           | |    |_  |/  ___|/  __ \| |   |_   _|
|  \| |  ___  ___ | |_     | |\ `--. | /  \/| |     | |
| . ` | / _ \/ __|| __|    | | `--. \| |    | |     | |
| |\  ||  __/\__ \| |_ /\__/ //\__/ /| \__/\| |_____| |_
\_| \_/ \___||___/ \__|\____/ \____/  \____/\_____/\___/

[System Information]
OS Version     : macOS Sequoia 24.6.0
NodeJS Version : v22.12.0
NPM Version    : 10.9.0

[Nest CLI]
Nest CLI Version : 12.0.3

[Nest Platform Information]
platform-express version : 12.0.4
schematics version       : 12.0.4
testing version          : 12.0.4
common version           : 12.0.4
core version             : 12.0.4
cli version              : 12.0.3
```

--------------------------------

### Start Nest with SWC builder and type checking

Source: https://docs.nestjs.com/graphql/cli-plugin

For standard (non-monorepo) setups, using CLI plugins with the SWC builder requires type checking to be enabled.

```bash
$ nest start -b swc --type-check
```

--------------------------------

### Start a specific project

Source: https://docs.nestjs.com/cli/monorepo

Run `nest start my-app` to start the `my-app` project explicitly.

```bash
$ nest start my-app
```

--------------------------------

### Start the default project

Source: https://docs.nestjs.com/cli/monorepo

Run `nest start` without a project name to start the default project, which is the original `my-project` app in the monorepo structure.

```bash
$ nest start
```

--------------------------------

### Start NestJS REPL with npm run start -- --entryFile repl

Source: https://docs.nestjs.com/recipes/repl

Starts the NestJS application in REPL mode using the repl.ts entry file.

```bash
$ npm run start -- --entryFile repl
```

--------------------------------

### YAML configuration file example

Source: https://docs.nestjs.com/application/configuration

Example configuration in YAML format, showing nested database settings.

```yaml
http:
  host: 'localhost'
  port: 8080

db:
  postgres:
    url: 'localhost'
    port: 5432
    database: 'yaml-db'

  sqlite:
    database: 'sqlite.db'
```

--------------------------------

### Startup logs: Outbox and Webhooks storage

Source: https://docs.nestjs.com/http/webhooks

Example log output at startup showing the storage implementations and schema migrations for the outbox and webhooks modules.

```bash
[Nest] 55905  - 09/30/2026, 6:52:36 PM     LOG [OutboxModule] OutboxStorage: PostgresOutboxStore
[Nest] 55905  - 09/30/2026, 6:52:36 PM     LOG [WebhooksModule] WebhooksStorage: PostgresWebhookStore
[Nest] 55905  - 09/30/2026, 6:52:36 PM     LOG [OutboxModule] PostgresOutboxStore: migrated schema "nest_outbox" to version 1.
[Nest] 55905  - 09/30/2026, 6:52:36 PM     LOG [WebhooksModule] PostgresWebhookStore: migrated schema "nest_webhooks" to version 1.
```

--------------------------------

### nest start command syntax

Source: https://docs.nestjs.com/cli/usages

Shows the basic syntax for the `nest start` command, including the optional project name and options.

```bash
$ nest start [name] [options]
```

--------------------------------

### Install @mercuriusjs/gateway dependency

Source: https://docs.nestjs.com/graphql/federation

Command to install the required gateway package for the federated gateway example.

```bash
$ npm install --save @mercuriusjs/gateway
```

--------------------------------

### Install swc-loader for monorepo

Source: https://docs.nestjs.com/recipes/swc

Install `swc-loader` as a dev dependency to use SWC with webpack in a monorepo setup.

```bash
$ npm i --save-dev swc-loader
```

--------------------------------

### Start application with STORAGE_SIGNING_KEY

Source: https://docs.nestjs.com/application/file-storage

Generates a 32-byte hex signing key and starts the application. Run this in a working directory containing test asset files.

```bash
$ export STORAGE_SIGNING_KEY=$(openssl rand -hex 32)
$ npm run start
```

--------------------------------

### Install @keyv/redis and cacheable packages

Source: https://docs.nestjs.com/data/caching

Install the required packages to use Redis and in-memory cache stores with Keyv.

```bash
$ npm install @keyv/redis cacheable
```

--------------------------------

### Install @nestjs/websockets and @nestjs/platform-socket.io

Source: https://docs.nestjs.com/websockets/gateways

Install the required packages to start building WebSockets-based applications with NestJS. This command installs the core WebSockets module and the socket.io platform adapter.

```bash
$ npm i --save @nestjs/websockets @nestjs/platform-socket.io
```

--------------------------------

### Start workflow with priority option

Source: https://docs.nestjs.com/reliability/workflows

Starts the OrderFulfilmentWorkflow with a priority based on shipping method: express orders get priority 1, standard orders get priority 2. Lower priority values run first. Instances without a priority run before prioritized ones.

```typescript
const fulfilment = await this.workflowClient.start(OrderFulfilmentWorkflow, order, {
  id: fulfilmentId(order.id),
  transaction: tx,
  // Lower runs first: express orders before standard ones.
  priority: order.shipping === 'express' ? 1 : 2,
});
```

--------------------------------

### Start application in development mode with .env file

Source: https://docs.nestjs.com/security/authentication

Runs the development server using the environment variables defined in .env.

```bash
$ npm run start:dev -- --env-file .env

```

--------------------------------

### Install Zod for environment variable validation

Source: https://docs.nestjs.com/application/configuration

Install the Zod validation library, which is used in the following examples to define a validation schema for environment variables.

```bash
$ npm install --save zod
```

--------------------------------

### Install @fastify/multipart

Source: https://docs.nestjs.com/http/file-upload

Install the required @fastify/multipart plugin for handling file uploads when using the FastifyAdapter.

```bash
$ npm i @fastify/multipart
```

--------------------------------

### Lazy load CacheModule for GET requests

Source: https://docs.nestjs.com/faq/serverless

Lazily loads a CacheModule and CacheService only for GET requests, reducing cold start time when caching is not needed.

```typescript
if (request.method === RequestMethod[RequestMethod.GET]) {
  const { CacheModule } = await import('./cache.module.js');
  const moduleRef = await this.lazyModuleLoader.load(() => CacheModule);

  const { CacheService } = await import('./cache.service.js');
  const cacheService = moduleRef.get(CacheService);

  return cacheService.get(ENDPOINT_KEY);
}
```

--------------------------------

### Start the application with PostgresWorkflowStore

Source: https://docs.nestjs.com/reliability/workflows

Starts the application with a Postgres-backed workflow store. The log confirms the store in use and that it migrated its schema to version 1.

```bash
$ npm run start:dev
...
[Nest] 33662  - 09/30/2026, 1:28:30 PM     LOG [WorkflowsModule] WorkflowStorage: PostgresWorkflowStore
[Nest] 33662  - 09/30/2026, 1:28:30 PM     LOG [WorkflowsModule] PostgresWorkflowStore: migrated schema "nest_workflows" to version 1.
[Nest] 33662  - 09/30/2026, 1:28:30 PM     LOG [NestApplication] Nest application successfully started +8ms
```

--------------------------------

### Startup logs for OutboxModule

Source: https://docs.nestjs.com/reliability/outbox

Startup logs from the analytics service and order API showing each registered store and the schema migration to version 1.

```bash
[Nest] 52654  - 09/30/2026, 6:45:43 PM     LOG [OutboxModule] OutboxStorage: PostgresOutboxStore
[Nest] 52654  - 09/30/2026, 6:45:43 PM     LOG [OutboxModule] PostgresOutboxStore: migrated schema "nest_outbox" to version 1.
[Nest] 52743  - 09/30/2026, 6:45:59 PM     LOG [OutboxModule] OutboxStorage: PostgresOutboxStore
[Nest] 52743  - 09/30/2026, 6:46:00 PM     LOG [OutboxModule] PostgresOutboxStore: migrated schema "nest_outbox" to version 1.
```

--------------------------------

### Install Nest CLI and create a new project

Source: https://docs.nestjs.com/http/mvc

Scaffold a new Nest application using the Nest CLI. The first command installs the CLI globally, and the second creates a new project.

```bash
$ npm i -g @nestjs/cli
$ nest new project
```

--------------------------------

### Route conflict example: parametric route shadows specific route

Source: https://docs.nestjs.com/controllers

Shows a controller where @Get(':id') shadows @Get('me') because routes are registered in declaration order. The 'me' route is never reached.

```typescript
@Controller('users')
export class UsersController {
  @Get(':id')
  findOne() {}

  @Get('me') // never reached: `:id` matches "me" first
  findMe() {}
}
```

--------------------------------

### Federated gateway: install @apollo/gateway and configure ApolloGatewayDriver

Source: https://docs.nestjs.com/graphql/federation

Gateway setup: install @apollo/gateway and configure ApolloGatewayDriver with IntrospectAndCompose to discover schemas from the listed subgraph endpoints. The gateway implementation is the same for code-first and schema-first approaches.

```bash
$ npm install --save @apollo/gateway
```

```typescript
import { IntrospectAndCompose } from '@apollo/gateway';
import { ApolloGatewayDriver, ApolloGatewayDriverConfig } from '@nestjs/apollo';
import { Module } from '@nestjs/common';
import { GraphQLModule } from '@nestjs/graphql';

@Module({
  imports: [
    GraphQLModule.forRoot<ApolloGatewayDriverConfig>({
      driver: ApolloGatewayDriver,
      server: {
        // ... Apollo Server options
      },
      gateway: {
        supergraphSdl: new IntrospectAndCompose({
          subgraphs: [
            { name: 'users', url: 'http://user-service/graphql' },
            { name: 'posts', url: 'http://post-service/graphql' },
          ],
        }),
      },
    }),
  ],
})
export class AppModule {}
```

--------------------------------

### Install Prisma CLI, Client, and SQLite adapter

Source: https://docs.nestjs.com/data/prisma

Install the Prisma CLI and dotenv as development dependencies, then install Prisma Client and the SQLite driver adapter. Use Prisma ORM 7 explicitly; the latest tag may point to a Prisma 8 pre-release that lacks the prisma migrate and prisma generate commands.

```bash
$ npm install prisma@7 dotenv --save-dev
$ npm install @prisma/client@7 @prisma/adapter-better-sqlite3
```

--------------------------------

### Initialize Prisma with SQLite

Source: https://docs.nestjs.com/data/prisma

Initialize Prisma with SQLite as the datasource provider and output the generated client to ../src/generated/prisma. Prefix with npx to use the project-installed version. Creates prisma/schema.prisma, prisma7.config.ts (or prisma.config.ts for versions before 7.10), and .env, and adds .env and the generated client directory to .gitignore.

```bash
$ npx prisma init --datasource-provider sqlite --output ../src/generated/prisma
```

--------------------------------

### Install Nest CLI globally with npm

Source: https://docs.nestjs.com/cli/overview

Installs the Nest CLI globally using npm. The -g option makes the nest binary available system-wide, and the guide assumes this approach for the rest of the documentation.

```bash
$ npm install -g @nestjs/cli
```

--------------------------------

### Monorepo duplicate package directory structure

Source: https://docs.nestjs.com/faq/common-errors

Shows an example monorepo directory tree containing duplicated @nestjs/core installations.

```text
.
├── package.json
├── apps
│   └── api
│       └── node_modules
│           └── @nestjs/bull
│               └── node_modules
│                   └── @nestjs/core
└── node_modules
    ├── (other packages)
    └── @nestjs/core
```

--------------------------------

### help

Source: https://docs.nestjs.com/recipes/repl

Native REPL function to list all available native functions.

```APIDOC
## help

### Description
Displays all available REPL native functions.

### Method
N/A

### Endpoint
N/A

### Parameters
None

### Request Example
```typescript
help()
```

### Response
N/A
```

--------------------------------

### Throwing HttpException in findAll()

Source: https://docs.nestjs.com/exception-filters

Example of throwing a standard HttpException with a custom message and status code in a GET route handler.

```typescript
@Get()
async findAll() {
  throw new HttpException('Forbidden', HttpStatus.FORBIDDEN);
}
```

--------------------------------

### Create database and run migrations with drizzle-kit

Source: https://docs.nestjs.com/reliability/locks

Creates the PostgreSQL database and applies schema migrations using drizzle-kit.

```bash
$ psql postgres://localhost:5432/postgres -c 'CREATE DATABASE store'
$ DATABASE_URL=postgres://localhost:5432/store npx drizzle-kit migrate

```

--------------------------------

### Clone TypeScript starter repository with Git

Source: https://docs.nestjs.com/application/application/task-scheduling

Clones the official TypeScript starter repository, installs project dependencies, and launches the HTTP server. Substitute with javascript-starter.git for a plain JavaScript project.

```bash
$ git clone https://github.com/nestjs/typescript-starter.git project
$ cd project
$ npm install
$ npm run start
```

--------------------------------

### Client generator result without title

Source: https://docs.nestjs.com/openapi/operations

Example client generator result for the `GET /` endpoint. The return type is ambiguous because it is an inline object type.

```typescript
// Angular
findAll(): Observable<{ total: number, limit: number, offset: number, results: CatDto[] }>
```

--------------------------------

### Create, build, and run a new Nest project

Source: https://docs.nestjs.com/cli/overview

Creates a new Nest project, navigates into its directory, and starts the development server. The new command prompts for a module system: ESM (default, uses Vitest) or CommonJS (uses Jest), both with oxlint. The app runs at http://localhost:3000 and auto-reloads on source changes.

```bash
$ nest new my-nest-project
$ cd my-nest-project
$ npm run start:dev
```

--------------------------------

### Nest application startup logs

Source: https://docs.nestjs.com/http/webhooks

Startup logs showing the Outbox and Webhooks stores using Postgres, schema migrations to version 1, and successful Nest application start.

```bash
[Nest] 55905  - 09/30/2026, 6:52:36 PM     LOG [OutboxModule] OutboxStorage: PostgresOutboxStore
[Nest] 55905  - 09/30/2026, 6:52:36 PM     LOG [WebhooksModule] WebhooksStorage: PostgresWebhookStore
[Nest] 55905  - 09/30/2026, 6:52:36 PM     LOG [OutboxModule] PostgresOutboxStore: migrated schema "nest_outbox" to version 1.
[Nest] 55905  - 09/30/2026, 6:52:36 PM     LOG [WebhooksModule] PostgresWebhookStore: migrated schema "nest_webhooks" to version 1.
[Nest] 55905  - 09/30/2026, 6:52:36 PM     LOG [NestApplication] Nest application successfully started +2ms
```

--------------------------------

### Versioned workflow with @Workflow decorator

Source: https://docs.nestjs.com/reliability/workflows

Example of creating a new workflow version (version 2) when inserting a step before an existing one. The new class must be registered alongside the old one; instances keep their started version and new instances start on the highest registered version.

```typescript
@Workflow('order-fulfilment', {
  version: 2,
  // The limits of the highest registered version apply to every version: keep them.
  concurrency: { limit: 1, key: (order: Order) => order.userId },
  rateLimit: { max: 10, duration: '1s' },
})
export class OrderFulfilmentWorkflowV2 implements WorkflowRunner<Order, FulfilmentResult> {
  // ...same constructor as version 1

  async run(ctx: WorkflowContext, order: Order): Promise<FulfilmentResult> {
    const charge = await ctx.step(
      'charge-payment',
      // ...unchanged
    );
    ctx.setStatus('paid');

    await ctx.step('send-order-confirmation', ({ idempotencyKey }) =>
      this.mailService.sendOrderConfirmation(order, idempotencyKey),
    );

    // ...the rest is unchanged from version 1
  }
}
```

--------------------------------

### Route wildcard with @Get('abcd/*')

Source: https://docs.nestjs.com/controllers

Uses an asterisk wildcard at the end of a route path to match any route starting with 'abcd/'. The hyphen and dot are literal in string-based paths.

```typescript
@Get('abcd/*')
findAll() {
  return 'This route uses a wildcard';
}
```

--------------------------------

### List Nest CLI commands with nest --help

Source: https://docs.nestjs.com/cli/overview

Lists all available commands for the Nest CLI. Run this after installation to see the full set of commands.

```bash
$ nest --help
```

--------------------------------

### Example response for GET /orders/999 with x-lang: pl

Source: https://docs.nestjs.com/application/i18n

Shows the JSON response returned when the order is not found and the request has the x-lang: pl header. The message is translated to Polish.

```json
{
  "message": "Nie znaleziono zamówienia #999.",
  "error": "Not Found",
  "statusCode": 404
}
```

--------------------------------

### Get and override metadata with getAllAndOverride

Source: https://docs.nestjs.com/fundamentals/execution-context

Uses getAllAndOverride to return the first defined value from the provided targets in order. In the example, running in the create() method context results in roles containing ['admin'].

```typescript
const roles = this.reflector.getAllAndOverride(Roles, [context.getHandler(), context.getClass()]);
```

--------------------------------

### Test with ClsService#runWith

Source: https://docs.nestjs.com/recipes/async-local-storage

In integration tests, wrap context-aware code with cls.runWith to provide hand-crafted store values. This example shows a full test setup using ClsModule and mocking CatsRepository.

```ts
describe('CatsService', () => {
  let service: CatsService
  let cls: ClsService
  const mockCatsRepository = createMock<CatsRepository>()

  beforeEach(async () => {
    const module = await Test.createTestingModule({
      // Set up most of the testing module as we normally would.
      providers: [
        CatsService,
        {
          provide: CatsRepository,
          useValue: mockCatsRepository,
        }
      ],
      imports: [
        // Import the static version of ClsModule which only provides
        // the ClsService, but does not set up the store in any way.
        ClsModule
      ],
    }).compile()

    service = module.get(CatsService)

    // Also retrieve the ClsService for later use.
    cls = module.get(ClsService)
  })

  describe('getCatForUser', () => {
    it('retrieves cat based on user id', async () => {
      const expectedUserId = 42
      mockCatsRepository.getForUser.mockImplementationOnce(
        (id) => ({ userId: id })
      )

      // Wrap the test call in the `runWith` method
      // in which we can pass hand-crafted store values.
      const cat = await cls.runWith(
        { userId: expectedUserId },
        () => service.getCatForUser()
      )

      expect(cat.userId).toEqual(expectedUserId)
    })
  })
})
```
Tokens:
Raw