Api References NestJS

ControllerOptions

interface

Interface defining options that can be passed to @Controller() decorator


interface ControllerOptions extends ScopeOptions, VersionOptions {
  path?: string | string[]
  host?: string | RegExp | Array<string | RegExp>

  // inherited from nest/packages/common/ScopeOptions
  scope?: Scope
  durable?: boolean
}

Properties

Property Description

Property	Description
`path?: string \| string[]`	Specifies an optional `route path prefix`. The prefix is pre-pended to the path specified in any request decorator in the class. Supported only by HTTP-based applications (does not apply to non-HTTP microservices).
`host?: string \| RegExp \| Array<string \| RegExp>`	Specifies an optional HTTP Request host filter. When configured, methods within the controller will only be routed if the request host matches the specified value.

path?: string | string[]

Specifies an optional route path prefix. The prefix is pre-pended to the path specified in any request decorator in the class.

Supported only by HTTP-based applications (does not apply to non-HTTP microservices).

host?: string | RegExp | Array<string | RegExp>

Specifies an optional HTTP Request host filter. When configured, methods within the controller will only be routed if the request host matches the specified value.