Class UserAgent

HTTP and WebSocket user-agent.

Hierarchy

UserAgent
- MockUserAgent

Index

Constructors

constructor

new UserAgent(options?): UserAgent
Parameters
- options: UserAgentOptions = {}
Returns UserAgent
- Defined in mojo.js-main/src/user-agent.ts:58

Properties

baseURL

baseURL: undefined | string | URL

Base URL to be used to resolve all relative request URLs with.

cookieJar

cookieJar: null | CookieJar = ...

Cookie jar to use.

hooks

hooks: AsyncHooks = ...

User-agent hooks.

httpTransport

httpTransport: HTTPTransport = ...

Transport backend to perform HTTP requests with.

httpsTransport

httpsTransport: HTTPSTransport = ...

Transport backend to perform HTTPS requests with.

maxRedirects

maxRedirects: number

Maximum number of redirects to follow, default to 0.

name

name: undefined | string

Name of user-agent to send with User-Agent header.

wsTransport

wsTransport: WSTransport = ...

Transport backend to use for WebSocket connections.

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Returns Promise<void>
- Defined in mojo.js-main/src/user-agent.ts:64

_filterConfig

_filterConfig(config): Promise<Record<string, any>>
Parameters
- config: UserAgentRequestOptions
Returns Promise<Record<string, any>>
- Defined in mojo.js-main/src/user-agent.ts:165

_filterSharedConfig

_filterSharedConfig(config): Promise<Record<string, any>>
Parameters
- config: UserAgentRequestOptions | UserAgentWebSocketOptions
Returns Promise<Record<string, any>>
- Defined in mojo.js-main/src/user-agent.ts:189

_formData

_formData(values?): FormData
Parameters
- values: Record<string, string | Upload> = {}
Returns FormData
- Defined in mojo.js-main/src/user-agent.ts:218

_handleRedirect

_handleRedirect(config, res): Promise<UserAgentResponse>
Parameters
- config: Record<string, any>
- res: UserAgentResponse
Returns Promise<UserAgentResponse>
- Defined in mojo.js-main/src/user-agent.ts:230

_requestConfig

_requestConfig(method, url?, options?): Promise<UserAgentResponse>
Parameters
- method: string
- url: string | URL = '/'
- Optional options: UserAgentRequestOptions
Returns Promise<UserAgentResponse>
- Defined in mojo.js-main/src/user-agent.ts:266

addHook

addHook(name, fn): UserAgent
Add a hook to extend the user-agent.
Parameters
- name: string
- fn: UserAgentHook
Returns UserAgent
- Defined in mojo.js-main/src/user-agent.ts:71

delete

delete(url, options): Promise<UserAgentResponse>
Perform DELETE request.
Parameters
- url: string | URL
- options: UserAgentRequestOptions
Returns Promise<UserAgentResponse>
- Defined in mojo.js-main/src/user-agent.ts:87

destroy

destroy(): Promise<void>
Destroy all active keep-alive connections.

Returns Promise<void>
- Defined in mojo.js-main/src/user-agent.ts:79

get

get(url, options): Promise<UserAgentResponse>
Perform GET request.
Parameters
- url: string | URL
- options: UserAgentRequestOptions
Returns Promise<UserAgentResponse>
- Defined in mojo.js-main/src/user-agent.ts:94

head

head(url, options): Promise<UserAgentResponse>
Perform HEAD request.
Parameters
- url: string | URL
- options: UserAgentRequestOptions
Returns Promise<UserAgentResponse>
- Defined in mojo.js-main/src/user-agent.ts:101

options

options(url, options): Promise<UserAgentResponse>
Perform OPTIONS request.
Parameters
- url: string | URL
- options: UserAgentRequestOptions
Returns Promise<UserAgentResponse>
- Defined in mojo.js-main/src/user-agent.ts:108

patch

patch(url, options): Promise<UserAgentResponse>
Perform PATCH request.
Parameters
- url: string | URL
- options: UserAgentRequestOptions
Returns Promise<UserAgentResponse>
- Defined in mojo.js-main/src/user-agent.ts:115

post

post(url, options): Promise<UserAgentResponse>
Perform POST request.
Parameters
- url: string | URL
- options: UserAgentRequestOptions
Returns Promise<UserAgentResponse>
- Defined in mojo.js-main/src/user-agent.ts:122

put

put(url, options): Promise<UserAgentResponse>
Perform PUT request.
Parameters
- url: string | URL
- options: UserAgentRequestOptions
Returns Promise<UserAgentResponse>
- Defined in mojo.js-main/src/user-agent.ts:129

request

request(config): Promise<UserAgentResponse>
Perform HTTP request.
Parameters
- config: UserAgentRequestOptions
Returns Promise<UserAgentResponse>
- Defined in mojo.js-main/src/user-agent.ts:136

websocket

websocket(url, options?): Promise<WebSocket>
Open WebSocket connection.
Parameters
- url: string | URL
- options: UserAgentWebSocketOptions = {}
Returns Promise<WebSocket>
- Defined in mojo.js-main/src/user-agent.ts:155

Class UserAgent

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: UserAgentOptions = {}

Returns UserAgent

Properties

baseURL

cookieJar

hooks

httpTransport

httpsTransport

maxRedirects

name

wsTransport

Methods

[asyncDispose]

Returns Promise<void>

_filterConfig

Parameters

config: UserAgentRequestOptions

Returns Promise<Record<string, any>>

_filterSharedConfig

Parameters

config: UserAgentRequestOptions | UserAgentWebSocketOptions

Returns Promise<Record<string, any>>

_formData

Parameters

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

Returns FormData

_handleRedirect

Parameters

config: Record<string, any>

res: UserAgentResponse

Returns Promise<UserAgentResponse>

_requestConfig

Parameters

method: string

url: string | URL = '/'

Optional options: UserAgentRequestOptions

Returns Promise<UserAgentResponse>

addHook

Parameters

name: string

fn: UserAgentHook

Returns UserAgent

delete

Parameters

url: string | URL

options: UserAgentRequestOptions

Returns Promise<UserAgentResponse>

destroy

Returns Promise<void>

get

Parameters

url: string | URL

options: UserAgentRequestOptions

Returns Promise<UserAgentResponse>

head

Parameters

url: string | URL

options: UserAgentRequestOptions

Returns Promise<UserAgentResponse>

options

Parameters

url: string | URL

options: UserAgentRequestOptions

Returns Promise<UserAgentResponse>

patch

Parameters

url: string | URL

options: UserAgentRequestOptions

Returns Promise<UserAgentResponse>

post

Parameters

`Optional` options: UserAgentRequestOptions