Class HttpMessage

Complete HTTP message representation with request and response components.

Supports both normal HTTP and WebSocket messages with interceptor pipelines.

Constructors

constructor

new HttpMessage(
    type:
        | "normal-simple"
        | "normal-stream-request"
        | "normal-stream-response"
        | "websocket",
): HttpMessage
Creates a new message instance.
Parameters
- type:
      | "normal-simple"
      | "normal-stream-request"
      | "normal-stream-response"
      | "websocket"
  The message type.
Returns HttpMessage

Properties

analyze

analyze: string = 'default'

Name of the analyze queue job.

`Readonly`connection

connection: HttpConnection = {}

Connection details for this message.

`Readonly`errors

errors: HttpError[] = []

Accumulated errors during processing.

`Readonly`id

id: string = ...

Unique identifier for this message.

`Readonly`method

method: HttpMethodWrap

Request method wrapper.

`Readonly`payload

payload: HttpPayload = {}

Payload data for this message.

`Readonly`requestBody

requestBody: HttpBodyWrap

Request body wrapper.

`Readonly`requestHeaders

requestHeaders: HttpHeadersWrap

Request headers wrapper.

`Readonly`responseBody

responseBody: HttpBodyWrap

Response body wrapper.

`Readonly`responseHeaders

responseHeaders: HttpHeadersWrap

Response headers wrapper.

`Readonly`status

status: HttpStatusWrap

Response status wrapper.

`Readonly`url

url: HttpUrlWrap

Request URL wrapper.

Accessors

isReady

get isReady(): boolean

Checks if the message is ready for processing.

Returns boolean
true if the message is ready, false otherwise.

type

get type(): | "normal-simple"
| "normal-stream-request"
| "normal-stream-response"
| "websocket"

Gets the message type.

Returns
    | "normal-simple"
    | "normal-stream-request"
    | "normal-stream-response"
    | "websocket"
The current message type.

Methods

addContentTypes

addContentTypes(
    name:
        | "text"
        | "json"
        | "html"
        | "css"
        | "javascript"
        | "xml"
        | "urlEncoded",
    types: string[],
): this
Registers MIME types for a content-type category.
Parameters
- name: "text" | "json" | "html" | "css" | "javascript" | "xml" | "urlEncoded"
  The content-type category name.
- types: string[]
  The array of MIME types to register.
Returns this
This message for method chaining.

Throws
Error If the message is already ready.

addError

addError(error: unknown, path: string[]): this
Adds an error with a path context.
Parameters
- error: unknown
  The error object or unknown value.
- path: string[]
  The path segments indicating where the error occurred.
Returns this
This message for method chaining.

addRequestBodyInterceptor

addRequestBodyInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): this
Adds a request body interceptor.

Request body interceptors are called after the request head interceptors.
Parameters
- name: string
  The interceptor identifier.
- interceptor: HttpMessageInterceptor
  The interceptor function.
Returns this
This message for method chaining.

Throws
Error If the message is already ready.

addRequestHeadInterceptor

addRequestHeadInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): this
Adds a request head interceptor.

Request head interceptors are called before the request body is processed.
Parameters
- name: string
  The interceptor identifier.
- interceptor: HttpMessageInterceptor
  The interceptor function.
Returns this
This message for method chaining.

Throws
Error If the message is already ready.

addRequestTransform

addRequestTransform(transform: Transform): this
Adds a stream transform for the request body.
Parameters
- transform: Transform
  The transform stream to add.
Returns this
This message for method chaining.

Throws
Error If the message is already ready.

addResponseBodyInterceptor

addResponseBodyInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): this
Adds a response body interceptor.

Response body interceptors are called after the response head interceptors.
Parameters
- name: string
  The interceptor identifier.
- interceptor: HttpMessageInterceptor
  The interceptor function.
Returns this
This message for method chaining.

Throws
Error If the message is already ready.

addResponseHeadInterceptor

addResponseHeadInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): this
Adds a response head interceptor.

Response head interceptors are called before the response body is processed.
Parameters
- name: string
  The interceptor identifier.
- interceptor: HttpMessageInterceptor
  The interceptor function.
Returns this
This message for method chaining.

Throws
Error If the message is already ready.

addResponseTransform

addResponseTransform(transform: Transform): this
Adds a stream transform for the response body.
Parameters
- transform: Transform
  The transform stream to add.
Returns this
This message for method chaining.

Throws
Error If the message is already ready.

addRewriteUrlContentTypes

addRewriteUrlContentTypes(types: string[]): this
Adds content-types eligible for URL rewriting.
Parameters
- types: string[]
  The array of MIME types to add.
Returns this
This message for method chaining.

Throws
Error If the message is already ready.

addRewriteUrlExtraSchemes

