@mojojs/core
    Preparing search index...

    Class UserAgentResponse

    User-agent response class.

    Hierarchy (View Summary)

    • Body
      • UserAgentResponse
    Index
    constructor
    _form _stream autoDecompress headers httpVersion maxMessageSize statusCode statusMessage
    _params isClientError isError isRedirect isServerError isSuccess type
    _consumeBody _formIterator _isForm [asyncIterator] buffer createReadStream files form get html json pipe set sse text xml yaml

    _form

    _form: Params | undefined = undefined

    _stream

    _stream: Readable
    autoDecompress: boolean = true

    Automatically decompress message body if necessary.

    headers: Headers

    HTTP headers.

    httpVersion: string

    HTTP version.

    maxMessageSize: number | undefined = undefined

    Maximum message body size in bytes, after decompression, unlimited by default.

    statusCode: number

    Response status code.

    statusMessage: string

    Response status message.

    _params

    • get _params(): Params

      Returns Params

    • get isClientError(): boolean

      Check if response has a 4xx response status code.

      Returns boolean

    • get isError(): boolean

      Check if response has a 4xx or 5xx response status code.

      Returns boolean

    • get isRedirect(): boolean

      Check if response has a 3xx response status code.

      Returns boolean

    • get isServerError(): boolean

      Check if response has a 5xx response status code.

      Returns boolean

    • get isSuccess(): boolean

      Check if response has a 2xx response status code.

      Returns boolean

    • get type(): string | null

      Get Content-Type header value.

      Returns string | null

    _consumeBody

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

      Returns Promise<Uint8Array<ArrayBufferLike>[]>

    _formIterator

    _isForm

    • _isForm(): boolean

      Returns boolean

    • Returns AsyncIterable<Buffer<ArrayBufferLike>>

    • Get message body as Buffer object.

      Returns Promise<Buffer<ArrayBufferLike>>

    • Get message body as a readable stream.

      Returns Readable

    • Get async iterator for uploaded files from message body.

      Parameters

      Returns AsyncIterableIterator<FileUpload>

      // 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}`);
      }

    • Get form parameters from message body.

      Parameters

      Returns Promise<Params>

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

    • Get HTTP header from message.

      Parameters

      • name: string

      Returns string | null

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

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

      Returns Promise<DOM>

    • Get JSON message body as parsed data structure.

      Type Parameters

      Returns Promise<T>

    • Pipe message body to writable stream.

      Parameters

      • writer: Writable

      Returns Promise<void>

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

      Parameters

      • name: string
      • value: string

      Returns this

    • Get async iterator for Server-Sent Events from response body. Note that this method is EXPERIMENTAL and might change without warning!

      Returns AsyncIterableIterator<SSEEvent>

      // Iterate over events
      for await (const {id, type, text} of res.sse()) {
        console.log(`${type}: ${text}`);
      }

    text

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

      Get message body as string.

      Parameters

      • charset: BufferEncoding = 'utf8'

      Returns Promise<string>

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

      Returns Promise<DOM>

    • Get YAML message body as parsed data structure.

      Returns Promise<unknown>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods