Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NormalOptions

Hierarchy

  • NormalizedOptions
    • NormalOptions

Index

Properties

[requestSymbol]

[requestSymbol]: RequestFunction

Optional appVersion

appVersion: undefined | false | true

Optional bsgAgent

bsgAgent: undefined | false | true

Optional bsgSession

bsgSession: undefined | false | true

cache

cache: CacheableRequest.StorageAdapter | false

Optional cacheableRequest

cacheableRequest: undefined | ((options: string | URL | RequestOptions, callback?: undefined | ((response: ServerResponse | ResponseLike) => void)) => Emitter)

context

context: {}

Type declaration

  • [key: string]: any

Optional cookieJar

cookieJar: PromiseCookieJar

decompress

decompress: boolean

dnsCache

dnsCache: CacheableLookup | false

followRedirect

followRedirect: boolean

Optional hash

hash: undefined | string

headers

headers: Headers

hooks

hooks: Required<Hooks>

Optional host

host: undefined | string

Optional hostname

hostname: undefined | string

Optional href

href: undefined | string

ignoreInvalidCookies

ignoreInvalidCookies: boolean

isStream

isStream: boolean

Optional lookup

lookup: CacheableLookup["lookup"]

maxRedirects

maxRedirects: number

method

method: Method

methodRewriting

methodRewriting: boolean

Optional origin

origin: undefined | string

Optional pagination

pagination: Required<PaginationOptions<unknown>["_pagination"]>

Optional password

password: undefined | string

Optional path

path: undefined | string

Optional pathname

pathname: undefined | string

Optional port

port: string | number

prefixUrl

prefixUrl: string

Optional protocol

protocol: undefined | string

Optional requestId

requestId: undefined | false | true

resolveBodyOnly

resolveBodyOnly: boolean

responseType

responseType: ResponseType

retry

retry: Required<RetryOptions>

Optional search

search: undefined | string

Optional searchParams

searchParams: Record<string, string | number | boolean | null> | URLSearchParams | string

throwHttpErrors

throwHttpErrors: boolean

timeout

timeout: Delays

Optional unityAgent

unityAgent: undefined | false | true

url

url: URL

useElectronNet

useElectronNet: boolean

Optional username

username: undefined | string

Generated using TypeDoc