rest-vir - v1.0.0
    Preparing search index...

    Type Alias EndpointImplementationOutput<ResponseDataType>

    EndpointImplementationOutput:
        | EndpointImplementationErrorOutput
        | {
            dataType?: string;
            headers?: OutgoingHttpHeaders;
            responseErrorMessage?: never;
            statusCode: HttpStatusByCategory<SuccessHttpStatusCategories>;
        } & (
            ResponseDataType extends undefined
                ? { responseData?: ResponseDataType }
                : { responseData: ResponseDataType }
        )

    The object that all endpoint implementations should return.

    Type Parameters

    • ResponseDataType = unknown

    Type declaration

    • EndpointImplementationErrorOutput
    • {
          dataType?: string;
          headers?: OutgoingHttpHeaders;
          responseErrorMessage?: never;
          statusCode: HttpStatusByCategory<SuccessHttpStatusCategories>;
      } & (
          ResponseDataType extends undefined
              ? { responseData?: ResponseDataType }
              : { responseData: ResponseDataType }
      )
      • OptionaldataType?: string

        Set the response data type. If any response data is included, the default is application/json.

      • Optionalheaders?: OutgoingHttpHeaders
      • OptionalresponseErrorMessage?: never
      • statusCode: HttpStatusByCategory<SuccessHttpStatusCategories>