Class HttpMessage

Complete HTTP message representation with request and response components. Supports normal HTTP and WebSocket messages with interceptor pipelines.

Constructors

constructor

new HttpMessage(
    type:
        | "normal-simple"
        | "normal-stream-request"
        | "normal-stream-response"
        | "websocket",
): HttpMessage
Create 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:82

Properties

analyze

analyze: string | null = null

Analyze queue job name

`Readonly`connection

connection: HttpConnection = {}

Connection metadata

`Readonly`errors

errors: HttpError[] = []

Accumulated errors during processing

`Readonly`id

id: string = ...

Unique message ID

`Readonly`method

method: HttpMethodWrap

Method wrapper instance

`Readonly`payload

payload: HttpPayload = {}

Message payload data

`Readonly`requestBody

requestBody: HttpBodyWrap

Request body wrapper instance

`Readonly`requestHeaders

requestHeaders: HttpHeadersWrap

Request headers wrapper instance

`Readonly`responseBody

responseBody: HttpBodyWrap

Response body wrapper instance

`Readonly`responseHeaders

responseHeaders: HttpHeadersWrap

Response headers wrapper instance

`Readonly`status

status: HttpStatusWrap

Response status wrapper instance

`Readonly`url

url: HttpUrlWrap

Url wrapper instance

Accessors

isReady

get isReady(): boolean
Check if message is ready for processing.

Returns boolean
true if message is ready, false otherwise
- Defined in packages/http-tools/src/message.ts:101

type

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

Returns
    | "normal-simple"
    | "normal-stream-request"
    | "normal-stream-response"
    | "websocket"
Current message type
- Defined in packages/http-tools/src/message.ts:117

Methods

addContentTypes

addContentTypes(
    name:
        | "text"
        | "json"
        | "html"
        | "css"
        | "javascript"
        | "xml"
        | "urlEncoded",
    types: string[],
): void
Register content-types for a category.
Parameters
- name: "text" | "json" | "html" | "css" | "javascript" | "xml" | "urlEncoded"
  Content type category
- types: string[]
  Array of MIME types
Returns void
Throws
Error if message is ready
- Defined in packages/http-tools/src/message.ts:190

addError

addError(error: unknown, path: string[]): void
Add error with path context.
Parameters
- error: unknown
  Error object or unknown value
- path: string[]
  Error location path segments
Returns void
- Defined in packages/http-tools/src/message.ts:166

addRequestBodyInterceptor

addRequestBodyInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): void
Add request body interceptor.
Parameters
- name: string
  Interceptor identifier
- interceptor: HttpMessageInterceptor
  Interceptor function
Returns void
Throws
Error if message is ready
- Defined in packages/http-tools/src/message.ts:275

addRequestHeadInterceptor

addRequestHeadInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): void
Add request head interceptor.
Parameters
- name: string
  Interceptor identifier
- interceptor: HttpMessageInterceptor
  Interceptor function
Returns void
Throws
Error if message is ready
- Defined in packages/http-tools/src/message.ts:262

addRequestTransform

addRequestTransform(transform: Transform): void
Add stream transform for request body.
Parameters
- transform: Transform
  Transform stream
Returns void
Throws
Error if message is ready
- Defined in packages/http-tools/src/message.ts:333

addResponseBodyInterceptor

addResponseBodyInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): void
Add response body interceptor.
Parameters
- name: string
  Interceptor identifier
- interceptor: HttpMessageInterceptor
  Interceptor function
Returns void
Throws
Error if message is ready
- Defined in packages/http-tools/src/message.ts:371

addResponseHeadInterceptor

addResponseHeadInterceptor(
name: string,
interceptor: HttpMessageInterceptor,
): void
Add response head interceptor.
Parameters
- name: string
  Interceptor identifier
- interceptor: HttpMessageInterceptor
  Interceptor function
Returns void
Throws
Error if message is ready
- Defined in packages/http-tools/src/message.ts:358

addResponseTransform

addResponseTransform(transform: Transform): void
Add stream transform for response body.
Parameters
- transform: Transform
  Transform stream
Returns void
Throws
Error if message is ready
- Defined in packages/http-tools/src/message.ts:428

addRewriteUrlContentTypes

addRewriteUrlContentTypes(types: string[]): void
Add content-types eligible for URL rewriting.
Parameters
- types: string[]
  Array of MIME types
Returns void
Throws
Error if message is ready
- Defined in packages/http-tools/src/message.ts:215

addRewriteUrlExtraSchemes

addRewriteUrlExtraSchemes(): void
Add extra URL rewriting schemes (percent and unicode encoded).

Returns void
Throws
Error if message is ready
- Defined in packages/http-tools/src/message.ts:241

getRequestTransforms

getRequestTransforms(): Transform[]
Get request transforms.

Returns Transform[]
Array of transforms
- Defined in packages/http-tools/src/message.ts:344

getResponseTransforms

getResponseTransforms(): Transform[]
Get response transforms.

Returns Transform[]
Array of transforms
- Defined in packages/http-tools/src/message.ts:439

isAbsoluteUrl

isAbsoluteUrl(value: string): boolean
Check if value is absolute URL.
Parameters
- value: string
  URL string to check
Returns boolean
true if absolute URL
- Defined in packages/http-tools/src/message.ts:449

isContentType

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

isRewriteUrlContentType

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

mergeConnection

mergeConnection(connection: HttpConnection): void
Merge connection metadata.
Parameters
- connection: HttpConnection
  Connection data to merge
Returns void
- Defined in packages/http-tools/src/message.ts:146

ready

ready(): void
Mark message as ready for processing.

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

rewriteUrl

rewriteUrl(text: string, rev: boolean, targets: RewriteUrlTarget[]): string
Rewrite URLs in text.
Parameters
- text: string
  Text content containing URLs
- rev: boolean
  Reverse rewriting (mirror to donor)
- targets: RewriteUrlTarget[]
  URL rewrite targets
Returns string
Text with rewritten URLs
- Defined in packages/http-tools/src/message.ts:462

runRequestBodyInterceptors

runRequestBodyInterceptors(): void
Run all registered request body interceptors in order. This method freezes headers and body after execution.

Returns void
Throws
Error if message is not ready
- Defined in packages/http-tools/src/message.ts:308

runRequestHeadInterceptors

runRequestHeadInterceptors(): void
Run all registered request head interceptors in order. This method freezes method and URL after execution.

Returns void
Throws
Error if message is not ready
- Defined in packages/http-tools/src/message.ts:287

runResponseBodyInterceptors

runResponseBodyInterceptors(): void
Run all registered response body interceptors in order. This method freezes headers and body after execution.

Returns void
Throws
Error if message is not ready
- Defined in packages/http-tools/src/message.ts:403

runResponseHeadInterceptors

runResponseHeadInterceptors(): void
Run all registered response head interceptors in order. This method freezes status after execution.

Returns void
Throws
Error if message is not ready
- Defined in packages/http-tools/src/message.ts:383

setType

setType(
    type:
        | "normal-simple"
        | "normal-stream-request"
        | "normal-stream-response"
        | "websocket",
): void
Set message type with validation.
Parameters
- type:
      | "normal-simple"
      | "normal-stream-request"
      | "normal-stream-response"
      | "websocket"
  New message type
Returns void
Throws
Error if message is ready or invalid type transition
- Defined in packages/http-tools/src/message.ts:127

`Static`create

create(type: string): HttpMessage
Factory method to create message by type.
Parameters
- type: string
  Message type ('normal' or 'websocket')
Returns HttpMessage
New message instance

Throws
Error if message type is unknown
- Defined in packages/http-tools/src/message.ts:47

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