Class HttpBodyWrap

constructor

• new HttpBodyWrap(body: HttpBody): HttpBodyWrap

  Creates a new wrapper instance.

  Parameters

  • body: HttpBody

    The body buffer to wrap.

  Returns HttpBodyWrap

ReadonlyformatQueryStringOptions

ReadonlyparseQueryStringOptions

isFrozen

• get isFrozen(): boolean

  Checks if the wrapper is frozen (read-only).

  Returns boolean

  true if the wrapper is frozen, false otherwise.

length

• get length(): number

  Gets the body buffer size in bytes.

  Returns number

  The size of the body.

clone

• clone(): HttpBodyWrap

  Clones the wrapper with a copy of the body.

  Returns HttpBodyWrap

  A new independent wrapper instance.

freeze

• freeze(): this

  Freezes the wrapper to prevent modifications.

  Returns this

  This wrapper for method chaining.

get

• get(): HttpBody

  Gets the raw body buffer.

  Returns HttpBody

  The Buffer containing the body.

getBase64

• getBase64(): string

  Gets the body as a Base64 string (cached).

  Returns string

  The Base64 encoded body.

  Throws

  Error If Base64 encoding fails.

getJson

• getJson(charset?: string): HttpJson

  Gets the body as a JSON object (cached).

  Parameters

  • Optionalcharset: string

    The optional character encoding.

  Returns HttpJson

  The parsed JSON object.

  Throws

  Error If decoding or JSON parsing fails.

getQueryString

• getQueryString(charset?: string): HttpQueryString

  Gets the body as a query string object (cached).

  Parameters

  • Optionalcharset: string

    The optional character encoding.

  Returns HttpQueryString

  The parsed query string object.

  Throws

  Error If parsing fails.

getText

• getText(charset?: string): string

  Gets the body as a text string (cached).

  Parameters

  • charset: string = 'utf8'

    The character encoding, default: 'utf8'.

  Returns string

  The decoded text.

  Throws

  Error If decoding fails.

reset

• reset(): this

  Clears the body and resets all caches.

  Returns this

  This wrapper for method chaining.

  Throws

  Error If the wrapper is frozen.

set

• set(body: HttpBody): this

  Sets the raw body buffer.

  Parameters

  • body: HttpBody

    The Buffer to set as the body.

  Returns this

  This wrapper for method chaining.

  Throws

  Error If the wrapper is frozen.

setBase64

• setBase64(base64: string): this

  Sets the body from a Base64 string.

  Parameters

  • base64: string

    The Base64 encoded string.

  Returns this

  This wrapper for method chaining.

  Throws

  Error If the wrapper is frozen.

  Throws

  Error If Base64 decoding fails.

setJson

• setJson(json: HttpJson, charset?: string): this

  Sets the body from a JSON object.

  Parameters

  • json: HttpJson

    The JSON object to stringify.

  • Optionalcharset: string

    The optional character encoding.

  Returns this

  This wrapper for method chaining.

  Throws

  Error If the wrapper is frozen.

  Throws

  Error If JSON stringification or encoding fails.

setQueryString

• setQueryString(queryString: HttpQueryString, charset?: string): this

  Sets the body from a query string object.

  Parameters

  • queryString: HttpQueryString

    The query string object.

  • Optionalcharset: string

    The optional character encoding.

  Returns this

  This wrapper for method chaining.

  Throws

  Error If the wrapper is frozen.

  Throws

  Error If formatting fails.

setText

• setText(text: string, charset?: string): this

  Sets the body from a text string.

  Parameters

  • text: string

    The text to set as the body.

  • charset: string = 'utf8'

    The character encoding, default: 'utf8'.

  Returns this

  This wrapper for method chaining.

  Throws

  Error If the wrapper is frozen.

  Throws

  Error If encoding fails.

StaticfromScratch

• fromScratch(): HttpBodyWrap

  Factory method to create a wrapper from scratch.

  Returns HttpBodyWrap

  A new wrapper instance with an empty body.