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
- Defined in packages/http-tools/src/message.ts:89

Properties

analyze

analyze: string | null = null

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.
- Defined in packages/http-tools/src/message.ts:108

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.
- Defined in packages/http-tools/src/message.ts:126

Methods

addContentTypes

addContentTypes(
    name:
        | "text"
        | "json"
        | "html"
        | "css"
        | "javascript"
        | "xml"
        | "urlEncoded",
    types: string[],
): void
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 void

Throws
Error If the message is already ready.
- Defined in packages/http-tools/src/message.ts:202

addError

addError(error: unknown, path: string[]): void
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 void
- Defined in packages/http-tools/src/message.ts:178

addRequestBodyInterceptor

addRequestBodyInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): void
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 void

Throws
Error If the message is already ready.
- Defined in packages/http-tools/src/message.ts:291

addRequestHeadInterceptor

addRequestHeadInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): void
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 void

Throws
Error If the message is already ready.
- Defined in packages/http-tools/src/message.ts:276

addRequestTransform

addRequestTransform(transform: Transform): void
Adds a stream transform for the request body.
Parameters
- transform: Transform
  The transform stream to add.
Returns void

Throws
Error If the message is already ready.
- Defined in packages/http-tools/src/message.ts:351

addResponseBodyInterceptor

addResponseBodyInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): void
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 void

Throws
Error If the message is already ready.
- Defined in packages/http-tools/src/message.ts:393

addResponseHeadInterceptor

addResponseHeadInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): void
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 void

Throws
Error If the message is already ready.
- Defined in packages/http-tools/src/message.ts:378

addResponseTransform

addResponseTransform(transform: Transform): void
Adds a stream transform for the response body.
Parameters
- transform: Transform
  The transform stream to add.
Returns void

Throws
Error If the message is already ready.
- Defined in packages/http-tools/src/message.ts:452

addRewriteUrlContentTypes

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

Throws
Error If the message is already ready.
- Defined in packages/http-tools/src/message.ts:227

addRewriteUrlExtraSchemes

addRewriteUrlExtraSchemes(): void
Adds extra URL rewriting schemes for percent and unicode encoded URLs.

Returns void

Throws
Error If the message is already ready.
- Defined in packages/http-tools/src/message.ts:253

getRequestTransforms

getRequestTransforms(): Transform[]
Gets the request transforms.

Returns Transform[]
The array of transforms.
- Defined in packages/http-tools/src/message.ts:362

getResponseTransforms

getResponseTransforms(): Transform[]
Gets the response transforms.

Returns Transform[]
The array of transforms.
- Defined in packages/http-tools/src/message.ts:463

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.
- Defined in packages/http-tools/src/message.ts:473

isContentType

isContentType(
    name:
        | "text"
        | "json"
        | "html"
        | "css"
        | "javascript"
        | "xml"
        | "urlEncoded",
    contentType: HttpContentType,
): boolean
Checks if a content-type belongs to a category.
Parameters
- name: "text" | "json" | "html" | "css" | "javascript" | "xml" | "urlEncoded"
  The content-type category name.
- contentType: HttpContentType
  The parsed content-type to check.
Returns boolean
true if the content-type matches the category, false otherwise.
- Defined in packages/http-tools/src/message.ts:215

isRewriteUrlContentType

isRewriteUrlContentType(contentType: HttpContentType): boolean
Checks if a content-type supports URL rewriting.
Parameters
- contentType: HttpContentType
  The parsed content-type to check.
Returns boolean
true if rewriting is applicable, false otherwise.
- Defined in packages/http-tools/src/message.ts:239

mergeConnection

mergeConnection(connection: HttpConnection): void
Merges connection details into the message.
Parameters
- connection: HttpConnection
  The connection details to merge.
Returns void
- Defined in packages/http-tools/src/message.ts:158

ready

ready(): void
Marks the message as ready for processing.

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

Returns void
- Defined in packages/http-tools/src/message.ts:117

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.
- Defined in packages/http-tools/src/message.ts:486

runRequestBodyInterceptors

runRequestBodyInterceptors(): void
Runs all registered request body interceptors in order.

This method freezes the request headers and body after execution.

Returns void

Throws
Error If the message is not ready.
- Defined in packages/http-tools/src/message.ts:326

runRequestHeadInterceptors

runRequestHeadInterceptors(): void
Runs all registered request head interceptors in order.

This method freezes the method and URL after execution.

Returns void

Throws
Error If the message is not ready.
- Defined in packages/http-tools/src/message.ts:304

runResponseBodyInterceptors

runResponseBodyInterceptors(): void
Runs all registered response body interceptors in order.

This method freezes the response headers and body after execution.

Returns void

Throws
Error If the message is not ready.
- Defined in packages/http-tools/src/message.ts:427

runResponseHeadInterceptors

runResponseHeadInterceptors(): void
Runs all registered response head interceptors in order.

This method freezes the status after execution.

Returns void

Throws
Error If the message is not ready.
- Defined in packages/http-tools/src/message.ts:406

setType

setType(
    type:
        | "normal-simple"
        | "normal-stream-request"
        | "normal-stream-response"
        | "websocket",
): void
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 void

Throws
Error If the message is already ready.

Throws
Error If the type transition is invalid.
- Defined in packages/http-tools/src/message.ts:139

`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.
- Defined in packages/http-tools/src/message.ts:48

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 void

Throws

addError

Parameters

Returns void

addRequestBodyInterceptor

Parameters

Returns void

Throws

addRequestHeadInterceptor

Parameters

Returns void

Throws

addRequestTransform

Parameters

Returns void

Throws

addResponseBodyInterceptor

Parameters

Returns void

Throws

addResponseHeadInterceptor

Parameters

Returns void

Throws

addResponseTransform

Parameters

Returns void

Throws

addRewriteUrlContentTypes

Parameters

Returns void

Throws

addRewriteUrlExtraSchemes

Returns void

Throws

getRequestTransforms

Returns Transform[]

getResponseTransforms

Returns Transform[]

isAbsoluteUrl

Parameters

Returns boolean

isContentType

Parameters

Returns boolean

isRewriteUrlContentType

Parameters

Returns boolean

mergeConnection

Parameters

Returns void

ready

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"

`Static`create