Class default

Hierarchy

  • DefaultReporter
    • default

Constructors

constructor

Properties

ctx end failedUnwatchedFiles isTTY renderSucceed start watchFilters? verbose

Methods

error log onFinished onHookEnd onHookStart onInit onPathsCollected onServerRestart onTestCaseReady onTestCaseResult onTestModuleCollected onTestModuleEnd onTestModuleQueued onTestRemoved onTestRunEnd onTestRunStart onTestSuiteResult onUserConsoleLog onWatcherRerun onWatcherStart relative reportBenchmarkSummary reportSummary reportTestSummary shouldLog formatShortError getDurationPrefix getTestIndentation getTestName printTestCase printTestModule printTestSuite

Constructors

constructor

  • new default(options?: DefaultReporterOptions): default

    Parameters

    • Optionaloptions: DefaultReporterOptions

    Returns default

Properties

ctx

ctx: Vitest

end

end: number

failedUnwatchedFiles

failedUnwatchedFiles: TestModule[]

isTTY

isTTY: boolean

renderSucceed

renderSucceed: boolean

start

start: number

OptionalwatchFilters

watchFilters?: string[]

Protectedverbose

verbose: boolean

Methods

error

  • error(...messages: any): void

    Parameters

    • ...messages: any

    Returns void

log

  • log(...messages: any): void

    Parameters

    • ...messages: any

    Returns void

onFinished

  • onFinished(files: File[], errors: unknown[]): Promise<void>

    Parameters

    • files: File[]
    • errors: unknown[]

    Returns Promise<void>

onHookEnd

  • onHookEnd(hook: ReportedHookContext): void

    Parameters

    • hook: ReportedHookContext

    Returns void

onHookStart

  • onHookStart(hook: ReportedHookContext): void

    Parameters

    • hook: ReportedHookContext

    Returns void

onInit

  • onInit(ctx: Vitest): void

    Parameters

    • ctx: Vitest

    Returns void

onPathsCollected

  • onPathsCollected(paths?: string[]): void

    Parameters

    • Optionalpaths: string[]

    Returns void

onServerRestart

  • onServerRestart(reason?: string): void

    Parameters

    • Optionalreason: string

    Returns void

onTestCaseReady

  • onTestCaseReady(test: TestCase): void

    Parameters

    • test: TestCase

    Returns void

onTestCaseResult

  • onTestCaseResult(test: TestCase): void

    Parameters

    • test: TestCase

    Returns void

onTestModuleCollected

  • onTestModuleCollected(module: TestModule): void

    Parameters

    • module: TestModule

    Returns void

onTestModuleEnd

  • onTestModuleEnd(module: TestModule): void

    Parameters

    • module: TestModule

    Returns void

onTestModuleQueued

  • onTestModuleQueued(file: TestModule): void

    Parameters

    • file: TestModule

    Returns void

onTestRemoved

  • onTestRemoved(trigger?: string): void

    Parameters

    • Optionaltrigger: string

    Returns void

onTestRunEnd

  • onTestRunEnd(): void

    Returns void

onTestRunStart

  • onTestRunStart(specifications: readonly TestSpecification[]): void

    Parameters

    • specifications: readonly TestSpecification[]

    Returns void

onTestSuiteResult

  • onTestSuiteResult(testSuite: TestSuite): void

    Called after the test suite and its hooks are finished running. The state cannot be pending.

    Parameters

    • testSuite: TestSuite

    Returns void

onUserConsoleLog

  • onUserConsoleLog(
        log: UserConsoleLog,
        taskState?: "pending" | "skipped" | "passed" | "failed",
    ): void

    Parameters

    • log: UserConsoleLog
    • OptionaltaskState: "pending" | "skipped" | "passed" | "failed"

    Returns void

onWatcherRerun

  • onWatcherRerun(files: string[], trigger?: string): void

    Parameters

    • files: string[]
    • Optionaltrigger: string

    Returns void

onWatcherStart

  • onWatcherStart(files?: File[], errors?: unknown[]): void

    Parameters

    • Optionalfiles: File[]
    • Optionalerrors: unknown[]

    Returns void

relative

  • relative(path: string): string

    Parameters

    • path: string

    Returns string

reportBenchmarkSummary

  • reportBenchmarkSummary(files: File[]): void

    Parameters

    • files: File[]

    Returns void

reportSummary

  • reportSummary(files: File[], errors: unknown[]): void

    Parameters

    • files: File[]
    • errors: unknown[]

    Returns void

reportTestSummary

  • reportTestSummary(files: File[], errors: unknown[]): void

    Parameters

    • files: File[]
    • errors: unknown[]

    Returns void

shouldLog

  • shouldLog(
        log: UserConsoleLog,
        taskState?: "pending" | "skipped" | "passed" | "failed",
    ): boolean

    Parameters

    • log: UserConsoleLog
    • OptionaltaskState: "pending" | "skipped" | "passed" | "failed"

    Returns boolean

ProtectedformatShortError

  • formatShortError(error: ErrorWithDiff): string

    Parameters

    • error: ErrorWithDiff

    Returns string

ProtectedgetDurationPrefix

  • getDurationPrefix(task: Task): string

    Parameters

    • task: Task

    Returns string

ProtectedgetTestIndentation

  • getTestIndentation(_test: Task): string

    Parameters

    • _test: Task

    Returns string

ProtectedgetTestName

  • getTestName(test: Task, separator?: string): string

    Parameters

    • test: Task
    • Optionalseparator: string

    Returns string

ProtectedprintTestCase

  • printTestCase(moduleState: TestModuleState, test: TestCase): void

    Parameters

    • moduleState: TestModuleState
    • test: TestCase

    Returns void

ProtectedprintTestModule

  • printTestModule(testModule: TestModule): void

    Parameters

    • testModule: TestModule

    Returns void

ProtectedprintTestSuite

  • printTestSuite(_suite: TestSuite): void

    Parameters

    • _suite: TestSuite

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods