Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/pouryazardosht/nestjs-devtools/llms.txt

Use this file to discover all available pages before exploring further.

The Module File Searcher classifies .ts files by matching their filename suffix against a known list of NestJS patterns defined in src/constants.ts. Every file that matches a known pattern appears in the quick-pick with a category label, a coloured emoji, and a shortcut letter you can type to open it instantly — no arrow-key navigation required.

How matching works

The extension checks whether a filename ends with .<suffix>.ts. For example, user.service.ts matches the suffix service, and auth.guard.ts matches guard. Some types also accept a plural suffix — the extension checks both .<suffix>.ts and .<suffix>s.ts for the following types:
Singular suffixPlural suffix also accepted
guardguards
gatewaygateways
interceptorinterceptors
pipepipes
filterfilters
decoratordecorators
resolverresolvers
middlewaremiddlewares
strategystrategies
Matching is evaluated in the order that types appear in the NEST_TYPES array. The first match wins. Files that match no known suffix fall into the Other Files category (see Unrecognised files below).

File type reference

The primary NestJS building blocks. These are the most common file types you will navigate between.
TypeSuffixShortcutEmoji
Service.service.tsS🛠️
Controller.controller.tsC🎮
Module.module.tsM📦
Guard.guard.ts / .guards.tsG🛡️
Gateway.gateway.ts / .gateways.tsGW🌐
Interceptor.interceptor.ts / .interceptors.tsI🚧
Pipe.pipe.ts / .pipes.tsP🔧
Filter.filter.ts / .filters.tsF🧹
Resolver.resolver.ts / .resolvers.tsR🧬
Decorator.decorator.ts / .decorators.tsD🎨
TypeORM / Mongoose entity files that map to database tables or collections.
TypeSuffixShortcutEmoji
Entity.entity.tsE🗃️
Data Transfer Objects used to validate and shape request and response payloads.
TypeSuffixShortcutEmoji
DTO.dto.tsDT📋
TypeScript enum files used for typed constant values across the module.
TypeSuffixShortcutEmoji
Enum.enum.tsEN🎛️
TypeScript interface files that define shared contracts and type shapes.
TypeSuffixShortcutEmoji
Interface.interface.tsIF🔗
Additional NestJS-adjacent file types that appear frequently in real-world projects.
TypeSuffixShortcutEmoji
Repository.repository.tsRP🗄️
Middleware.middleware.ts / .middlewares.tsMW⚙️
Strategy.strategy.ts / .strategies.tsST🧠
Test / Spec.spec.tsT🧪

Unrecognised files

Any .ts file whose name does not match a known suffix is placed in the Other Files category and shown with the 📄 File label. These files are still fully accessible in the quick-pick — you can reach them by scrolling with the arrow keys or by typing part of their filename in the search box. Because they have no assigned shortcut letter, they cannot be opened with a single-character shortcut.
── Other Files ──
📄  some-utility.ts         File  |  src/user/some-utility.ts
📄  token.constants.ts      File  |  src/auth/token.constants.ts
To add recognition for a new file type, open a pull request on GitHub and add a new entry to the NEST_TYPES array in src/constants.ts. Each entry needs a suffix, typeLabel, shortcut, emoji, and category field.
{
  suffix: "factory",
  typeLabel: "Factory",
  shortcut: "fa",
  emoji: "🏭",
  category: "Core NestJS",
},

Build docs developers (and LLMs) love