# NestJS head-to-head

## Overview

Auto-generated technical documentation for **NestJS head-to-head** — 1520 entities (413 doc comments, 259 interfaces, 259 classs, 183 functions).

## Architecture

```mermaid
flowchart LR
  service_ConsoleLogger_38089336["ConsoleLogger"]
  service_Logger_56f71189["Logger"]
  service_ClassSerializerInterceptor_38d66def["ClassSerializerInterceptor"]
  module_ClientsModule_41eb342d["ClientsModule"]
  module_MulterModule_1337416c["MulterModule"]
```

## Modules

- **ClientsModule**
- **MulterModule**

## Entry Points

- `GET /` → moduleKey
- `GET /` → moduleName
- `ALL /` → handler
- `GET /` → metatype
- `GET /` → handler
- `ALL /` → handler
- `GET /` → modulesContainer
- `GET /` → normalizedPattern
- `GET /` → route

## Key Components

_The most-referenced entities — start here._

- **Module** (function) — referenced 181×
- **Get** (constant) — referenced 77×
- **Scope** (enum) — referenced 69×
- **Inject** (function) — referenced 64×
- **Type** (interface) — referenced 62×
- **Logger** (service) — referenced 52×
- **ExecutionContext** (interface) — referenced 48×
- **Post** (constant) — referenced 37×
- **NestInterceptor** (interface) — referenced 36×
- **CallHandler** (interface) — referenced 32×

## Subsystems

Ordered by how much of the rest of the system depends on them, not by how much code they
contain. A small module many things import shapes this codebase more than a large one nothing
imports.

| Subsystem | Depended on by | Entities | Starts at |
|---|---|---|---|
| **Common** | 8 | 353 | `DefaultValuePipe`, `ParseFilePipe` |
| **Core** | 5 | 284 | `moduleKey`, `moduleName` |
| **Websockets** | 4 | 87 | `Readme.md`, `BaseWsInstance` |
| **Microservices** | 1 | 429 | `normalizedPattern`, `route` |
| **Platform Express** | 0 | 52 | `MulterModule` |
| **Platform Fastify** | 0 | 44 | `Readme.md`, `FastifyAdapter` |
| **Testing** | 0 | 41 | `TestingLogger`, `Readme.md` |
| **Platform Socket.io** | 0 | 31 | `Readme.md`, `IoAdapter` |
| **Platform Ws** | 0 | 31 | `Readme.md`, `WsAdapter` |

`Common` depend on no other subsystem here — they are the leaves.

## How this code is named

These conventions cover most of the codebase. Learning them is faster than reading an index —
each one lets you find any member of its family without looking it up.

| Pattern | Where | Count | Examples |
|---|---|---|---|
| `*.interface.ts` | across the repository | 128 | `type.interface.ts`, `file.interface.ts`, `edge.interface.ts`, `node.interface.ts` |
| `*.exception.ts` | across the repository | 55 | `gone.exception.ts`, `http.exception.ts`, `runtime.exception.ts`, `conflict.exception.ts` |
| `*.decorator.ts` | across the repository | 39 | `sse.decorator.ts`, `ctx.decorator.ts`, `ack.decorator.ts`, `bind.decorator.ts` |
| `*.util.ts` | across the repository | 21 | `cli-colors.util.ts`, `forward-ref.util.ts`, `is-log-level.util.ts`, `load-package.util.ts` |
| `*.pipe.ts` | across the repository | 10 | `parse-int.pipe.ts`, `parse-file.pipe.ts`, `parse-bool.pipe.ts`, `parse-date.pipe.ts` |
| `*.enum.ts` | across the repository | 10 | `transport.enum.ts`, `http-status.enum.ts`, `version-type.enum.ts`, `ws-paramtype.enum.ts` |