Class TestUserAgent

Test user-agent class.

Hierarchy

MockUserAgent
- TestUserAgent

Constructors

constructor

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

Properties

_assert

_assert: undefined | Omit<typeof assert, "strict" | "ok" | "equal" | "notEqual" | "deepEqual" | "notDeepEqual" | "strictEqual" | "deepStrictEqual" | "ifError"> & {
    deepEqual: (<T>(actual, expected, message?) => asserts actual is T);
    deepStrictEqual: (<T>(actual, expected, message?) => asserts actual is T);
    equal: (<T>(actual, expected, message?) => asserts actual is T);
    ifError: ((value) => asserts value is undefined | null);
    notDeepEqual: ((actual, expected, message?) => void);
    notEqual: ((actual, expected, message?) => void);
    ok: ((value, message?) => asserts value);
    strict: Omit<typeof assert, "strict" | "ok" | "equal" | "notEqual" | "deepEqual" | "notDeepEqual" | "strictEqual" | "deepStrictEqual" | "ifError"> & ({ (value: unknown, message?: string | Error | undefined): asserts value; equal: <T>(actual: unknown, expected: T, message?: string | Error | undefined) => asserts actual is T; notEqual: (actual: unknown, expected: unknown, message?: string | Error | undefined) => void; deepEqual: <T>(actual: unknown, expected: T, message?: string | Error | undefined) => asserts actual is T; notDeepEqual: (actual: unknown, expected: unknown, message?: string | Error | undefined) => void; ok: (value: unknown, message?: string | Error | undefined) => asserts value; strictEqual: <T>(actual: unknown, expected: T, message?: string | Error | undefined) => asserts actual is T; deepStrictEqual: <T>(actual: unknown, expected: T, message?: string | Error | undefined) => asserts actual is T; ifError: (value: unknown) => asserts value is null | undefined; strict: Omit<typeof assert, "strict" | "ok" | "equal" | "notEqual" | "deepEqual" | "notDeepEqual" | "strictEqual" | "deepStrictEqual" | "ifError"> & any; });
    strictEqual: (<T>(actual, expected, message?) => asserts actual is T);
    (value, message?): asserts value;
} | TestContext = undefined

_dom

_dom: undefined | default = undefined

_finished

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

_messages

_messages: undefined | AsyncIterableIterator<JSONValue> = undefined

_res

_res: undefined | UserAgentResponse = undefined

_stack

_stack: StackUtils = ...

_ws

_ws: undefined | WebSocket = undefined

baseURL

baseURL: undefined | string | URL

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

body

body: Buffer = ...

Current HTTP response content.

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.

server

server: undefined | Server = undefined

Server to use for mock requests.

wsTransport

wsTransport: WSTransport = ...

Transport backend to use for WebSocket connections.

Accessors

_html

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

res

get res(): UserAgentResponse
Current HTTP response.

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

ws

get ws(): WebSocket
Active WebSocket connection.

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

Methods

[asyncDispose]

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

_filterConfig

_filterConfig(config): 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:165

_filterSharedConfig

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

_formData

_formData(values?): FormData
Parameters
- values: Record<string, string | Upload> = {}
Returns FormData
Inherited from MockUserAgent._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>
Inherited from MockUserAgent._handleRedirect
- Defined in mojo.js-main/src/user-agent.ts:230

_prepareTap

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

_requestConfig

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

_requestOk

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

_waitFinished

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

addHook

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

assert

assert(name, args, msg, skip): 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:58

bodyIs

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

bodyIsnt

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

bodyLike

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

bodyUnlike

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

closeOk

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

closedOk

closedOk(code): 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:107

delete

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

deleteOk

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

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): TestUserAgent
Checks for existence of the CSS selectors first matching HTML/XML element.
Parameters
- selector: string
Returns TestUserAgent
- Defined in mojo.js-main/src/user-agent/test.ts:123

elementExistsNot

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

get

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

getOk

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

head

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

headOk

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

headerExists

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

headerExistsNot

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

headerIs

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

headerIsnt

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

headerLike

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

jsonHas

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

jsonIs

jsonIs(value, pointer?): TestUserAgent
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 TestUserAgent
- Defined in mojo.js-main/src/user-agent/test.ts:205

messageOk

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

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

options

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

optionsOk

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

patch

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

patchOk

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

post

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

postOk

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

put

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

putOk

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

request

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

sendOk

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

start

start(app, options?): 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): TestUserAgent
Check response status for exact match.
Parameters
- status: number
Returns TestUserAgent
- Defined in mojo.js-main/src/user-agent/test.ts:281

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, regex): TestUserAgent
Checks text content of the CSS selectors first matching HTML/XML element for similar match.
Parameters
- selector: string
- regex: RegExp
Returns TestUserAgent
- Defined in mojo.js-main/src/user-agent/test.ts:289

textUnlike

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

typeIs

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

typeLike

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

websocket

websocket(url, options?): 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:155

websocketOk

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

yamlHas

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

yamlIs

yamlIs(value, pointer?): TestUserAgent
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 TestUserAgent
- Defined in mojo.js-main/src/user-agent/test.ts:364

`Static` newMockUserAgent

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

`Static` newTestUserAgent

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

Class TestUserAgent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: TestUserAgentOptions = {}

Returns TestUserAgent

Properties

_assert

_dom

_finished

_messages

_res

_stack

_ws

baseURL

body

cookieJar

hooks

httpTransport

httpsTransport

maxRedirects

name

server

wsTransport

Accessors

_html

Returns default

res

Returns UserAgentResponse

ws

Returns WebSocket

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>

_prepareTap

Parameters

tap: TestContext

Returns void

_requestConfig

Parameters

method: string

url: string | URL = '/'

Optional options: UserAgentRequestOptions

Returns Promise<UserAgentResponse>

_requestOk

Parameters

skip: SkipFunction

method: string

url: string | URL

Optional options: UserAgentRequestOptions

Returns Promise<TestUserAgent>

_waitFinished

Returns Promise<void>

addHook

Parameters

name: string

fn: UserAgentHook

`Optional` options: UserAgentRequestOptions

`Optional` options: UserAgentRequestOptions

`Optional` options: UserAgentRequestOptions

`Optional` options: UserAgentRequestOptions