Class UserAgent

constructor

• new UserAgent(options?: UserAgentOptions): UserAgent

  Parameters

  • options: UserAgentOptions = {}

  Returns UserAgent

baseURL

cookieJar

hooks

httpsTransport

httpTransport

maxRedirects

name

wsTransport

_filterConfig

• _filterConfig(config: UserAgentRequestOptions): Promise<Record<string, any>>

  Parameters

  • config: UserAgentRequestOptions

  Returns Promise<Record<string, any>>

_filterSharedConfig

• _filterSharedConfig(
      options: UserAgentRequestOptions | UserAgentWebSocketOptions,
  ): Promise<Record<string, any>>

  Parameters

  • options: UserAgentRequestOptions | UserAgentWebSocketOptions

  Returns Promise<Record<string, any>>

_formData

• _formData(values?: Record<string, string | Upload>): FormData

  Parameters

  • values: Record<string, string | Upload> = {}

  Returns FormData

_handleRedirect

• _handleRedirect(
      config: Record<string, any>,
      base: URL,
      res: UserAgentResponse,
  ): Promise<UserAgentResponse>

  Parameters

  • config: Record<string, any>
  • base: URL
  • res: UserAgentResponse

  Returns Promise<UserAgentResponse>

_requestConfig

• _requestConfig(
      method: string,
      url?: string | URL,
      options?: UserAgentRequestOptions,
  ): Promise<UserAgentResponse>

  Parameters

  • method: string
  • url: string | URL = '/'
  • Optionaloptions: UserAgentRequestOptions

  Returns Promise<UserAgentResponse>

[asyncDispose]

• "[asyncDispose]"(): Promise<void>

  Returns Promise<void>

addHook

• addHook(name: string, fn: UserAgentHook): this

  Add a hook to extend the user-agent.

  Parameters

  • name: string
  • fn: UserAgentHook

  Returns this

delete

• delete(
      url: string | URL,
      options?: UserAgentRequestOptions,
  ): Promise<UserAgentResponse>

  Perform DELETE request.

  Parameters

  • url: string | URL
  • Optionaloptions: UserAgentRequestOptions

  Returns Promise<UserAgentResponse>

destroy

• destroy(): Promise<void>

  Destroy all active keep-alive connections.

  Returns Promise<void>

get

• get(
      url: string | URL,
      options?: UserAgentRequestOptions,
  ): Promise<UserAgentResponse>

  Perform GET request.

  Parameters

  • url: string | URL
  • Optionaloptions: UserAgentRequestOptions

  Returns Promise<UserAgentResponse>

head

• head(
      url: string | URL,
      options?: UserAgentRequestOptions,
  ): Promise<UserAgentResponse>

  Perform HEAD request.

  Parameters

  • url: string | URL
  • Optionaloptions: UserAgentRequestOptions

  Returns Promise<UserAgentResponse>

options

• options(
      url: string | URL,
      options?: UserAgentRequestOptions,
  ): Promise<UserAgentResponse>

  Perform OPTIONS request.

  Parameters

  • url: string | URL
  • Optionaloptions: UserAgentRequestOptions

  Returns Promise<UserAgentResponse>

patch

• patch(
      url: string | URL,
      options?: UserAgentRequestOptions,
  ): Promise<UserAgentResponse>

  Perform PATCH request.

  Parameters

  • url: string | URL
  • Optionaloptions: UserAgentRequestOptions

  Returns Promise<UserAgentResponse>

post

• post(
      url: string | URL,
      options?: UserAgentRequestOptions,
  ): Promise<UserAgentResponse>

  Perform POST request.

  Parameters

  • url: string | URL
  • Optionaloptions: UserAgentRequestOptions

  Returns Promise<UserAgentResponse>

put

• put(
      url: string | URL,
      options?: UserAgentRequestOptions,
  ): Promise<UserAgentResponse>

  Perform PUT request.

  Parameters

  • url: string | URL
  • Optionaloptions: UserAgentRequestOptions

  Returns Promise<UserAgentResponse>

query

• query(
      url: string | URL,
      options?: UserAgentRequestOptions,
  ): Promise<UserAgentResponse>

  Perform QUERY request.

  Parameters

  • url: string | URL
  • Optionaloptions: UserAgentRequestOptions

  Returns Promise<UserAgentResponse>

request

• request(config: UserAgentRequestOptions): Promise<UserAgentResponse>

  Perform HTTP request.

  Parameters

  • config: UserAgentRequestOptions

  Returns Promise<UserAgentResponse>

websocket

• websocket(
      url: string | URL,
      options?: UserAgentWebSocketOptions,
  ): Promise<WebSocket>

  Open WebSocket connection.

  Parameters

  • url: string | URL
  • options: UserAgentWebSocketOptions = {}

  Returns Promise<WebSocket>