Class MockUserAgent

Mock user-agent class.

Hierarchy (View Summary)

UserAgent
- MockUserAgent
  - TestUserAgent

Index

Constructors

constructor

Properties

baseURL cookieJar hooks httpsTransport httpTransport maxRedirects name server wsTransport

Constructors

constructor

new MockUserAgent(options?: UserAgentOptions): MockUserAgent
Parameters
- Optionaloptions: UserAgentOptions
Returns MockUserAgent
Overrides UserAgent.constructor
- Defined in mojo.js-main/src/user-agent/mock.ts:15

Properties

baseURL

baseURL: string | URL | undefined

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

cookieJar

cookieJar: CookieJar | null = ...

Cookie jar to use.

hooks

hooks: AsyncHooks = ...

User-agent hooks.

httpsTransport

httpsTransport: HTTPSTransport = ...

Transport backend to perform HTTPS requests with.

httpTransport

httpTransport: HTTPTransport = ...

Transport backend to perform HTTP requests with.

maxRedirects

maxRedirects: number

Maximum number of redirects to follow, default to 0.

name

name: string | undefined

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

server

server: Server | undefined = undefined

Server to use for mock requests.

wsTransport

wsTransport: WSTransport = ...

Transport backend to use for WebSocket connections.

Methods

_filterConfig

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

_filterSharedConfig

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

_formData

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

_handleRedirect

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

_requestConfig

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

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
Overrides UserAgent.[asyncDispose]
- Defined in mojo.js-main/src/user-agent/mock.ts:21

addHook

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

delete

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

destroy

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

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

get

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

head

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

options

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

patch

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

post

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

put

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

query

query(
url: string | URL,
options?: UserAgentRequestOptions,
): Promise<UserAgentResponse>
Perform QUERY request.
Parameters
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<UserAgentResponse>
Inherited from UserAgent.query
- Defined in mojo.js-main/src/user-agent.ts:136

request

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

start

start(
app: App,
options?: ServerOptions & { https?: boolean },
): Promise<MockUserAgent>
Start mock server.
Parameters
- app: App
- options: ServerOptions & { https?: boolean } = {}
Returns Promise<MockUserAgent>
- Defined in mojo.js-main/src/user-agent/mock.ts:39

stop

stop(): Promise<void>
Stop mock server.

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

websocket

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

`Static`newMockUserAgent

newMockUserAgent(
    app: App,
    options?: UserAgentOptions,
    serverOptions?: ServerOptions,
): Promise<MockUserAgent>
Create a new mock user-agent.
Parameters
- app: App
- Optionaloptions: UserAgentOptions
- OptionalserverOptions: ServerOptions
Returns Promise<MockUserAgent>
- Defined in mojo.js-main/src/user-agent/mock.ts:28

Class MockUserAgent

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MockUserAgent

Properties

baseURL

cookieJar

hooks

httpsTransport

httpTransport

maxRedirects

name

server

wsTransport

Methods

_filterConfig

Parameters

Returns Promise<Record<string, any>>

_filterSharedConfig

Parameters

Returns Promise<Record<string, any>>

_formData

Parameters

Returns FormData

_handleRedirect

Parameters

Returns Promise<UserAgentResponse>

_requestConfig

Parameters

Returns Promise<UserAgentResponse>

[asyncDispose]

Returns Promise<void>

addHook

Parameters

Returns this

delete

Parameters

Returns Promise<UserAgentResponse>

destroy

Returns Promise<void>

get

Parameters

Returns Promise<UserAgentResponse>

head

Parameters

Returns Promise<UserAgentResponse>

options

Parameters

Returns Promise<UserAgentResponse>

patch

Parameters

Returns Promise<UserAgentResponse>

post

Parameters

Returns Promise<UserAgentResponse>

put

Parameters

Returns Promise<UserAgentResponse>

query

Parameters

Returns Promise<UserAgentResponse>

request

Parameters

Returns Promise<UserAgentResponse>

start

Parameters

Returns Promise<MockUserAgent>

stop

Returns Promise<void>

websocket

Parameters

Returns Promise<WebSocket>

StaticnewMockUserAgent

Parameters

`Static`newMockUserAgent