addRewriteUrlExtraSchemes(): this

Adds extra URL rewriting schemes for percent and unicode encoded URLs.

Returns this
This message for method chaining.

Throws
Error If the message is already ready.

decorateRequestBodyHtml

decorateRequestBodyHtml(cb: ($: CheerioAPI) => void): void
Decocrates request body as HTML.
Parameters
- cb: ($: CheerioAPI) => void
Returns void

decorateRequestBodyJson

decorateRequestBodyJson(cb: (json: HttpJson) => void): void
Decorates request body as JSON.
Parameters
- cb: (json: HttpJson) => void
Returns void

decorateRequestBodyQueryString

decorateRequestBodyQueryString(cb: (queryString: HttpQueryString) => void): void
Decorates request body as Query String.
Parameters
- cb: (queryString: HttpQueryString) => void
Returns void

decorateRequestBodyText

decorateRequestBodyText(cb: (text: string) => string): void
Decorates request body as plain text.
Parameters
- cb: (text: string) => string
Returns void

decorateRequestBodyXml

decorateRequestBodyXml(cb: ($: CheerioAPI) => void): void
Decorate request body as XML.
Parameters
- cb: ($: CheerioAPI) => void
Returns void

decorateResponseBodyHtml

decorateResponseBodyHtml(cb: ($: CheerioAPI) => void): void
Decocrates response body as HTML.
Parameters
- cb: ($: CheerioAPI) => void
Returns void

decorateResponseBodyJson

decorateResponseBodyJson(cb: (json: HttpJson) => void): void
Decorates response body as JSON.
Parameters
- cb: (json: HttpJson) => void
Returns void

decorateResponseBodyQueryString

decorateResponseBodyQueryString(
cb: (queryString: HttpQueryString) => void,
): void
Decorates response body as Query String.
Parameters
- cb: (queryString: HttpQueryString) => void
Returns void

decorateResponseBodyText

decorateResponseBodyText(cb: (text: string) => string): void
Decorates response body as plain text.
Parameters
- cb: (text: string) => string
Returns void

decorateResponseBodyXml

decorateResponseBodyXml(cb: ($: CheerioAPI) => void): void
Decorate response body as XML.
Parameters
- cb: ($: CheerioAPI) => void
Returns void

getRequestTransforms

getRequestTransforms(): Transform[]

Gets the request transforms.

Returns Transform[]
The array of transforms.

getResponseTransforms

getResponseTransforms(): Transform[]

Gets the response transforms.

Returns Transform[]
The array of transforms.

isAbsoluteUrl

isAbsoluteUrl(value: string): boolean
Checks if a string is an absolute URL.
Parameters
- value: string
  The URL string to check.
Returns boolean
true if it's an absolute URL, false otherwise.

isRequestContentType

isRequestContentType(
    name:
        | "text"
        | "json"
        | "html"
        | "css"
        | "javascript"
        | "xml"
        | "urlEncoded",
): boolean
Checks if a request content-type belongs to a category.
Parameters
- name: "text" | "json" | "html" | "css" | "javascript" | "xml" | "urlEncoded"
  The content-type category name.
Returns boolean
true if the content-type matches the category, false otherwise.

isResponseContentType

isResponseContentType(
    name:
        | "text"
        | "json"
        | "html"
        | "css"
        | "javascript"
        | "xml"
        | "urlEncoded",
): boolean
Checks if a response content-type belongs to a category.
Parameters
- name: "text" | "json" | "html" | "css" | "javascript" | "xml" | "urlEncoded"
  The content-type category name.
Returns boolean
true if the content-type matches the category, false otherwise.

isRewriteUrlContentType

isRewriteUrlContentType(contentType: HttpContentType | null): boolean
Checks if a content-type supports URL rewriting.
Parameters
- contentType: HttpContentType | null
  The parsed content-type to check.
Returns boolean
true if rewriting is applicable, false otherwise.

mergeConnection

mergeConnection(connection: HttpConnection): this
Merges connection details into the message.
Parameters
- connection: HttpConnection
  The connection details to merge.
Returns this
This message for method chaining.

ready

ready(): this

Marks the message as ready for processing.

After this call, the message structure or content cannot be modified.

Returns this
This message for method chaining.

retrieveRequestBodyHtml

retrieveRequestBodyHtml(): CheerioAPI | null

Retrieves request body as HTML.

Returns CheerioAPI | null

retrieveRequestBodyJson

retrieveRequestBodyJson(): HttpJson

Retrieves request body as JSON.

Returns HttpJson

retrieveRequestBodyQueryString

retrieveRequestBodyQueryString(): HttpQueryString | null

Retrieves request body as Query String.

Returns HttpQueryString | null

retrieveRequestBodyText

retrieveRequestBodyText(): string | null

Retrieves request body as plain text.

