Class TestUserAgent

Test user-agent class.

Hierarchy (View Summary)

MockUserAgent
- TestUserAgent

Index

Constructors

Properties

_assert _dom _finished _messages _res _sse _sseEvents _stack _ws baseURL body cookieJar hooks httpsTransport httpTransport maxRedirects name server wsTransport

Accessors

_html _sseIterator res sse ws

Constructors

constructor

new TestUserAgent(options?: TestUserAgentOptions): TestUserAgent
Parameters
- options: TestUserAgentOptions = {}
Returns TestUserAgent
Overrides MockUserAgent.constructor
- Defined in mojo.js-main/src/user-agent/test.ts:53

Properties

_assert

_assert: typeof strict | TestContext | undefined = undefined

_dom

_dom: DOM | undefined = undefined

_finished

_finished: [number, string] | null | undefined = undefined

_messages

_messages: AsyncIterableIterator<JSONValue, any, any> | undefined = undefined

_res

_res: UserAgentResponse | undefined = undefined

_sse

_sse: SSEEvent | undefined = undefined

_sseEvents

_sseEvents: AsyncIterator<SSEEvent, any, any> | undefined = undefined

_stack

_stack: StackUtils = ...

_ws

_ws: WebSocket | undefined = undefined

baseURL

baseURL: string | URL | undefined

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

body

body: Buffer = ...

Current HTTP response content.

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.

Accessors

_html

get _html(): DOM
Returns DOM
- Defined in mojo.js-main/src/user-agent/test.ts:504

_sseIterator

get _sseIterator(): AsyncIterator<SSEEvent>
Returns AsyncIterator<SSEEvent>
- Defined in mojo.js-main/src/user-agent/test.ts:540

res

get res(): UserAgentResponse
Current HTTP response.

Returns UserAgentResponse
- Defined in mojo.js-main/src/user-agent/test.ts:290

sse

get sse(): SSEEvent
Current Server-Sent Event. Note that this property is EXPERIMENTAL and might change without warning!

Returns SSEEvent
- Defined in mojo.js-main/src/user-agent/test.ts:307

ws

get ws(): WebSocket
Active WebSocket connection.

Returns WebSocket
- Defined in mojo.js-main/src/user-agent/test.ts:479

Methods

_filterConfig

_filterConfig(config: UserAgentRequestOptions): Promise<Record<string, any>>
Parameters
- config: UserAgentRequestOptions
Returns Promise<Record<string, any>>
Inherited from MockUserAgent._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 MockUserAgent._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 MockUserAgent._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 MockUserAgent._handleRedirect
- Defined in mojo.js-main/src/user-agent.ts:242

_prepareTap

_prepareTap(tap: TestContext): void
Parameters
- tap: TestContext
Returns void
- Defined in mojo.js-main/src/user-agent/test.ts:509

_requestConfig

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

_requestOk

