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

Function empty

  • empty(
        status?: HttpStatus,
        data?: OmitStrict<
            JsonOpenApiResponse,
            "status"
            | "type"
            | "cls"
            | "isArray",
        >,
    ): MethodDecorator

    An empty response where nothing is returned.

    Parameters

    • status: HttpStatus = HttpStatus.OK

      The status of the response, defaults to 200.

    • Optionaldata: OmitStrict<JsonOpenApiResponse, "status" | "type" | "cls" | "isArray">

      Additional configuration, like description.

    Returns MethodDecorator

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

Settings

Member Visibility
zibri
  • Loading...

Generated using TypeDoc