Function: CacheTTL()

function CacheTTL(ttl): MethodDecorator & ClassDecorator;

Defined in: packages/cache/src/decorators/cache-ttl.decorator.ts:63

Decorator that sets the cache TTL (time-to-live) duration.

TTL determines how long an item remains in the cache before expiration. Value is specified in milliseconds.

Parameters

Parameter	Type	Description
ttl	number | CacheTTLFactory	A static TTL value in milliseconds, or a factory function.

Returns

MethodDecorator & ClassDecorator

A decorator function that sets the metadata.

Examples

Static TTL (5 seconds):

@CacheTTL(5000)
@Get('data')
async getData() {
  return this.dataService.findAll();
}

Dynamic TTL with factory:

@CacheTTL((ctx) => {
  const request = ctx.switchToHttp().getRequest();
  // Cache expensive queries longer
  return request.query.complex ? 60000 : 10000;
})
@Get('search')
async search(@Query() query: SearchQuery) {
  return this.searchService.search(query);
}