Class Body

Represents the body of an HTTP message, allowing for handling of various body types like streams, strings, buffers, and more.

Provides utilities for creating a body instance and transforming it into an HTTP response.

Implements

ToHttpResponse

Index

Constructors

Properties

contentTypeHint sizeHint

Methods

read toHttpResponse from

Constructors

constructor

new Body(stream: Readable, sizeHint?: SizeHint, contentTypeHint?: string): Body
Parameters
- stream: Readable
- OptionalsizeHint: SizeHint
- OptionalcontentTypeHint: string
Returns Body
- Defined in http/body.ts:21

Properties

`Readonly`contentTypeHint

contentTypeHint: null | string

`Readonly`sizeHint

sizeHint: SizeHint

Methods

read

read(): Readable
Retrieves the readable stream from the inner body if it has not been consumed.

Ensures that the body is readable before accessing it.

Returns Readable
Throws
if the body has already been consumed.
- Defined in http/body.ts:69

toHttpResponse

toHttpResponse(): HttpResponse
Returns HttpResponse
Implementation of ToHttpResponse.toHttpResponse
- Defined in http/body.ts:74

`Static`from

from(body: BodyLike): Body
Parameters
- body: BodyLike
Returns Body
- Defined in http/body.ts:29