Class Body

constructor

• new Body(headers, stream): Body

• Parameters

  • headers: string[]

  • stream: Readable

  Returns Body

_form

_stream

autoDecompress

headers

_params

• get _params(): Params

• Returns Params

[asyncIterator]

• [asyncIterator](): AsyncIterable<Buffer>

• Returns AsyncIterable<Buffer>

_consumeBody

• _consumeBody(): Promise<Uint8Array[]>

• Returns Promise<Uint8Array[]>

_formIterator

• _formIterator(options?): FormIterator

• Parameters

  • Optional options: UploadOptions

  Returns FormIterator

_isForm

• _isForm(): boolean

• Returns boolean

buffer

• buffer(): Promise<Buffer>

• Get message body as Buffer object.

  Returns Promise<Buffer>

createReadStream

• createReadStream(): Readable

• Get message body as a readable stream.

  Returns Readable

files

• files(options?): AsyncIterableIterator<FileUpload>

• Get async iterator for uploaded files from message body.

  Parameters

  • Optional options: 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?): Promise<Params>

• Get form parameters from message body.

  Parameters

  • Optional options: UploadOptions

  Returns Promise<Params>

  Example

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

get

• get(name): null | string

• Get HTTP header from message.

  Parameters

  • name: string

  Returns null | string

  Example

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

html

• html(): Promise<default>

• Get HTML message body as @mojojs/dom object.

  Returns Promise<default>

json

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

• Get JSON message body as parsed data structure.

  Type Parameters

  • T = JSONValue

  Returns Promise<T>

pipe

• pipe(writer): Promise<void>

• Pipe message body to writable stream.

  Parameters

  • writer: Writable

  Returns Promise<void>

set

• set(name, value): Body

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

  Parameters

  • name: string

  • value: string

  Returns Body

text

• text(charset?): Promise<string>

• Get message body as string.

  Parameters

  • charset: BufferEncoding = 'utf8'

  Returns Promise<string>

xml

• xml(): Promise<default>

• Get XML message body as @mojojs/dom object.

  Returns Promise<default>

yaml

• yaml(): Promise<unknown>

• Get YAML message body as parsed data structure.

  Returns Promise<unknown>