Function Response

  • Response<ExampleType, HeaderType>(name, description?, example?, produces?): Function

  • Type Parameters

    • ExampleType
    • HeaderType extends {} | "Header names must be of type string" | "Header values must be string or string[]" = {}

    Parameters

    • name: HttpStatusCodeLiteral | "100" | "101" | "102" | "200" | "201" | "202" | "203" | "204" | "205" | "206" | "207" | "208" | "226" | "300" | "301" | "302" | "303" | "304" | "305" | "307" | "308" | "418" | "416" | "400" | "401" | "402" | "403" | "404" | "405" | "406" | "407" | "408" | "409" | "410" | "411" | "412" | "413" | "414" | "415" | "417" | "422" | "423" | "424" | "426" | "428" | "429" | "431" | "451" | "500" | "501" | "502" | "503" | "504" | "505" | "506" | "507" | "508" | "510" | "511" | OtherValidOpenApiHttpStatusCode
    • Optional description: string
    • Optional example: ExampleType
    • Optional produces: string | string[]

    Returns Function

Settings

Member Visibility

Theme

Generated using TypeDoc