Returns string | null

retrieveRequestBodyXml

retrieveRequestBodyXml(): CheerioAPI | null

Retrieves request body as XML.

Returns CheerioAPI | null

retrieveResponseBodyHtml

retrieveResponseBodyHtml(): CheerioAPI | null

Retrieves response body as HTML.

Returns CheerioAPI | null

retrieveResponseBodyJson

retrieveResponseBodyJson(): HttpJson

Retrieves response body as JSON.

Returns HttpJson

retrieveResponseBodyQueryString

retrieveResponseBodyQueryString(): HttpQueryString | null

Retrieves response body as Query String.

Returns HttpQueryString | null

retrieveResponseBodyText

retrieveResponseBodyText(): string | null

Retrieves response body as plain text.

Returns string | null

retrieveResponseBodyXml

retrieveResponseBodyXml(): CheerioAPI | null

Retrieves response body as XML.

Returns CheerioAPI | null

rewriteUrl

rewriteUrl(text: string, rev: boolean, targets: RewriteUrlTarget[]): string
Rewrites URLs in text content.
Parameters
- text: string
  The text content containing URLs.
- rev: boolean
  If false, replaces donor to mirror; if true, replaces mirror to donor.
- targets: RewriteUrlTarget[]
  The URL rewrite targets.
Returns string
The text with rewritten URLs.

runRequestBodyInterceptors

runRequestBodyInterceptors(): this

Runs all registered request body interceptors in order.

This method freezes the request headers and body after execution.

Returns this
This message for method chaining.

Throws
Error If the message is not ready.

runRequestHeadInterceptors

runRequestHeadInterceptors(): this

Runs all registered request head interceptors in order.

This method freezes the method and URL after execution.

Returns this
This message for method chaining.

Throws
Error If the message is not ready.

runResponseBodyInterceptors

runResponseBodyInterceptors(): this

Runs all registered response body interceptors in order.

This method freezes the response headers and body after execution.

Returns this
This message for method chaining.

Throws
Error If the message is not ready.

runResponseHeadInterceptors

runResponseHeadInterceptors(): this

Runs all registered response head interceptors in order.

This method freezes the status after execution.

Returns this
This message for method chaining.

Throws
Error If the message is not ready.

setType

setType(
    type:
        | "normal-simple"
        | "normal-stream-request"
        | "normal-stream-response"
        | "websocket",
): this
Sets the message type with validation.

The type can only be changed to a compatible type based on the current type.
Parameters
- type:
      | "normal-simple"
      | "normal-stream-request"
      | "normal-stream-response"
      | "websocket"
  The new message type.
Returns this
This message for method chaining.

Throws
Error If the message is already ready.

Throws
Error If the type transition is invalid.

`Static`create

create(type: string): HttpMessage
Factory method to create a message by type.
Parameters
- type: string
  The message type.
Returns HttpMessage
A new message instance.

Throws
Error If the message type is unknown.

Class HttpMessage

Constructors

constructor

Parameters

Returns HttpMessage

Properties

analyze

Readonlyconnection

Readonlyerrors

Readonlyid

Readonlymethod

Readonlypayload

ReadonlyrequestBody

ReadonlyrequestHeaders

ReadonlyresponseBody

ReadonlyresponseHeaders

Readonlystatus

Readonlyurl

Accessors

isReady

Returns boolean

type

Returns | "normal-simple" | "normal-stream-request" | "normal-stream-response" | "websocket"

Methods

addContentTypes

Parameters

Returns this

Throws

addError

Parameters

Returns this

addRequestBodyInterceptor

Parameters

Returns this

Throws

addRequestHeadInterceptor

Parameters

Returns this

Throws

addRequestTransform

Parameters

Returns this

Throws

addResponseBodyInterceptor

Parameters

Returns this

Throws

addResponseHeadInterceptor

Parameters

Returns this

Throws

addResponseTransform

Parameters

Returns this

Throws

addRewriteUrlContentTypes

Parameters

Returns this

Throws

addRewriteUrlExtraSchemes

Returns this

Throws

decorateRequestBodyHtml

Parameters

Returns void

decorateRequestBodyJson

Parameters

Returns void

decorateRequestBodyQueryString

Parameters

Returns void

decorateRequestBodyText

Parameters

Returns void

decorateRequestBodyXml

Parameters

Returns void

decorateResponseBodyHtml

Parameters

Returns void

`Readonly`connection

`Readonly`errors

`Readonly`id

`Readonly`method

`Readonly`payload

`Readonly`requestBody

`Readonly`requestHeaders

`Readonly`responseBody

`Readonly`responseHeaders

`Readonly`status

`Readonly`url

Returns
| "normal-simple"
| "normal-stream-request"
| "normal-stream-response"
| "websocket"