# @golevelup/nestjs-discovery > A Badass NestJS module for querying your app's controllers, providers and handlers Latest version **7.0.3** (published 2026-05-26) · MIT license · 0 weekly downloads ## Install ```sh npm install @golevelup/nestjs-discovery pnpm add @golevelup/nestjs-discovery yarn add @golevelup/nestjs-discovery bun add @golevelup/nestjs-discovery ``` ## Health **Score 60/100 (C)** — status: active. Positive: has types; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads; no esm support. ## Facts | | | |---|---| | Version | 7.0.3 | | Published | 2026-05-26 | | First published | 2019-11-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 31.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2747 | | Author | Jesse Carter | | Maintainers | wonderpanda, jmcdo29, enigmadk | | Keywords | NestJS, discovery, modules | ## Links - npm: https://www.npmjs.com/package/@golevelup/nestjs-discovery - Repository: https://github.com/golevelup/nestjs - Homepage: https://github.com/golevelup/nestjs/blob/master/packages/discovery/README.md - Issues: https://github.com/golevelup/nestjs/issues - npm.io page: https://npm.io/package/@golevelup/nestjs-discovery ## Recent versions - 7.0.3 (latest) — 2026-05-26 - 7.0.1 — 2026-05-20 - 7.0.0 — 2026-03-18 - 6.1.2 — 2026-01-26 - 6.1.1 — 2025-12-19 - 6.1.0 — 2025-12-19 - 6.0.0 — 2025-12-19 - 5.0.1 — 2025-12-08 - 5.0.0 — 2025-05-08 - 4.0.3 — 2025-01-24 - 4.0.2 — 2024-11-06 - 4.0.1 — 2024-04-10 - 4.0.0 — 2023-07-18 - 3.0.1 — 2023-07-03 - 3.0.0 — 2022-01-24 - … 8 more at https://npm.io/package/@golevelup/nestjs-discovery/versions ## README # Discovery This module provides access to the `DiscoveryService` which can be used to query the various modules, providers, controllers and handlers that make up your NestJS application.
version downloads license
## Getting Started ::: code-group ```bash [npm] npm install ---save @golevelup/nestjs-discovery ``` ```bash [yarn] yarn add @golevelup/nestjs-discovery ``` ```bash [pnpm] pnpm add @golevelup/nestjs-discovery ``` ::: ## Import Import and add `DiscoveryModule` to the `imports` section of the module you wish to implement Discovery features in. It's common to inject it directly into consuming Module's contructor so that it can be used during the `onModuleInit` lifecycle hook at application startup. ```typescript import { DiscoveryModule } from '@golevelup/nestjs-discovery'; import { Module } from '@nestjs/common'; @Module({ imports: [DiscoveryModule], }) export class ExampleModule implements OnModuleInit { constructor(private readonly discover: DiscoveryService) {} public async onModuleInit() { // const providers = await this.discover.providersWithMetaAtKey('metaKey') } } ``` ## Discover The `DiscoveryService` exposes several different querying patterns for your app's components that are [well documented with comments](src/discovery.service.ts). This will also provide intellisense for querying in a TypeScript compatible IDE. In the case of querying for `providers` or `controllers`, the service returns the following interfaces: ```typescript export interface DiscoveredModule { name: string; instance: {}; injectType?: Type<{}>; dependencyType: Type<{}>; } export interface DiscoveredClass extends DiscoveredModule { parentModule: DiscoveredModule; } ``` This gives access to the (singleton) `instance` of the matching provider or controller created by the NestJS Dependency Injection container. The `injectType` can contain the constructor function of the provider token if it is provided as an @Injectable class. In the case of custom providers, this value will either contain the type of the factory function that created the dependency, or undefined if a value was directly provided with `useValue`. The `dependencyType` is a shortcut to retrieve the constructor function of the actual provided dependency itself. For @Injectable providers/controllers this will simply be the decorated class but for dyanmic providers it will return the constructor function of whatever dependency was actually returned from `useValue` or `useFactory`. It also provides the string based name for convenience. A `DiscoveredClass` contains a `parentModule` which provides the same set of information for the `@Module` class that the dependency was discovered in. When querying for methods on `providers` or `controllers` the following interface is returned: ```typescript export interface DiscoveredMethod { handler: (...args: any[]) => any; methodName: string; parentClass: DiscoveredClass; } ``` This gives access to the `handler` which is the actual class method implementation as well as the ability to navigate back up the dependency tree with the attached `parentClass`. When specifically querying for components in the context of looking for decorator metadata, the `...WithMetaAtKey` service methods return the types above along with the metadata that was discovered. ```typescript export interface DiscoveredMethodWithMeta { discoveredMethod: DiscoveredMethod; meta: T; } export interface DiscoveredClassWithMeta { discoveredClass: DiscoveredClass; meta: T; } ``` ## Example Assuming you were using a custom decorator in your application that attached metadata at a key called `exampleKey`: ```typescript const ExampleDecorator = (meta: string) => SetMetadata('exampleKey', meta); ``` Find all controller methods that have been decorated with `@ExampleDecorator` and retrieve the value they set for meta: ```typescript const exampleMethodsMeta = await this.discover.controllerMethodsWithMetaAtKey('exampleKey'); ``` --- _Source: https://npm.io/package/@golevelup/nestjs-discovery · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._