_requestOk(
    skip: SkipFunction,
    method: string,
    url: string | URL,
    options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Parameters
- skip: SkipFunction
- method: string
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:527

_sseOk

_sseOk(
    skip: SkipFunction,
    method: string,
    url: string | URL,
    options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Parameters
- skip: SkipFunction
- method: string
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:546

_waitFinished

_waitFinished(): Promise<void>
Returns Promise<void>
- Defined in mojo.js-main/src/user-agent/test.ts:560

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
Inherited from MockUserAgent.[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 MockUserAgent.addHook
- Defined in mojo.js-main/src/user-agent.ts:71

assert

assert(name: string, args: any[], msg: string, skip: SkipFunction): void
Delegate assertion to test framework currently in use.
Parameters
- name: string
- args: any[]
- msg: string
- skip: SkipFunction
Returns void
- Defined in mojo.js-main/src/user-agent/test.ts:61

bodyIs

bodyIs(body: string): this
Check response content for exact match.
Parameters
- body: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:69

bodyIsnt

bodyIsnt(body: string): this
Opposite of bodyIs.
Parameters
- body: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:77

bodyLike

bodyLike(regex: RegExp): this
Check response content for similar match.
Parameters
- regex: RegExp
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:85

bodyUnlike

bodyUnlike(regex: RegExp): this
Opposite of bodyLike.
Parameters
- regex: RegExp
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:93

closedOk

closedOk(code: number): Promise<void>
Wait for WebSocket connection to be closed gracefully and check status.
Parameters
- code: number
Returns Promise<void>
- Defined in mojo.js-main/src/user-agent/test.ts:110

closeOk

closeOk(code: number, reason: string): Promise<void>
Close WebSocket connection gracefully.
Parameters
- code: number
- reason: string
Returns Promise<void>
- Defined in mojo.js-main/src/user-agent/test.ts:101

delete

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

deleteOk

deleteOk(
url: string | URL,
options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Perform a DELETE request and check for transport errors.
Parameters
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:119

destroy

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

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

elementExists

elementExists(selector: string): this
Checks for existence of the CSS selectors first matching HTML/XML element.
Parameters
- selector: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:126

elementExistsNot

elementExistsNot(selector: string): this
Opposite of elementExists.
Parameters
- selector: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:135

get

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

getOk

getOk(
url: string | URL,
options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Perform a GET request and check for transport errors.
Parameters
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:144

getSSEOk

getSSEOk(
url: string | URL,
options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Perform a GET request and check for transport errors, but leave the response body for Server-Sent Events. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:152

head

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

headerExists

headerExists(name: string): this
Check if response header exists.
Parameters
- name: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:166

headerExistsNot

headerExistsNot(name: string): this
Opposite of headerExists.
Parameters
- name: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:174

headerIs

headerIs(name: string, value: string): this
Check response header for exact match.
Parameters
- name: string
- value: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:182

headerIsnt

headerIsnt(name: string, value: string): this
Opposite of headerIs.
Parameters
- name: string
- value: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:190

headerLike

headerLike(name: string, regex: RegExp): this
Check response header for similar match.
Parameters
- name: string
- regex: RegExp
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:198

headOk

headOk(
url: string | URL,
options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Perform a HEAD request and check for transport errors.
Parameters
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:159

jsonHas

jsonHas(pointer: string): this
Check if JSON response contains a value that can be identified using the given JSON Pointer.
Parameters
- pointer: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:206

jsonIs

jsonIs(value: JSONValue, pointer?: string): this
Check the value extracted from JSON response using the given JSON Pointerr, which defaults to the root value if it is omitted.
Parameters
- value: JSONValue
- pointer: string = ''
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:216

messageOk

messageOk(): Promise<JSONValue>
Wait for next WebSocket message to arrive.

Returns Promise<JSONValue>
- Defined in mojo.js-main/src/user-agent/test.ts:225

options

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

optionsOk

optionsOk(
url: string | URL,
options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Perform a OPTIONS request and check for transport errors.
Parameters
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:247

patch

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

patchOk

patchOk(
url: string | URL,
options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Perform a PATCH request and check for transport errors.
Parameters
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:254

post

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

postOk

postOk(
url: string | URL,
options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Perform a POST request and check for transport errors.
Parameters
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:261

postSSEOk

postSSEOk(
url: string | URL,
options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Perform a POST request and check for transport errors, but leave the response body for Server-Sent Events. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:269

put

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

putOk

putOk(
url: string | URL,
options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Perform a PUT request and check for transport errors.
Parameters
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:276

query

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

queryOk

queryOk(
url: string | URL,
options?: UserAgentRequestOptions,
): Promise<TestUserAgent>
Perform a QUERY request and check for transport errors.
Parameters
- url: string | URL
- Optionaloptions: UserAgentRequestOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:283

request

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

sendOk

sendOk(message: any): Promise<void>
Send message or frame via WebSocket.
Parameters
- message: any
Returns Promise<void>
- Defined in mojo.js-main/src/user-agent/test.ts:299

sseFinishedOk

sseFinishedOk(): Promise<TestUserAgent>
Wait for Server-Sent Events connection to be closed by the server. Note that this method is EXPERIMENTAL and might change without warning!

Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:327

sseFinishOk

sseFinishOk(): Promise<TestUserAgent>
Close Server-Sent Events connection. Note that this method is EXPERIMENTAL and might change without warning!

Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:316

sseIdIs

sseIdIs(id: string | null): this
Check Server-Sent Event id for exact match. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- id: string | null
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:338

sseIdIsnt

sseIdIsnt(id: string | null): this
Opposite of sseIdIs. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- id: string | null
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:346

sseOk

sseOk(): Promise<TestUserAgent>
Wait for next Server-Sent Event to arrive. Note that this method is EXPERIMENTAL and might change without warning!

Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:354

sseTextIs

sseTextIs(text: string): this
Check Server-Sent Event text for exact match. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- text: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:365

sseTextIsnt

sseTextIsnt(text: string): this
Opposite of sseTextIs. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- text: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:373

sseTextLike

sseTextLike(regex: RegExp): this
Check Server-Sent Event text for similar match. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- regex: RegExp
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:382

sseTextUnlike

sseTextUnlike(regex: RegExp): this
Opposite of sseTextLike. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- regex: RegExp
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:390

sseTypeIs

sseTypeIs(type: string): this
Check Server-Sent Event type for exact match. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- type: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:399

sseTypeIsnt

sseTypeIsnt(type: string): this
Opposite of sseTypeIs. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- type: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:407

start

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

statusIs

statusIs(status: number): this
Check response status for exact match.
Parameters
- status: number
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:415

stop

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

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

textLike

textLike(selector: string, regex: RegExp): this
Checks text content of the CSS selectors first matching HTML/XML element for similar match.
Parameters
- selector: string
- regex: RegExp
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:423

textUnlike

textUnlike(selector: string, regex: RegExp): this
Checks text content of the CSS selectors first matching HTML/XML element for no match.
Parameters
- selector: string
- regex: RegExp
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:436

typeIs

typeIs(value: string): this
Check response Content-Type header for exact match.
Parameters
- value: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:449

typeLike

typeLike(regex: RegExp): this
Check response Content-Type header for similar match.
Parameters
- regex: RegExp
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:457

websocket

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

websocketOk

websocketOk(
url: string | URL,
options?: UserAgentWebSocketOptions,
): Promise<void>
Open a WebSocket connection with transparent handshake.
Parameters
- url: string | URL
- Optionaloptions: UserAgentWebSocketOptions
Returns Promise<void>
- Defined in mojo.js-main/src/user-agent/test.ts:465

yamlHas

yamlHas(pointer: string): this
Check if YAML response contains a value that can be identified using the given JSON Pointer.
Parameters
- pointer: string
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:488

yamlIs

yamlIs(value: JSONValue, pointer?: string): this
Check the value extracted from YAML response using the given JSON Pointerr, which defaults to the root value if it is omitted.
Parameters
- value: JSONValue
- pointer: string = ''
Returns this
- Defined in mojo.js-main/src/user-agent/test.ts:498

`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>
Inherited from MockUserAgent.newMockUserAgent
- Defined in mojo.js-main/src/user-agent/mock.ts:28

`Static`newTestUserAgent

newTestUserAgent(
    app: App,
    options?: TestUserAgentOptions,
    serverOptions?: ServerOptions,
): Promise<TestUserAgent>
Create a new test user-agent.
Parameters
- app: App
- Optionaloptions: TestUserAgentOptions
- OptionalserverOptions: ServerOptions
Returns Promise<TestUserAgent>
- Defined in mojo.js-main/src/user-agent/test.ts:235

Class TestUserAgent

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TestUserAgent

Properties

_assert

_dom

_finished

_messages

_res

_sse

_sseEvents

_stack

_ws

baseURL

body

cookieJar

hooks

httpsTransport

httpTransport

maxRedirects

name

server

wsTransport

Accessors

_html

Returns DOM

_sseIterator

Returns AsyncIterator<SSEEvent>

res

Returns UserAgentResponse

sse

Returns SSEEvent

ws

Returns WebSocket

Methods

_filterConfig

Parameters

Returns Promise<Record<string, any>>

_filterSharedConfig

Parameters

Returns Promise<Record<string, any>>

_formData

Parameters

Returns FormData

_handleRedirect

Parameters

Returns Promise<UserAgentResponse>

_prepareTap

Parameters

Returns void

_requestConfig

Parameters

Returns Promise<UserAgentResponse>

_requestOk

Parameters

Returns Promise<TestUserAgent>

_sseOk

Parameters

Returns Promise<TestUserAgent>

_waitFinished

Returns Promise<void>

[asyncDispose]

Returns Promise<void>

addHook

Parameters

Returns this

assert

Parameters

Returns void

bodyIs

Parameters

Returns this