Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptionsHTTP

Hierarchy

  • RequestOptions
  • IOptionsCustom
    • IOptionsHTTP

Index

Properties

Properties

Optional _defaultAgent

_defaultAgent?: Agent

Optional abort

abort?: AbortSignal

Optional agent

agent?: boolean | Agent

Optional auth

auth?: null | string

Optional authMethod

authMethod?: string[]

Stores the used auth method

Optional body

body?: any

content (body) of the request

Optional cookie

cookie?: any

Optional cookieJar

cookieJar?: any

Optional createConnection

createConnection?: (options: ClientRequestArgs, oncreate: (err: Error, socket: Socket) => void) => Socket

Type declaration

    • (options: ClientRequestArgs, oncreate: (err: Error, socket: Socket) => void): Socket

    • Parameters

      • options: ClientRequestArgs
      • oncreate: (err: Error, socket: Socket) => void
          • (err: Error, socket: Socket): void

          • Parameters

            • err: Error
            • socket: Socket

            Returns void

      Returns Socket

Optional debug

debug?: boolean

Enable the logger for debug purposes

Optional defaultPort

defaultPort?: string | number

Optional disableRedirect

disableRedirect?: boolean

Disables the interception of redirect responses

Optional domain

domain?: string

domain/target validation

Optional family

family?: number

Optional headers

headers?: OutgoingHttpHeaders

Optional host

host?: null | string

Optional hostname

hostname?: null | string

Optional localAddress

localAddress?: string

Optional lookup

lookup?: LookupFunction

Optional maxHeaderSize

maxHeaderSize?: number
default

8192

Optional method

method?: string

Optional path

path?: null | string

Optional port

port?: null | string | number

Optional protocol

protocol?: null | string

Optional pwd

pwd?: string

password of the username

Optional requests

requests?: number

Requests counter

Optional setHost

setHost?: boolean

Optional socketPath

socketPath?: string

Optional timeout

timeout?: number

Optional tough

tough?: any

Sets the tough-cookie module to enable session

Optional url

url?: string

http(s) url of the protected resource

Optional user

user?: string

username of valid user (can be DOMAIN\username format)

Optional workstation

workstation?: string

workstation id (calculated if undefined)

Generated using TypeDoc