Class-Level Decorators for Cross-Cutting Config
Tag controllers and providers with custom class decorators to drive feature flags and tenant scoping.
Class-Level Decorators for Cross-Cutting Config is a free NestJS Enterprise Backend APIs lesson on CoddyKit — lesson 4 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the NestJS Enterprise Backend APIs learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
Why Class-Level Decorators?
In an enterprise NestJS API, some configuration applies to a whole controller or provider, not a single route. Think feature flags, tenant scoping, audit categories, or rate-limit tiers.
- Repeating this on every method is noisy and error-prone.
- A class-level decorator lets you tag the class once and read that tag later.
The pattern: attach metadata to the class, then read it inside a guard, interceptor, or middleware to drive cross-cutting behavior.
Decorators Are Just Functions
A class decorator is a function that receives the class constructor as its only argument. You can wrap it in a factory so callers pass options.
Here is the raw shape, with no framework involved, so you can see exactly what runs at class-definition time.
// Plain TypeScript: a class decorator factory
function Tag(label: string) {
return function (target: Function) {
console.log(`Decorating ${target.name} with label=${label}`);
};
}
@Tag('billing')
class InvoiceController {}
console.log('Class defined:', InvoiceController.name);Storing Metadata with Reflect
Logging is not useful by itself. We need to store the config so other code can read it. NestJS builds on the reflect-metadata library, which lets you attach key/value metadata to a class.
Reflect.defineMetadata(key, value, target)writes.Reflect.getMetadata(key, target)reads.
The class itself is the storage target, so the tag travels with the type.
A Tenant-Scope Decorator
Let's build a real one: @TenantScope('strict') marks a controller so that all its routes must resolve a tenant. We define a metadata key and a factory that writes it.
In NestJS you would normally use the built-in SetMetadata helper, but writing it by hand shows what it does under the hood.
import 'reflect-metadata';
export const TENANT_SCOPE = 'tenant:scope';
export function TenantScope(mode: 'strict' | 'optional') {
return (target: Function) => {
Reflect.defineMetadata(TENANT_SCOPE, mode, target);
};
}
@TenantScope('strict')
class OrdersController {}
const mode = Reflect.getMetadata(TENANT_SCOPE, OrdersController);
console.log('Tenant mode:', mode); // strictUsing SetMetadata in NestJS
NestJS ships SetMetadata(key, value) which returns a decorator usable on both classes and methods. Wrapping it in a named factory gives you a clean, self-documenting API.
This is the idiomatic way to author custom decorators in NestJS instead of calling Reflect.defineMetadata yourself.
import { SetMetadata } from '@nestjs/common';
export const FEATURE_FLAG = 'feature:flag';
// Class-level decorator built on SetMetadata
export const FeatureFlag = (flag: string) =>
SetMetadata(FEATURE_FLAG, flag);
@FeatureFlag('beta-checkout')
export class CheckoutController {}Reading Metadata with Reflector
To consume the tag at request time, inject NestJS's Reflector service. A guard can read the class-level metadata from context.getClass().
reflector.get(KEY, context.getClass())reads the controller-level tag.reflector.getAllAndOverride(KEY, [handler, class])lets a method override the class default.
import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { FEATURE_FLAG } from './feature-flag.decorator';
@Injectable()
export class FeatureFlagGuard implements CanActivate {
constructor(private reflector: Reflector) {}
canActivate(context: ExecutionContext): boolean {
const flag = this.reflector.get<string>(
FEATURE_FLAG,
context.getClass(),
);
if (!flag) return true; // no flag => always allowed
return isFeatureEnabled(flag);
}
}
declare function isFeatureEnabled(flag: string): boolean;Method Overrides Class
A common enterprise need: the controller sets a default, but one route opts out. getAllAndOverride checks the handler first, then falls back to the class.
Order matters: the array is searched left to right, so put the most specific target (the method handler) first.
canActivate(context: ExecutionContext): boolean {
const mode = this.reflector.getAllAndOverride<'strict' | 'optional'>(
TENANT_SCOPE,
[context.getHandler(), context.getClass()],
);
// method @TenantScope('optional') wins over class @TenantScope('strict')
return mode === 'optional' ? true : this.hasTenant(context);
}Composing Multiple Tags
Cross-cutting config often combines concerns: a feature flag and a tenant mode and an audit category. Use applyDecorators to bundle them into one expressive decorator.
This keeps controllers readable: one decorator communicates the full intent.
import { applyDecorators, SetMetadata } from '@nestjs/common';
import { FEATURE_FLAG } from './feature-flag.decorator';
import { TENANT_SCOPE } from './tenant-scope.decorator';
import { AUDIT_CATEGORY } from './audit.decorator';
export function EnterpriseModule(opts: {
flag: string;
tenant: 'strict' | 'optional';
audit: string;
}) {
return applyDecorators(
SetMetadata(FEATURE_FLAG, opts.flag),
SetMetadata(TENANT_SCOPE, opts.tenant),
SetMetadata(AUDIT_CATEGORY, opts.audit),
);
}
@EnterpriseModule({ flag: 'beta-checkout', tenant: 'strict', audit: 'orders' })
export class OrdersController {}Tagging Providers, Not Just Controllers
Class-level decorators are not limited to controllers. You can tag any provider class and read the metadata wherever you have the class reference, for example in a factory or a discovery service.
NestJS's DiscoveryService can enumerate all providers and inspect their metadata, which is how you build registries of tagged services.
import 'reflect-metadata';
const CACHE_TIER = 'cache:tier';
function CacheTier(tier: 'hot' | 'cold') {
return (target: Function) => Reflect.defineMetadata(CACHE_TIER, tier, target);
}
@CacheTier('hot')
class PricingService {}
@CacheTier('cold')
class ReportService {}
for (const svc of [PricingService, ReportService]) {
const tier = Reflect.getMetadata(CACHE_TIER, svc);
console.log(`${svc.name} -> ${tier}`);
}Wiring the Guard Globally
For cross-cutting config to take effect everywhere, register the consuming guard or interceptor once at the module level. The guard then inspects each request's target class.
A global guard plus class-level metadata means you configure behavior declaratively on each controller, with zero per-route wiring.
import { Module } from '@nestjs/common';
import { APP_GUARD } from '@nestjs/core';
import { FeatureFlagGuard } from './feature-flag.guard';
@Module({
providers: [
{ provide: APP_GUARD, useClass: FeatureFlagGuard },
],
})
export class AppModule {}Typing Metadata Keys Safely
Stringly-typed keys ('tenant:scope') are easy to mistype. Two safeguards used in enterprise codebases:
- Export the key as a
constfrom the decorator file so producer and consumer share one symbol. - Make the factory's argument a union type so invalid modes fail at compile time.
This turns config typos into TypeScript errors instead of silent runtime bugs.
type TenantMode = 'strict' | 'optional';
function validate(mode: TenantMode): TenantMode {
return mode;
}
console.log(validate('strict'));
// validate('loose') would be a compile-time error
console.log('Allowed modes: strict | optional');Quick Check
A controller is tagged @TenantScope('strict') at the class level, and one of its methods is tagged @TenantScope('optional'). Your guard must let that method opt out while keeping the strict default for the rest.
Recap
You learned how to drive cross-cutting config with class-level decorators:
- Author a decorator with
SetMetadata(orReflect.defineMetadata) wrapped in a typed factory. - Consume the tag with
Reflectorfromcontext.getClass()inside a guard or interceptor. - Override class defaults per-method using
getAllAndOverridewith the handler listed first. - Compose multiple concerns via
applyDecorators, and tag providers too, not just controllers. - Register the consumer globally with
APP_GUARDso the config applies declaratively across the app.
The result: feature flags and tenant scoping configured once per class, enforced everywhere.
Frequently asked questions
Is the “Class-Level Decorators for Cross-Cutting Config” lesson free?
Yes — the full text of “Class-Level Decorators for Cross-Cutting Config” is free to read here on the web, and the NestJS Enterprise Backend APIs course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the NestJS Enterprise Backend APIs course, upgrade to CoddyKit PRO.
What will I learn in “Class-Level Decorators for Cross-Cutting Config”?
Tag controllers and providers with custom class decorators to drive feature flags and tenant scoping. You practise NestJS Enterprise Backend APIs with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start NestJS Enterprise Backend APIs?
No prior experience is required. NestJS Enterprise Backend APIs on CoddyKit is structured for beginners through advanced learners; this is — lesson 4 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “Class-Level Decorators for Cross-Cutting Config” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this NestJS Enterprise Backend APIs lesson?
Yes. Every NestJS Enterprise Backend APIs lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.
All lessons in this course
- Reading Request Context with Param Decorators
- Attaching Metadata with SetMetadata and Reflector
- Composing Decorators with applyDecorators
- Class-Level Decorators for Cross-Cutting Config