Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions

Hierarchy

  • RequestPromiseOptions
    • IOptions

Index

Properties

Methods

Properties

Optional agent

agent: Agent | Agent

Optional agentClass

agentClass: any

Optional agentOptions

agentOptions: any

Optional auth

auth: AuthOptions

Optional aws

aws: AWSOptions

Optional baseUrl

baseUrl: string

Optional body

body: any

Optional ca

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

Optional callback

callback: RequestCallback

Optional cert

cert: Buffer

Optional delay

delay: number

Optional encoding

encoding: string | null

Optional followAllRedirects

followAllRedirects: boolean

Optional followOriginalHttpMethod

followOriginalHttpMethod: boolean

Optional followRedirect

followRedirect: boolean | function

Optional forever

forever: any

Optional form

form: object | string

Optional formData

formData: object

Type declaration

  • [key: string]: any

Optional gzip

gzip: boolean

Optional har

har: HttpArchiveRequest

Optional hawk

hawk: HawkOptions

Optional headers

headers: Headers

Optional host

host: string

Optional jar

jar: any

Optional json

json: any

Optional jsonReplacer

jsonReplacer: function

Type declaration

    • (key: string, value: any): any

    • Parameters

      • key: string
      • value: any

      Returns any

Optional jsonReviver

jsonReviver: function

Type declaration

    • (key: string, value: any): any

    • Parameters

      • key: string
      • value: any

      Returns any

Optional key

key: Buffer

Optional libRequest

libRequest: function

Type declaration

    • (url: string, options?: IOptions): request.RequestPromise

    • Parameters

      • url: string
      • Optional options: IOptions

      Returns request.RequestPromise

Optional localAddress

localAddress: string

Optional maxRedirects

maxRedirects: number

Optional method

method: string

Optional multipart

multipart: RequestPart[] | Multipart

Optional oauth

oauth: OAuthOptions

Optional passphrase

passphrase: string

Optional pool

pool: any

Optional port

port: number

Optional postambleCRLF

postambleCRLF: boolean

Optional preambleCRLF

preambleCRLF: boolean

Optional proxy

proxy: any

Optional qs

qs: any

Optional qsParseOptions

qsParseOptions: any

Optional qsStringifyOptions

qsStringifyOptions: any

Optional rejectUnauthorized

rejectUnauthorized: boolean

Optional removeRefererHeader

removeRefererHeader: boolean

Optional resolveWithFullResponse

resolveWithFullResponse: boolean

Optional retry

retry: number

Optional simple

simple: boolean

Optional strictSSL

strictSSL: boolean

Optional time

time: boolean

Optional timeout

timeout: number

Optional transform2xxOnly

transform2xxOnly: boolean

Optional tunnel

tunnel: boolean

Optional useQuerystring

useQuerystring: boolean

Optional withCredentials

withCredentials: boolean

Methods

Optional transform

  • transform(body: any, response: Response, resolveWithFullResponse?: boolean): any

  • Parameters

    • body: any
    • response: Response
    • Optional resolveWithFullResponse: boolean

    Returns any

Generated using TypeDoc