Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

agent

agent: false | Agent | Agent

body

body: Buffer | Buffer[] | string | string[] | stream.Readable

Optional ca

ca: string | Buffer | string[] | Buffer[]

Optional callback

callback: RequestCallback

Optional cert

cert: Buffer

dests

dests: stream.Readable[]

Optional elapsedTime

elapsedTime: undefined | number

Optional encoding

encoding: string | null

Optional explicitMethod

explicitMethod: undefined | true

Optional followAllRedirects

followAllRedirects: undefined | false | true

Optional followOriginalHttpMethod

followOriginalHttpMethod: undefined | false | true

Optional gzip

gzip: undefined | false | true

Optional har

headers

headers: Headers

Optional host

host: undefined | string

href

href: string

Optional key

key: Buffer

Optional localAddress

localAddress: undefined | string

Optional maxRedirects

maxRedirects: undefined | number

method

method: string

Optional passphrase

passphrase: undefined | string

path

path: string

pool

pool: false | object

Optional port

port: undefined | number

Optional postambleCRLF

postambleCRLF: undefined | false | true

Optional preambleCRLF

preambleCRLF: undefined | false | true

proxy

proxy: null | string | Url

readable

readable: boolean

Optional rejectUnauthorized

rejectUnauthorized: undefined | false | true

Optional removeRefererHeader

removeRefererHeader: undefined | false | true

Optional response

response: Response

setHost

setHost: boolean

Optional src

src: stream.Readable

Optional startTime

startTime: undefined | number

Optional startTimeNow

startTimeNow: undefined | number

Optional strictSSL

strictSSL: undefined | false | true

Optional time

time: undefined | false | true

Optional timeout

timeout: undefined | number

Optional timing

timing: undefined | false | true

Optional timings

timings: undefined | object

tunnel

tunnel: boolean

uri

uri: Url & object

Optional withCredentials

withCredentials: undefined | false | true

writable

writable: boolean

Static defaultMaxListeners

defaultMaxListeners: number

Methods

abort

  • abort(): void
  • Returns void

addListener

  • addListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

auth

  • auth(username: string, password: string, sendImmediately?: undefined | false | true, bearer?: undefined | string): Request
  • Parameters

    • username: string
    • password: string
    • Optional sendImmediately: undefined | false | true
    • Optional bearer: undefined | string

    Returns Request

aws

  • Parameters

    • opts: AWSOptions
    • Optional now: undefined | false | true

    Returns Request

debug

  • debug(...args: any[]): void
  • Parameters

    • Rest ...args: any[]

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

end

  • end(cb?: undefined | function): void
  • end(chunk: string | Buffer, cb?: undefined | function): void
  • end(str: string, encoding?: undefined | string, cb?: undefined | function): void
  • Parameters

    • Optional cb: undefined | function

    Returns void

  • Parameters

    • chunk: string | Buffer
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: undefined | string
    • Optional cb: undefined | function

    Returns void

eventNames

  • eventNames(): Array<string | symbol>

form

  • Returns FormData

  • Parameters

    • form: any

    Returns Request

getHeader

getMaxListeners

  • getMaxListeners(): number

hasHeader

hawk

  • Parameters

    Returns void

jar

  • Parameters

    Returns Request

json

  • Parameters

    • val: any

    Returns Request

listenerCount

  • listenerCount(type: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

multipart

  • Parameters

    Returns Request

oauth

  • Parameters

    Returns Request

off

  • off(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string, listener: function): this
  • on(event: "request", listener: function): this
  • on(event: "response", listener: function): this
  • on(event: "data", listener: function): this
  • on(event: "error", listener: function): this
  • on(event: "complete", listener: function): this
  • on(event: "pipe", listener: function): this
  • on(event: "socket", listener: function): this
  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: "response"
    • listener: function

    Returns this

  • Parameters

    • event: "data"
    • listener: function
        • (data: Buffer | string): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (e: Error): void
        • Parameters

          • e: Error

          Returns void

    Returns this

  • Parameters

    • event: "complete"
    • listener: function

    Returns this

  • Parameters

    • event: "pipe"
    • listener: function
        • (src: stream.Readable): void
        • Parameters

          • src: stream.Readable

          Returns void

    Returns this

  • Parameters

    • event: "socket"
    • listener: function

    Returns this

once

  • once(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: undefined | object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: undefined | object

    Returns T

pipeDest

  • pipeDest(dest: any): void
  • Parameters

    • dest: any

    Returns void

prependListener

  • prependListener(event: string | symbol, listener: function): this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

qs

  • qs(q: object, clobber?: undefined | false | true): Request
  • Parameters

    • q: object
    • Optional clobber: undefined | false | true

    Returns Request

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeHeader

  • removeHeader(name: KeyType): boolean

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

resume

  • resume(): void
  • Returns void

setHeader

setMaxListeners

  • setMaxListeners(n: number): this

toJSON

  • Returns RequestAsJSON

write

  • write(buffer: Buffer | string, cb?: undefined | function): boolean
  • write(str: string, encoding?: undefined | string, cb?: undefined | function): boolean
  • Parameters

    • buffer: Buffer | string
    • Optional cb: undefined | function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: undefined | string
    • Optional cb: undefined | function

    Returns boolean

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    Returns number

Generated using TypeDoc