Class default<BodyType>

constructor

• new default<BodyType = null>(
      statusCode: number,
      body: BodyType,
      optBehaviour?: {
          disableTransactionID?: boolean;
          rawBody?: boolean;
          shouldStream?: boolean;
          throwOnErrors?: boolean;
      },
  ): default<BodyType>

  Constructs a new Response object with the given status code, body, and optional behavior.

  Type Parameters

  • BodyType = null

  Parameters

  • statusCode: number

    The HTTP status code of the response.
  • body: BodyType

    The body of the response.
  • OptionaloptBehaviour: {
        disableTransactionID?: boolean;
        rawBody?: boolean;
        shouldStream?: boolean;
        throwOnErrors?: boolean;
    }

    Optional behavior configuration for the response.

    • OptionaldisableTransactionID?: boolean

    • OptionalrawBody?: boolean

      Indicates whether the response body should be treated as raw data.

    • OptionalshouldStream?: boolean

      Indicates whether the response should be streamed.

    • OptionalthrowOnErrors?: boolean

      Indicates whether errors should be thrown for non-successful status codes.

  Returns default<BodyType>

ReadonlydisableTransactionID

ReadonlyrawBody

ReadonlyshouldStream

ReadonlythrowOnErrors

appendHeader

• appendHeader(key: string, value: any): void

  Appends a header to the existing headers object.

  Parameters

  • key: string

    The key of the header.
  • value: any

    The value of the header.

  Returns void

  None

appendIntoBody

• appendIntoBody(key: string, value: any): void

  Appends a key-value pair into the body object.

  Parameters

  • key: string

    The key to append.
  • value: any

    The value to append.

  Returns void

  None

build

• build(
      context: Context,
      transaction: default<any, any, any, any, any>,
      optDoNotCallContext: boolean,
  ): Promise<void>

  Builds the response for the given context and transaction.

  Parameters

  • context: Context

    The context object.
  • transaction: default<any, any, any, any, any>

    The transaction object.
  • optDoNotCallContext: boolean

    Optional flag to indicate whether to call the context or not.

  Returns Promise<void>

  • A promise that resolves when the response is built.

getBody

• getBody(): BodyType

  Get the body of the object.

  Returns BodyType

  The body of the object.

getCode

• getCode(): number

  Get the status code of the response.

  Returns number

  The status code.

StaticBadRequestResponse

• BadRequestResponse(
      msg?: string,
      errCode?: string,
      optBody?: any,
  ): default<ResponseErrorType>

  Creates a BadRequestResponse object with the given parameters.

  Parameters

  • Optionalmsg: string

    The error message.
  • OptionalerrCode: string

    The error code.
  • OptionaloptBody: any

    Optional additional body data.

  Returns default<ResponseErrorType>

  • The BadRequestResponse object.

StaticBadRequestResponseWithRollback

• BadRequestResponseWithRollback(
      msg: string,
      errCode?: string,
      optBody?: any,
  ): default<ResponseErrorType>

  Creates a BadRequestResponse object with rollback option.

  Parameters

  • msg: string

    The error message.
  • OptionalerrCode: string

    The error code.
  • OptionaloptBody: any

    Optional body to include in the response.

  Returns default<ResponseErrorType>

  • The BadRequestResponse object.

StaticMissingParamResponse

• MissingParamResponse(paramName: string): default<ResponseErrorType>

  Generates a response object for a missing path parameter error.

  Parameters

  • paramName: string

    The name of the missing path parameter.

  Returns default<ResponseErrorType>

  • The response object with error details.

StaticMissingQueryResponse

• MissingQueryResponse(paramName: string): default<ResponseErrorType>

  Creates a response object for a missing query parameter error.

  Parameters

  • paramName: string

    The name of the missing query parameter.

  Returns default<ResponseErrorType>

  • The response object with error details.

StaticRedirectResponse

• RedirectResponse(url: string): default<null>

  Creates a redirect response with the specified URL.

  Parameters

  • url: string

    The URL to redirect to.

  Returns default<null>

  • The redirect response.

StaticSimpleResponse

• SimpleResponse<BodyType>(
      body: BodyType,
      optionalCode?: number,
  ): default<BodyType>

  Creates a simple HTTP response with the given body and optional status code.

  Type Parameters

  • BodyType

  Parameters

  • body: BodyType

    The body of the response.
  • OptionaloptionalCode: number

    The optional status code of the response. Defaults to 200.

  Returns default<BodyType>

  • The created response object.

StaticSuccessNoContentResponse

• SuccessNoContentResponse(): default<null>

  Creates a success response with no content.

  Returns default<null>

  A response object with a status code of 204 and no content.

StaticSuccessResponse

• SuccessResponse<BodyType>(body: BodyType): default<BodyType>

  Creates a success response object with the given body.

  Type Parameters

  • BodyType

  Parameters

  • body: BodyType

    The body of the response.

  Returns default<BodyType>

  • The success response object.

StaticSuccessStreamResponse

• SuccessStreamResponse(stream: any, contentType: string): default

  Creates a success response object with a streaming body and specified content type.

  Parameters

  • stream: any

    The stream object to be used as the response body.
  • contentType: string

    The content type of the response.

  Returns default

  • The success response object.

StaticUnauthorizedResponse

• UnauthorizedResponse(msg: string, errCode?: string): default<ResponseErrorType>

  Creates an unauthorized response with the given error message and error code.

  Parameters

  • msg: string

    The error message.
  • OptionalerrCode: string

    The error code (optional).

  Returns default<ResponseErrorType>

  • The unauthorized response.