• Preparing search index...
  • The search index is not available
zibri
  • zibri
  • open-api/decorators/response.decorator
  • Response
  • error

Function error

  • error(
        status: ExcludeStrict<HttpStatus, OK | CREATED>,
        data?: OmitStrict<ErrorOpenApiResponse, "status" | "type">,
    ): MethodDecorator

    An error response.

    Parameters

    • status: ExcludeStrict<HttpStatus, OK | CREATED>

      The status of the response.

    • Optionaldata: OmitStrict<ErrorOpenApiResponse, "status" | "type">

      Additional data like description etc.

    Returns MethodDecorator

    • Defined in src/open-api/decorators/response.decorator.ts:178

Settings

Member Visibility
zibri
  • Loading...

Generated using TypeDoc