> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.

# Runtime API Overview

## Test API

### [Expect](/api/runtime-api/test-api/expect.md)

- [expect](/api/runtime-api/test-api/expect.md#expect-1)
- [expect.element (Browser Mode)](/api/runtime-api/test-api/expect.md#expectelement-browser-mode)
- [expect.not](/api/runtime-api/test-api/expect.md#expectnot)
- [expect.soft](/api/runtime-api/test-api/expect.md#expectsoft)
- [expect.poll](/api/runtime-api/test-api/expect.md#expectpoll)
- [expect.unreachable](/api/runtime-api/test-api/expect.md#expectunreachable)
- [expect.assertions](/api/runtime-api/test-api/expect.md#expectassertions)
- [expect.hasAssertions](/api/runtime-api/test-api/expect.md#expecthasassertions)
- [expect.addEqualityTesters](/api/runtime-api/test-api/expect.md#expectaddequalitytesters)
- [expect.addSnapshotSerializer](/api/runtime-api/test-api/expect.md#expectaddsnapshotserializer)
- [expect.getState / expect.setState](/api/runtime-api/test-api/expect.md#expectgetstate--expectsetstate)
- [Matchers](/api/runtime-api/test-api/expect.md#matchers)
- [Common matchers](/api/runtime-api/test-api/expect.md#common-matchers)
- [Mock matchers](/api/runtime-api/test-api/expect.md#mock-matchers)
- [Snapshot matchers](/api/runtime-api/test-api/expect.md#snapshot-matchers)
- [Promise matchers](/api/runtime-api/test-api/expect.md#promise-matchers)
- [Asymmetric matchers](/api/runtime-api/test-api/expect.md#asymmetric-matchers)
- [Custom matchers](/api/runtime-api/test-api/expect.md#custom-matchers)

### [Test](/api/runtime-api/test-api/test.md)

- [test](/api/runtime-api/test-api/test.md#test-1)
- [test.only](/api/runtime-api/test-api/test.md#testonly)
- [test.skip](/api/runtime-api/test-api/test.md#testskip)
- [test.todo](/api/runtime-api/test-api/test.md#testtodo)
- [test.each](/api/runtime-api/test-api/test.md#testeach)
- [test.for](/api/runtime-api/test-api/test.md#testfor)
- [test.fails](/api/runtime-api/test-api/test.md#testfails)
- [test.concurrent](/api/runtime-api/test-api/test.md#testconcurrent)
- [test.sequential](/api/runtime-api/test-api/test.md#testsequential)
- [test.runIf](/api/runtime-api/test-api/test.md#testrunif)
- [test.skipIf](/api/runtime-api/test-api/test.md#testskipif)
- [test.extend](/api/runtime-api/test-api/test.md#testextend)
- [Chainable modifiers](/api/runtime-api/test-api/test.md#chainable-modifiers)
- [Types](/api/runtime-api/test-api/test.md#types)

### [Describe](/api/runtime-api/test-api/describe.md)

- [describe](/api/runtime-api/test-api/describe.md#describe-1)
- [describe.only](/api/runtime-api/test-api/describe.md#describeonly)
- [describe.skip](/api/runtime-api/test-api/describe.md#describeskip)
- [describe.todo](/api/runtime-api/test-api/describe.md#describetodo)
- [describe.each](/api/runtime-api/test-api/describe.md#describeeach)
- [describe.for](/api/runtime-api/test-api/describe.md#describefor)
- [describe.runIf](/api/runtime-api/test-api/describe.md#describerunif)
- [describe.skipIf](/api/runtime-api/test-api/describe.md#describeskipif)
- [describe.concurrent](/api/runtime-api/test-api/describe.md#describeconcurrent)
- [describe.sequential](/api/runtime-api/test-api/describe.md#describesequential)
- [Chainable modifiers](/api/runtime-api/test-api/describe.md#chainable-modifiers)

### [Hooks](/api/runtime-api/test-api/hooks.md)

- [beforeAll](/api/runtime-api/test-api/hooks.md#beforeall)
- [afterAll](/api/runtime-api/test-api/hooks.md#afterall)
- [beforeEach](/api/runtime-api/test-api/hooks.md#beforeeach)
- [afterEach](/api/runtime-api/test-api/hooks.md#aftereach)
- [onTestFinished](/api/runtime-api/test-api/hooks.md#ontestfinished)
- [onTestFailed](/api/runtime-api/test-api/hooks.md#ontestfailed)
## Browser Mode

### [Locator](/api/runtime-api/browser-mode/locator.md)

- [page](/api/runtime-api/browser-mode/locator.md#page)
- [BrowserPage](/api/runtime-api/browser-mode/locator.md#browserpage)
- [Query API](/api/runtime-api/browser-mode/locator.md#query-api)
- [locator](/api/runtime-api/browser-mode/locator.md#locator-1)
- [getByRole](/api/runtime-api/browser-mode/locator.md#getbyrole)
- [getByText](/api/runtime-api/browser-mode/locator.md#getbytext)
- [getByLabel](/api/runtime-api/browser-mode/locator.md#getbylabel)
- [getByPlaceholder](/api/runtime-api/browser-mode/locator.md#getbyplaceholder)
- [getByAltText](/api/runtime-api/browser-mode/locator.md#getbyalttext)
- [getByTitle](/api/runtime-api/browser-mode/locator.md#getbytitle)
- [getByTestId](/api/runtime-api/browser-mode/locator.md#getbytestid)
- [Configuration API](/api/runtime-api/browser-mode/locator.md#configuration-api)
- [setTestIdAttribute](/api/runtime-api/browser-mode/locator.md#settestidattribute)
- [Composition API](/api/runtime-api/browser-mode/locator.md#composition-api)
- [filter](/api/runtime-api/browser-mode/locator.md#filter)
- [and / or](/api/runtime-api/browser-mode/locator.md#and--or)
- [nth / first / last](/api/runtime-api/browser-mode/locator.md#nth--first--last)
- [Interaction API](/api/runtime-api/browser-mode/locator.md#interaction-api)
- [click](/api/runtime-api/browser-mode/locator.md#click)
- [dblclick](/api/runtime-api/browser-mode/locator.md#dblclick)
- [hover](/api/runtime-api/browser-mode/locator.md#hover)
- [press](/api/runtime-api/browser-mode/locator.md#press)
- [fill](/api/runtime-api/browser-mode/locator.md#fill)
- [clear](/api/runtime-api/browser-mode/locator.md#clear)
- [focus](/api/runtime-api/browser-mode/locator.md#focus)
- [blur](/api/runtime-api/browser-mode/locator.md#blur)
- [check](/api/runtime-api/browser-mode/locator.md#check)
- [uncheck](/api/runtime-api/browser-mode/locator.md#uncheck)
- [scrollIntoViewIfNeeded](/api/runtime-api/browser-mode/locator.md#scrollintoviewifneeded)
- [waitFor](/api/runtime-api/browser-mode/locator.md#waitfor)
- [dispatchEvent](/api/runtime-api/browser-mode/locator.md#dispatchevent)
- [selectOption](/api/runtime-api/browser-mode/locator.md#selectoption)
- [setInputFiles](/api/runtime-api/browser-mode/locator.md#setinputfiles)
- [Usage constraints](/api/runtime-api/browser-mode/locator.md#usage-constraints)
- [Using with expect.element](/api/runtime-api/browser-mode/locator.md#using-with-expectelement)

### [Assertion](/api/runtime-api/browser-mode/assertion.md)

- [Type signature](/api/runtime-api/browser-mode/assertion.md#type-signature)
- [Auto-retry and timeout](/api/runtime-api/browser-mode/assertion.md#auto-retry-and-timeout)
- [Timeout priority](/api/runtime-api/browser-mode/assertion.md#timeout-priority)
- [Failure output](/api/runtime-api/browser-mode/assertion.md#failure-output)
- [Use cases](/api/runtime-api/browser-mode/assertion.md#use-cases)
- [Input constraints](/api/runtime-api/browser-mode/assertion.md#input-constraints)
- [Element assertions](/api/runtime-api/browser-mode/assertion.md#element-assertions)
- [not](/api/runtime-api/browser-mode/assertion.md#not)
- [toBeVisible](/api/runtime-api/browser-mode/assertion.md#tobevisible)
- [toBeHidden](/api/runtime-api/browser-mode/assertion.md#tobehidden)
- [toBeEnabled](/api/runtime-api/browser-mode/assertion.md#tobeenabled)
- [toBeDisabled](/api/runtime-api/browser-mode/assertion.md#tobedisabled)
- [toBeChecked](/api/runtime-api/browser-mode/assertion.md#tobechecked)
- [toBeUnchecked](/api/runtime-api/browser-mode/assertion.md#tobeunchecked)
- [toBeAttached](/api/runtime-api/browser-mode/assertion.md#tobeattached)
- [toBeDetached](/api/runtime-api/browser-mode/assertion.md#tobedetached)
- [toBeEditable](/api/runtime-api/browser-mode/assertion.md#tobeeditable)
- [toBeFocused](/api/runtime-api/browser-mode/assertion.md#tobefocused)
- [toBeEmpty](/api/runtime-api/browser-mode/assertion.md#tobeempty)
- [toBeInViewport](/api/runtime-api/browser-mode/assertion.md#tobeinviewport)
- [toHaveText](/api/runtime-api/browser-mode/assertion.md#tohavetext)
- [toContainText](/api/runtime-api/browser-mode/assertion.md#tocontaintext)
- [toHaveValue](/api/runtime-api/browser-mode/assertion.md#tohavevalue)
- [toHaveId](/api/runtime-api/browser-mode/assertion.md#tohaveid)
- [toHaveClass](/api/runtime-api/browser-mode/assertion.md#tohaveclass)
- [toHaveAttribute](/api/runtime-api/browser-mode/assertion.md#tohaveattribute)
- [toHaveCount](/api/runtime-api/browser-mode/assertion.md#tohavecount)
- [toHaveCSS](/api/runtime-api/browser-mode/assertion.md#tohavecss)
- [toHaveJSProperty](/api/runtime-api/browser-mode/assertion.md#tohavejsproperty)
- [Related API](/api/runtime-api/browser-mode/assertion.md#related-api)
## Rstest Utility

### [Mock modules](/api/runtime-api/rstest/mock-modules.md)

- [rs.mock](/api/runtime-api/rstest/mock-modules.md#rsmock)
- [rs.doMock](/api/runtime-api/rstest/mock-modules.md#rsdomock)
- [rs.mockRequire](/api/runtime-api/rstest/mock-modules.md#rsmockrequire)
- [rs.doMockRequire](/api/runtime-api/rstest/mock-modules.md#rsdomockrequire)
- [rs.unmockRequire](/api/runtime-api/rstest/mock-modules.md#rsunmockrequire)
- [rs.doUnmockRequire](/api/runtime-api/rstest/mock-modules.md#rsdounmockrequire)
- [rs.hoisted](/api/runtime-api/rstest/mock-modules.md#rshoisted)
- [rs.importActual](/api/runtime-api/rstest/mock-modules.md#rsimportactual)
- [rs.requireActual](/api/runtime-api/rstest/mock-modules.md#rsrequireactual)
- [rs.importMock](/api/runtime-api/rstest/mock-modules.md#rsimportmock)
- [rs.requireMock](/api/runtime-api/rstest/mock-modules.md#rsrequiremock)
- [rs.unmock](/api/runtime-api/rstest/mock-modules.md#rsunmock)
- [rs.doUnmock](/api/runtime-api/rstest/mock-modules.md#rsdounmock)
- [rs.resetModules](/api/runtime-api/rstest/mock-modules.md#rsresetmodules)

### [Mock functions](/api/runtime-api/rstest/mock-functions.md)

- [rs.fn](/api/runtime-api/rstest/mock-functions.md#rsfn)
- [rs.spyOn](/api/runtime-api/rstest/mock-functions.md#rsspyon)
- [rs.isMockFunction](/api/runtime-api/rstest/mock-functions.md#rsismockfunction)
- [rs.mockObject](/api/runtime-api/rstest/mock-functions.md#rsmockobject)
- [rs.mocked](/api/runtime-api/rstest/mock-functions.md#rsmocked)
- [rs.clearAllMocks](/api/runtime-api/rstest/mock-functions.md#rsclearallmocks)
- [rs.resetAllMocks](/api/runtime-api/rstest/mock-functions.md#rsresetallmocks)
- [rs.restoreAllMocks](/api/runtime-api/rstest/mock-functions.md#rsrestoreallmocks)
- [More](/api/runtime-api/rstest/mock-functions.md#more)

### [Mock instance](/api/runtime-api/rstest/mock-instance.md)

- [getMockName](/api/runtime-api/rstest/mock-instance.md#getmockname)
- [mockName](/api/runtime-api/rstest/mock-instance.md#mockname)
- [mockClear](/api/runtime-api/rstest/mock-instance.md#mockclear)
- [mockReset](/api/runtime-api/rstest/mock-instance.md#mockreset)
- [mockRestore](/api/runtime-api/rstest/mock-instance.md#mockrestore)
- [Symbol.dispose](/api/runtime-api/rstest/mock-instance.md#symboldispose)
- [getMockImplementation](/api/runtime-api/rstest/mock-instance.md#getmockimplementation)
- [mockImplementation](/api/runtime-api/rstest/mock-instance.md#mockimplementation)
- [mockImplementationOnce](/api/runtime-api/rstest/mock-instance.md#mockimplementationonce)
- [withImplementation](/api/runtime-api/rstest/mock-instance.md#withimplementation)
- [mockReturnThis](/api/runtime-api/rstest/mock-instance.md#mockreturnthis)
- [mockReturnValue](/api/runtime-api/rstest/mock-instance.md#mockreturnvalue)
- [mockReturnValueOnce](/api/runtime-api/rstest/mock-instance.md#mockreturnvalueonce)
- [mockThrow](/api/runtime-api/rstest/mock-instance.md#mockthrow)
- [mockThrowOnce](/api/runtime-api/rstest/mock-instance.md#mockthrowonce)
- [mockResolvedValue](/api/runtime-api/rstest/mock-instance.md#mockresolvedvalue)
- [mockResolvedValueOnce](/api/runtime-api/rstest/mock-instance.md#mockresolvedvalueonce)
- [mockRejectedValue](/api/runtime-api/rstest/mock-instance.md#mockrejectedvalue)
- [mockRejectedValueOnce](/api/runtime-api/rstest/mock-instance.md#mockrejectedvalueonce)
- [mock](/api/runtime-api/rstest/mock-instance.md#mock)
- [mock.calls](/api/runtime-api/rstest/mock-instance.md#mockcalls)
- [mock.instances](/api/runtime-api/rstest/mock-instance.md#mockinstances)
- [mock.contexts](/api/runtime-api/rstest/mock-instance.md#mockcontexts)
- [mock.invocationCallOrder](/api/runtime-api/rstest/mock-instance.md#mockinvocationcallorder)
- [mock.lastCall](/api/runtime-api/rstest/mock-instance.md#mocklastcall)
- [mock.results](/api/runtime-api/rstest/mock-instance.md#mockresults)
- [mock.settledResults](/api/runtime-api/rstest/mock-instance.md#mocksettledresults)

### [Fake timers](/api/runtime-api/rstest/fake-timers.md)

- [rs.useFakeTimers](/api/runtime-api/rstest/fake-timers.md#rsusefaketimers)
- [rs.useRealTimers](/api/runtime-api/rstest/fake-timers.md#rsuserealtimers)
- [rs.isFakeTimers](/api/runtime-api/rstest/fake-timers.md#rsisfaketimers)
- [rs.setSystemTime](/api/runtime-api/rstest/fake-timers.md#rssetsystemtime)
- [rs.getRealSystemTime](/api/runtime-api/rstest/fake-timers.md#rsgetrealsystemtime)
- [rs.getRealTimers](/api/runtime-api/rstest/fake-timers.md#rsgetrealtimers)
- [rs.runAllTicks](/api/runtime-api/rstest/fake-timers.md#rsrunallticks)
- [rs.runAllTimers](/api/runtime-api/rstest/fake-timers.md#rsrunalltimers)
- [rs.runAllTimersAsync](/api/runtime-api/rstest/fake-timers.md#rsrunalltimersasync)
- [rs.runOnlyPendingTimers](/api/runtime-api/rstest/fake-timers.md#rsrunonlypendingtimers)
- [rs.runOnlyPendingTimersAsync](/api/runtime-api/rstest/fake-timers.md#rsrunonlypendingtimersasync)
- [rs.advanceTimersByTime](/api/runtime-api/rstest/fake-timers.md#rsadvancetimersbytime)
- [rs.advanceTimersByTimeAsync](/api/runtime-api/rstest/fake-timers.md#rsadvancetimersbytimeasync)
- [rs.advanceTimersToNextTimer](/api/runtime-api/rstest/fake-timers.md#rsadvancetimerstonexttimer)
- [rs.advanceTimersToNextTimerAsync](/api/runtime-api/rstest/fake-timers.md#rsadvancetimerstonexttimerasync)
- [rs.advanceTimersToNextFrame](/api/runtime-api/rstest/fake-timers.md#rsadvancetimerstonextframe)
- [rs.jumpTimersByTime](/api/runtime-api/rstest/fake-timers.md#rsjumptimersbytime)
- [rs.setTickMode](/api/runtime-api/rstest/fake-timers.md#rssettickmode)
- [rs.getTimerCount](/api/runtime-api/rstest/fake-timers.md#rsgettimercount)
- [rs.clearAllTimers](/api/runtime-api/rstest/fake-timers.md#rsclearalltimers)

### [Utilities](/api/runtime-api/rstest/utilities.md)

- [rs.stubEnv](/api/runtime-api/rstest/utilities.md#rsstubenv)
- [rs.unstubAllEnvs](/api/runtime-api/rstest/utilities.md#rsunstuballenvs)
- [rs.stubGlobal](/api/runtime-api/rstest/utilities.md#rsstubglobal)
- [rs.unstubAllGlobals](/api/runtime-api/rstest/utilities.md#rsunstuballglobals)
- [rs.setConfig](/api/runtime-api/rstest/utilities.md#rssetconfig)
- [rs.resetConfig](/api/runtime-api/rstest/utilities.md#rsresetconfig)
- [rs.getConfig](/api/runtime-api/rstest/utilities.md#rsgetconfig)
- [rs.waitFor](/api/runtime-api/rstest/utilities.md#rswaitfor)
- [rs.waitUntil](/api/runtime-api/rstest/utilities.md#rswaituntil)
## Environment Variables

### [Environment Variables](/api/runtime-api/environment-variables.md)

- [`NODE_ENV`](/api/runtime-api/environment-variables.md#node_env)
- [`RSTEST`](/api/runtime-api/environment-variables.md#rstest)
- [`RSTEST_WORKER_ID`](/api/runtime-api/environment-variables.md#rstest_worker_id)