Class Body

constructor

• new Body(headers: string[], stream: Readable): Body

  Parameters

  • headers: string[]
  • stream: Readable

  Returns Body

_form

_stream

autoDecompress

headers

maxMessageSize

_params

• get _params(): Params

  Returns Params

_consumeBody

• _consumeBody(): Promise<Uint8Array<ArrayBufferLike>[]>

  Returns Promise<Uint8Array<ArrayBufferLike>[]>

_formIterator

• _formIterator(options?: UploadOptions): FormIterator

  Parameters

  • Optionaloptions: UploadOptions

  Returns FormIterator

_isForm

• _isForm(): boolean

  Returns boolean

[asyncIterator]

• "[asyncIterator]"(): AsyncIterable<Buffer<ArrayBufferLike>>

  Returns AsyncIterable<Buffer<ArrayBufferLike>>

buffer

• buffer(): Promise<Buffer<ArrayBufferLike>>

  Get message body as Buffer object.

  Returns Promise<Buffer<ArrayBufferLike>>

createReadStream

• createReadStream(): Readable

  Get message body as a readable stream.

  Returns Readable

files

• files(options?: UploadOptions): AsyncIterableIterator<FileUpload>

  Get async iterator for uploaded files from message body.

  Parameters

  • Optionaloptions: UploadOptions

  Returns AsyncIterableIterator<FileUpload>

  Example

  // Iterate over uploaded files
  for await (const {fieldname, file, filename} of body.files()) {
    const parts = [];
    for await (const chunk of file) {
      parts.push(chunk);
    }
    const content = Buffer.concat(parts).toString();
    console.write(`${fieldname}: ${content}`);
  }
  Copy

form

• form(options?: UploadOptions): Promise<Params>

  Get form parameters from message body.

  Parameters

  • Optionaloptions: UploadOptions

  Returns Promise<Params>

  Example

  // Get a specific parameter
  const params = await body.form();
  const foo = params.get('foo');
  Copy

get

• get(name: string): string | null

  Get HTTP header from message.

  Parameters

  • name: string

  Returns string | null

  Example

  // Get User-Agent header
  const agent = body.get('User-Agent');
  Copy

html

• html(): Promise<DOM>

  Get HTML message body as @mojojs/dom object.

  Returns Promise<DOM>

json

• json<T = JSONValue>(): Promise<T>

  Get JSON message body as parsed data structure.

  Type Parameters

  • T = JSONValue

  Returns Promise<T>

pipe

• pipe(writer: Writable): Promise<void>

  Pipe message body to writable stream.

  Parameters

  • writer: Writable

  Returns Promise<void>

set

• set(name: string, value: string): this

  Set HTTP header for message. // Set Server header body.set('Server', 'mojo.js');

  Parameters

  • name: string
  • value: string

  Returns this

text

• text(charset?: BufferEncoding): Promise<string>

  Get message body as string.

  Parameters

  • charset: BufferEncoding = 'utf8'

  Returns Promise<string>

xml

• xml(): Promise<DOM>

  Get XML message body as @mojojs/dom object.

  Returns Promise<DOM>

yaml

• yaml(): Promise<unknown>

  Get YAML message body as parsed data structure.

  Returns Promise<unknown>