HttpRequest <TResponseType>

HTTP Request as accepted by BaseHttpClient methods.

Hierarchy

• HttpRequest
  • HttpRequestOptions

Index

Properties

• body
• cookieJar
• encoding
• followRedirect
• headerGenerator
• headerGeneratorOptions
• headers
• insecureHTTPParser
• maxRedirects
• method
• proxyUrl
• responseType
• sessionToken
• signal
• throwHttpErrors
• timeout
• url
• useHeaderGenerator

Properties

optionalbody

body?: string | Readable | Buffer | Generator<unknown, any, any> | AsyncGenerator<unknown, any, any> | FormDataLike

optionalcookieJar

cookieJar?: ToughCookieJar | PromiseCookieJar

optionalencoding

encoding?: BufferEncoding

optionalfollowRedirect

followRedirect?: boolean | (response: any) => boolean

optionalheaderGenerator

headerGenerator?: { getHeaders: (options: Record<string, unknown>) => Record<string, string> }

Type declaration

• getHeaders: (options: Record<string, unknown>) => Record<string, string>

  • • (options: Record<string, unknown>): Record<string, string>

    • Parameters

      • options: Record<string, unknown>

      Returns Record<string, string>

optionalheaderGeneratorOptions

headerGeneratorOptions?: Record<string, unknown>

optionalheaders

headers?: SimpleHeaders

optionalinsecureHTTPParser

insecureHTTPParser?: boolean

optionalmaxRedirects

maxRedirects?: number

optionalmethod

method?: Method

optionalproxyUrl

proxyUrl?: string

optionalresponseType

responseType?: TResponseType

optionalsessionToken

sessionToken?: object

optionalsignal

signal?: AbortSignal

optionalthrowHttpErrors

throwHttpErrors?: boolean

optionaltimeout

timeout?: Partial<Timeout>

url

url: string | URL

optionaluseHeaderGenerator

useHeaderGenerator?: boolean