Interface RequestOptions

Hierarchy-Diagram

UML class diagram of RequestOptions

Legend

icon for an interface in the UML class diagram

interface

icon for a public property in the UML class diagram

public property

Hierarchy

ClientRequestArgs
- RequestOptions

Index

Properties

Properties

Optional _defaultAgent

_defaultAgent?: Agent

Optional agent

agent?: boolean | Agent

Optional auth

auth?: null | string

Optional createConnection

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

Type declaration

- (options: ClientRequestArgs, oncreate: (err: <internal>.Error, socket: Socket) => void): Socket
- Parameters
  - options: ClientRequestArgs
  - oncreate: (err: <internal>.Error, socket: Socket) => void
    - - (err: <internal>.Error, socket: Socket): void
      - Parameters
        err: <internal>.Error
        socket: Socket
        Returns void
  Returns Socket

Optional defaultPort

defaultPort?: string | number

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 setHost

setHost?: boolean

Optional signal

signal?: AbortSignal

Optional socketPath

socketPath?: string

Optional timeout

timeout?: number

Generated using TypeDoc