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

# API 总览

## Test API

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

- [expect](/zh/api/runtime-api/test-api/expect.md#expect-1)
- [expect.element（Browser Mode）](/zh/api/runtime-api/test-api/expect.md#expectelementbrowser-mode)
- [expect.not](/zh/api/runtime-api/test-api/expect.md#expectnot)
- [expect.soft](/zh/api/runtime-api/test-api/expect.md#expectsoft)
- [expect.poll](/zh/api/runtime-api/test-api/expect.md#expectpoll)
- [expect.unreachable](/zh/api/runtime-api/test-api/expect.md#expectunreachable)
- [expect.assertions](/zh/api/runtime-api/test-api/expect.md#expectassertions)
- [expect.hasAssertions](/zh/api/runtime-api/test-api/expect.md#expecthasassertions)
- [expect.addEqualityTesters](/zh/api/runtime-api/test-api/expect.md#expectaddequalitytesters)
- [expect.addSnapshotSerializer](/zh/api/runtime-api/test-api/expect.md#expectaddsnapshotserializer)
- [expect.getState / expect.setState](/zh/api/runtime-api/test-api/expect.md#expectgetstate--expectsetstate)
- [匹配器（Matchers）](/zh/api/runtime-api/test-api/expect.md#匹配器matchers)
- [常用匹配器](/zh/api/runtime-api/test-api/expect.md#常用匹配器)
- [Mock 匹配器](/zh/api/runtime-api/test-api/expect.md#mock-匹配器)
- [快照匹配器](/zh/api/runtime-api/test-api/expect.md#快照匹配器)
- [Promise 匹配器](/zh/api/runtime-api/test-api/expect.md#promise-匹配器)
- [不对称匹配器](/zh/api/runtime-api/test-api/expect.md#不对称匹配器)
- [自定义匹配器](/zh/api/runtime-api/test-api/expect.md#自定义匹配器)

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

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

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

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

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

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

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

- [page](/zh/api/runtime-api/browser-mode/locator.md#page)
- [BrowserPage](/zh/api/runtime-api/browser-mode/locator.md#browserpage)
- [查询 API](/zh/api/runtime-api/browser-mode/locator.md#查询-api)
- [locator](/zh/api/runtime-api/browser-mode/locator.md#locator-1)
- [getByRole](/zh/api/runtime-api/browser-mode/locator.md#getbyrole)
- [getByText](/zh/api/runtime-api/browser-mode/locator.md#getbytext)
- [getByLabel](/zh/api/runtime-api/browser-mode/locator.md#getbylabel)
- [getByPlaceholder](/zh/api/runtime-api/browser-mode/locator.md#getbyplaceholder)
- [getByAltText](/zh/api/runtime-api/browser-mode/locator.md#getbyalttext)
- [getByTitle](/zh/api/runtime-api/browser-mode/locator.md#getbytitle)
- [getByTestId](/zh/api/runtime-api/browser-mode/locator.md#getbytestid)
- [配置 API](/zh/api/runtime-api/browser-mode/locator.md#配置-api)
- [setTestIdAttribute](/zh/api/runtime-api/browser-mode/locator.md#settestidattribute)
- [组合 API](/zh/api/runtime-api/browser-mode/locator.md#组合-api)
- [filter](/zh/api/runtime-api/browser-mode/locator.md#filter)
- [and / or](/zh/api/runtime-api/browser-mode/locator.md#and--or)
- [nth / first / last](/zh/api/runtime-api/browser-mode/locator.md#nth--first--last)
- [交互 API](/zh/api/runtime-api/browser-mode/locator.md#交互-api)
- [click](/zh/api/runtime-api/browser-mode/locator.md#click)
- [dblclick](/zh/api/runtime-api/browser-mode/locator.md#dblclick)
- [hover](/zh/api/runtime-api/browser-mode/locator.md#hover)
- [press](/zh/api/runtime-api/browser-mode/locator.md#press)
- [fill](/zh/api/runtime-api/browser-mode/locator.md#fill)
- [clear](/zh/api/runtime-api/browser-mode/locator.md#clear)
- [focus](/zh/api/runtime-api/browser-mode/locator.md#focus)
- [blur](/zh/api/runtime-api/browser-mode/locator.md#blur)
- [check](/zh/api/runtime-api/browser-mode/locator.md#check)
- [uncheck](/zh/api/runtime-api/browser-mode/locator.md#uncheck)
- [scrollIntoViewIfNeeded](/zh/api/runtime-api/browser-mode/locator.md#scrollintoviewifneeded)
- [waitFor](/zh/api/runtime-api/browser-mode/locator.md#waitfor)
- [dispatchEvent](/zh/api/runtime-api/browser-mode/locator.md#dispatchevent)
- [selectOption](/zh/api/runtime-api/browser-mode/locator.md#selectoption)
- [setInputFiles](/zh/api/runtime-api/browser-mode/locator.md#setinputfiles)
- [使用约束](/zh/api/runtime-api/browser-mode/locator.md#使用约束)
- [与 expect.element 配合](/zh/api/runtime-api/browser-mode/locator.md#与-expectelement-配合)

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

- [类型签名](/zh/api/runtime-api/browser-mode/assertion.md#类型签名)
- [自动重试与超时](/zh/api/runtime-api/browser-mode/assertion.md#自动重试与超时)
- [超时优先级](/zh/api/runtime-api/browser-mode/assertion.md#超时优先级)
- [失败输出](/zh/api/runtime-api/browser-mode/assertion.md#失败输出)
- [适用场景](/zh/api/runtime-api/browser-mode/assertion.md#适用场景)
- [输入约束](/zh/api/runtime-api/browser-mode/assertion.md#输入约束)
- [元素断言](/zh/api/runtime-api/browser-mode/assertion.md#元素断言)
- [not](/zh/api/runtime-api/browser-mode/assertion.md#not)
- [toBeVisible](/zh/api/runtime-api/browser-mode/assertion.md#tobevisible)
- [toBeHidden](/zh/api/runtime-api/browser-mode/assertion.md#tobehidden)
- [toBeEnabled](/zh/api/runtime-api/browser-mode/assertion.md#tobeenabled)
- [toBeDisabled](/zh/api/runtime-api/browser-mode/assertion.md#tobedisabled)
- [toBeChecked](/zh/api/runtime-api/browser-mode/assertion.md#tobechecked)
- [toBeUnchecked](/zh/api/runtime-api/browser-mode/assertion.md#tobeunchecked)
- [toBeAttached](/zh/api/runtime-api/browser-mode/assertion.md#tobeattached)
- [toBeDetached](/zh/api/runtime-api/browser-mode/assertion.md#tobedetached)
- [toBeEditable](/zh/api/runtime-api/browser-mode/assertion.md#tobeeditable)
- [toBeFocused](/zh/api/runtime-api/browser-mode/assertion.md#tobefocused)
- [toBeEmpty](/zh/api/runtime-api/browser-mode/assertion.md#tobeempty)
- [toBeInViewport](/zh/api/runtime-api/browser-mode/assertion.md#tobeinviewport)
- [toHaveText](/zh/api/runtime-api/browser-mode/assertion.md#tohavetext)
- [toContainText](/zh/api/runtime-api/browser-mode/assertion.md#tocontaintext)
- [toHaveValue](/zh/api/runtime-api/browser-mode/assertion.md#tohavevalue)
- [toHaveId](/zh/api/runtime-api/browser-mode/assertion.md#tohaveid)
- [toHaveClass](/zh/api/runtime-api/browser-mode/assertion.md#tohaveclass)
- [toHaveAttribute](/zh/api/runtime-api/browser-mode/assertion.md#tohaveattribute)
- [toHaveCount](/zh/api/runtime-api/browser-mode/assertion.md#tohavecount)
- [toHaveCSS](/zh/api/runtime-api/browser-mode/assertion.md#tohavecss)
- [toHaveJSProperty](/zh/api/runtime-api/browser-mode/assertion.md#tohavejsproperty)
- [相关 API](/zh/api/runtime-api/browser-mode/assertion.md#相关-api)
## Rstest 实用工具

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

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

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

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

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

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

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

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

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

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

### [环境变量](/zh/api/runtime-api/environment-variables.md)

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