Class Vitest

Index

Constructors

constructor

Constructors

constructor

new Vitest(mode): Vitest
Parameters
- mode: VitestRunMode
Returns Vitest
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:859

Properties

`Private` _onCancelListeners

_onCancelListeners: any

`Private` _onClose

_onClose: any

`Private` _onRestartListeners

_onRestartListeners: any

`Private` _onSetServer

_onSetServer: any

`Private` _rerunTimer

_rerunTimer: any

browserProvider

browserProvider: undefined | BrowserProvider

cache

cache: VitestCache

changedTests

changedTests: Set<string>

`Optional` closingPromise

closingPromise?: Promise<void>

config

config: ResolvedConfig

configOverride

configOverride: Partial<ResolvedConfig>

`Private` coreWorkspaceProject

coreWorkspaceProject: any

coverageProvider

coverageProvider: undefined | null | CoverageProvider

`Private` createCoreProject

createCoreProject: any

`Optional` filenamePattern

filenamePattern?: string

`Private` getTestDependencies

getTestDependencies: any

`Private` getWorkspaceConfigPath

getWorkspaceConfigPath: any

`Private` handleFileChanged

handleFileChanged: any

Returns

A value indicating whether rerun is needed (changedTests was mutated)

`Private` initBrowserProviders

initBrowserProviders: any

`Private` initCoverageProvider

initCoverageProvider: any

invalidates

invalidates: Set<string>

isCancelling

isCancelling: boolean

isFirstRun

isFirstRun: boolean

logger

logger: Logger

`Readonly` mode

mode: VitestRunMode

pool

pool: undefined | ProcessPool

projectFiles

projectFiles: {
    forksPath: string;
    vmPath: string;
    workerPath: string;
}

Type declaration

forksPath: string
vmPath: string
workerPath: string

projects

projects: WorkspaceProject[]

`Private` projectsTestFiles

projectsTestFiles: any

`Private` registerWatcher

registerWatcher: any

`Private` reportCoverage

reportCoverage: any

reporters

reporters: Reporter[]

`Private` resolveWorkspace

resolveWorkspace: any

`Private` resolvedProjects

resolvedProjects: any

restartsCount

restartsCount: number

runner

runner: ViteNodeRunner

`Optional` runningPromise

runningPromise?: Promise<void>

`Private` scheduleRerun

scheduleRerun: any

server

server: ViteDevServer

snapshot

snapshot: SnapshotManager

state

state: StateManager

`Private` unregisterWatcher

unregisterWatcher: any

vitenode

vitenode: ViteNodeServer

Methods

cancelCurrentRun

cancelCurrentRun(reason): Promise<void>
Parameters
- reason: CancelReason
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:878

changeFilenamePattern

changeFilenamePattern(pattern): Promise<void>
Parameters
- pattern: string
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:882

changeNamePattern

changeNamePattern(pattern, files?, trigger?): Promise<void>
Parameters
- pattern: string
- Optional files: string[]
- Optional trigger: string
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:881

changeProjectName

changeProjectName(pattern): Promise<void>
Parameters
- pattern: string
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:880

close

close(): Promise<void>
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:895

exit

exit(force?): Promise<void>
Close the thread pool and exit the process
Parameters
- Optional force: boolean
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:899

filterTestsBySource

filterTestsBySource(specs): Promise<WorkspaceSpec[]>
Parameters
- specs: WorkspaceSpec[]
Returns Promise<WorkspaceSpec[]>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:874

getCoreWorkspaceProject

getCoreWorkspaceProject(): WorkspaceProject
Returns WorkspaceProject
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:866

getModuleProjects

getModuleProjects(id): WorkspaceProject[]
Parameters
- id: string
Returns WorkspaceProject[]
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:887

getProjectByTaskId

getProjectByTaskId(taskId): WorkspaceProject
Parameters
- taskId: string
Returns WorkspaceProject
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:867

getProjectsByTestFile

getProjectsByTestFile(file): WorkspaceSpec[]
Parameters
- file: string
Returns WorkspaceSpec[]
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:875

globTestFiles

globTestFiles(filters?): Promise<WorkspaceSpec[]>
Parameters
- Optional filters: string[]
Returns Promise<WorkspaceSpec[]>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:901

