Class UserAgentResponse

User-agent response class.

Hierarchy

  • Body
    • UserAgentResponse

Constructors

constructor

Properties

_form _stream autoDecompress headers httpVersion statusCode statusMessage

Accessors

_params isClientError isError isRedirect isServerError isSuccess type

Methods

[asyncIterator] _consumeBody _formIterator _isForm buffer createReadStream files form get html json pipe set text xml yaml

Constructors

constructor

Properties

_form

_form: undefined | Params = undefined

_stream

_stream: Readable

autoDecompress

autoDecompress: boolean = true

Automatically decompress message body if necessary.

headers

headers: Headers

HTTP headers.

httpVersion

httpVersion: string

HTTP version.

statusCode

statusCode: number

Response status code.

statusMessage

statusMessage: string

Response status message.

Accessors

_params

  • get _params(): Params

  • Returns Params

isClientError

  • get isClientError(): boolean

  • Check if response has a 4xx response status code.

    Returns boolean

isError

  • get isError(): boolean

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

    Returns boolean

isRedirect

  • get isRedirect(): boolean

  • Check if response has a 3xx response status code.

    Returns boolean

isServerError

  • get isServerError(): boolean

  • Check if response has a 5xx response status code.

    Returns boolean

isSuccess

  • get isSuccess(): boolean

  • Check if response has a 2xx response status code.

    Returns boolean

type

  • get type(): null | string

  • Get Content-Type header value.

    Returns null | string

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterable<Buffer>

  • Returns AsyncIterable<Buffer>

_consumeBody

  • _consumeBody(): Promise<Uint8Array[]>

  • Returns Promise<Uint8Array[]>

_formIterator

  • _formIterator(options?: UploadOptions): AsyncIterableIterator<[string, Readable, string, string, string]>

  • Parameters

    • Optional options: UploadOptions

    Returns AsyncIterableIterator<[string, Readable, string, string, string]>

_isForm

  • _isForm(): boolean

  • Returns boolean

buffer

  • Get message body as Buffer object.

    Returns Promise<Buffer>

createReadStream

  • Get message body as a readable stream.

    Returns Readable

files

  • Get async iterator for uploaded files from message body.

    Parameters

    • Optional options: UploadOptions

    Returns AsyncIterableIterator<FileUpload>

form

  • Get form parameters from message body.

    Parameters

    • Optional options: UploadOptions

    Returns Promise<Params>

get

  • Get HTTP header from message.

    Example

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

    Parameters

    • name: string

    Returns null | string

html

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

    Returns Promise<default>

json

  • Get JSON message body as parsed data structure.

    Type Parameters

    Returns Promise<T>

pipe

  • Pipe message body to writable stream.

    Parameters

    • writer: Writable

    Returns Promise<void>

set

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

    Parameters

    • name: string
    • value: string

    Returns UserAgentResponse

text

  • Get message body as string.

    Parameters

    • charset: BufferEncoding = 'utf8'

    Returns Promise<string>

xml

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

    Returns Promise<default>

yaml

  • Get YAML message body as parsed data structure.

    Returns Promise<unknown>

Settings

Member Visibility

Theme

Generated using TypeDoc