Interface: RenderResult<C>

Defined in: types.ts:52

Extends

• QueryHelpers

Type Parameters

C

C extends Controller = Controller

Properties

application

application: Application

Defined in: types.ts:55

---

controller

controller: C

Defined in: types.ts:53

---

element

element: HTMLElement

Defined in: types.ts:54

---

user

user: UserEvent

Defined in: types.ts:56

---

waitFor

waitFor: <T>(cb, opts?) => Promise<T>

Defined in: types.ts:57

Type Parameters

T

T

Parameters

cb

() => T | Promise<T>

opts?

WaitForOptions

Returns

Promise<T>

Methods

findByLabelText()

findByLabelText(text, opts?): Promise<HTMLElement>

Defined in: types.ts:49

Parameters

text

string | RegExp

opts?

WaitForOptions

Returns

Promise<HTMLElement>

Inherited from

QueryHelpers.findByLabelText

---

findByRole()

findByRole(role, opts?): Promise<HTMLElement>

Defined in: types.ts:39

Parameters

role

string

opts?

object & WaitForOptions

Returns

Promise<HTMLElement>

Inherited from

QueryHelpers.findByRole

---

findByTestId()

findByTestId(id, opts?): Promise<HTMLElement>

Defined in: types.ts:34

Parameters

id

string

opts?

WaitForOptions

Returns

Promise<HTMLElement>

Inherited from

QueryHelpers.findByTestId

---

findByText()

findByText(text, opts?): Promise<HTMLElement>

Defined in: types.ts:44

Parameters

text

string | RegExp

opts?

WaitForOptions

Returns

Promise<HTMLElement>

Inherited from

QueryHelpers.findByText

---

getAllByRole()

getAllByRole(role, opts?): HTMLElement[]

Defined in: types.ts:40

Parameters

role

string

opts?

name?

string | RegExp

Returns

HTMLElement[]

Inherited from

QueryHelpers.getAllByRole

---

getAllByTestId()

getAllByTestId(id): HTMLElement[]

Defined in: types.ts:35

Parameters

id

string

Returns

HTMLElement[]

Inherited from

QueryHelpers.getAllByTestId

---

getAllByText()

getAllByText(text): HTMLElement[]

Defined in: types.ts:45

Parameters

text

string | RegExp

Returns

HTMLElement[]

Inherited from

QueryHelpers.getAllByText

---

getByLabelText()

getByLabelText(text): HTMLElement

Defined in: types.ts:47

Parameters

text

string | RegExp

Returns

HTMLElement

Inherited from

QueryHelpers.getByLabelText

---

getByRole()

getByRole(role, opts?): HTMLElement

Defined in: types.ts:37

Parameters

role

string

opts?

name?

string | RegExp

Returns

HTMLElement

Inherited from

QueryHelpers.getByRole

---

getByTestId()

getByTestId(id): HTMLElement

Defined in: types.ts:32

Parameters

id

string

Returns

HTMLElement

Inherited from

QueryHelpers.getByTestId

---

getByText()

getByText(text): HTMLElement

Defined in: types.ts:42

Parameters

text

string | RegExp

Returns

HTMLElement

Inherited from

QueryHelpers.getByText

---

queryByLabelText()

queryByLabelText(text): HTMLElement | null

Defined in: types.ts:48

Parameters

text

string | RegExp

Returns

HTMLElement | null

Inherited from

QueryHelpers.queryByLabelText

---

queryByRole()

queryByRole(role, opts?): HTMLElement | null

Defined in: types.ts:38

Parameters

role

string

opts?

name?

string | RegExp

Returns

HTMLElement | null

Inherited from

QueryHelpers.queryByRole

---

queryByTestId()

queryByTestId(id): HTMLElement | null

Defined in: types.ts:33

Parameters

id

string

Returns

HTMLElement | null

Inherited from

QueryHelpers.queryByTestId

---

queryByText()

queryByText(text): HTMLElement | null

Defined in: types.ts:43

Parameters

text

string | RegExp

Returns

HTMLElement | null

Inherited from

QueryHelpers.queryByText

---

rerender()

rerender(next): Promise<void>

Defined in: types.ts:58

Parameters

next

html

string | HTMLElement

Returns

Promise<void>

---

unmount()

unmount(): void

Defined in: types.ts:68

Tear down this render: synchronously calls disconnect() on every controller render() registered (via application.unload()), removes the fixture from the DOM, and stops the application if render() created it.

disconnect() is guaranteed to have run by the time unmount() returns, so you can assert on teardown side-effects (cleared intervals, destroyed editors, …) immediately — no await needed.

Returns

void