initializeGlobalSetup

initializeGlobalSetup(paths): Promise<void>
Parameters
- paths: WorkspaceSpec[]
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:876

onAfterSetServer

onAfterSetServer(fn): void
Parameters
- fn: OnServerRestartHandler
Returns void
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:904

onCancel

onCancel(fn): void
Parameters
- fn: ((reason) => void)
  - - (reason): void
    - Parameters
      reason: CancelReason
      Returns void
Returns void
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:905

onClose

onClose(fn): void
Parameters
- fn: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:906

onServerRestart

onServerRestart(fn): void
Parameters
- fn: OnServerRestartHandler
Returns void
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:903

report

report<T>(name, ...args): Promise<void>
Type Parameters
- T extends keyof Reporter
Parameters
- name: T
- Rest ...args: ArgumentsType<Reporter[T]>
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:900

rerunFailed

rerunFailed(): Promise<void>
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:883

rerunFiles

rerunFiles(files?, trigger?): Promise<void>
Parameters
- Optional files: string[]
- Optional trigger: string
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:879

runFiles

runFiles(paths): Promise<void>
Parameters
- paths: WorkspaceSpec[]
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:877

setServer

setServer(options, server, cliOptions): Promise<void>
Parameters
- options: UserConfig
- server: ViteDevServer
- cliOptions: UserConfig
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:864

shouldKeepServer

shouldKeepServer(): boolean
Returns boolean
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:902

start

start(filters?): Promise<void>
Parameters
- Optional filters: string[]
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:872

updateSnapshot

updateSnapshot(files?): Promise<void>
Parameters
- Optional files: string[]
Returns Promise<void>
- Defined in node_modules/.pnpm/vitest@1.1.0_@types+node@20.11.20_@vitest+ui@1.2.2_jsdom@24.0.0_lightningcss@1.24.0/node_modules/vitest/dist/reporters-O4LBziQ_.d.ts:884

Class Vitest

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

mode: VitestRunMode

Returns Vitest

Properties

Private _onCancelListeners

Private _onClose

Private _onRestartListeners

Private _onSetServer

Private _rerunTimer

browserProvider

cache

changedTests

Optional closingPromise

config

configOverride

Private coreWorkspaceProject

coverageProvider

Private createCoreProject

Optional filenamePattern

Private getTestDependencies

Private getWorkspaceConfigPath

Private handleFileChanged

Returns

Private initBrowserProviders

Private initCoverageProvider

invalidates

isCancelling

isFirstRun

logger

Readonly mode

pool

projectFiles

Type declaration

forksPath: string

vmPath: string

workerPath: string

projects

Private projectsTestFiles

Private registerWatcher

Private reportCoverage

reporters

Private resolveWorkspace

Private resolvedProjects

restartsCount

runner

Optional runningPromise

Private scheduleRerun

server

snapshot

state

Private unregisterWatcher

vitenode

Methods

cancelCurrentRun

Parameters

reason: CancelReason

Returns Promise<void>

changeFilenamePattern

Parameters

pattern: string

Returns Promise<void>

changeNamePattern

Parameters

pattern: string

Optional files: string[]

Optional trigger: string

Returns Promise<void>

changeProjectName

Parameters

pattern: string

Returns Promise<void>

close

Returns Promise<void>

`Private` _onCancelListeners

`Private` _onClose

`Private` _onRestartListeners

`Private` _onSetServer

`Private` _rerunTimer

`Optional` closingPromise

`Private` coreWorkspaceProject

`Private` createCoreProject

`Optional` filenamePattern

`Private` getTestDependencies

`Private` getWorkspaceConfigPath

`Private` handleFileChanged

`Private` initBrowserProviders

`Private` initCoverageProvider

`Readonly` mode

`Private` projectsTestFiles

`Private` registerWatcher

`Private` reportCoverage

`Private` resolveWorkspace

`Private` resolvedProjects

`Optional` runningPromise

`Private` scheduleRerun

`Private` unregisterWatcher

`Optional` files: string[]

`Optional` trigger: string

`Optional` force: boolean

`Optional` filters: string[]

`Rest` ...args: ArgumentsType<Reporter[T]>

`Optional` files: string[]

`Optional` trigger: string