Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RequestOptions

Extended request options.

Hierarchy

  • RequestOptions
    • RequestOptions

Index

Properties

Optional agent

agent: Agent | boolean

Optional auth

auth: string

Optional family

family: number

Optional headers

headers: OutgoingHttpHeaders

Optional host

host: string

Optional hostname

hostname: string

Optional localAddress

localAddress: string

Optional maximumRedirections

maximumRedirections: number

The maximum number of redirections.

Optional method

method: string

Optional noRedirect

noRedirect: boolean

Do not redirect automatically.

Optional path

path: string

Optional port

port: number | string

Optional protocol

protocol: string

Optional raiseOnClientError

raiseOnClientError: boolean

Raise error on 4xx status code or not.

Optional raiseOnServerError

raiseOnServerError: boolean

Raise error on 5xx status code or not.

Optional raiseOnUnsupportedResponse

raiseOnUnsupportedResponse: boolean

Raise error on status code that is greater than 599 or less than 200. Default: (true)

Optional setup

setup: any

Function or data for setting up the request.

Optional socketPath

socketPath: string

Optional timeout

timeout: number

Generated using TypeDoc