Readonly allureUse Allure step API directly. This is for Mocha compatibility. Step decorator for Mocha migration
Readonly allureReadonly attachmentUse Allure attachment API directly. This is for Mocha compatibility. Attachment decorator for Mocha migration
Readonly contextContext symbol for Mocha compatibility. Use Vitest's test context directly. Context symbol for Mocha migration
Readonly dataData decorator for Mocha compatibility (parameterized tests) Use Vitest's native parameterized tests instead.
Readonly descriptionReadonly epicReadonly featureReadonly idReadonly issueReadonly labelReadonly linkReadonly onlyOnly decorator factory
@only()
Readonly onlyOnlyIfEnv decorator factory - run test only if env variable matches
@onlyIfEnv('CI', 'true')
Readonly ownerReadonly parallelUse suite with { mode: 'parallel' } instead. This decorator is for Mocha compatibility.
Parallel decorator factory for Mocha migration
@parallel(true)
Readonly paramsUse params from test context instead. This decorator is for Mocha compatibility.
Params decorator factory for Mocha migration
@params([1, 2], [3, 4])
Readonly parentReadonly pendingUse skip instead. This decorator is for Mocha compatibility.
Pending decorator factory for Mocha migration
@pending()
Readonly repeatsRepeats decorator factory
@repeats(3)
Readonly retriesUse repeats instead. This decorator is for Mocha compatibility.
Retries decorator factory for Mocha migration
@retries(3)
Readonly severityReadonly skipSkip decorator factory
@skip()
Readonly slowUse timeout instead. This decorator is for Mocha compatibility.
Slow decorator factory for Mocha migration
@slow(1000)
Readonly storyReadonly subReadonly suiteSuite decorator factory
Suite name (optional, defaults to class name)
Suite options (timeout, retries, mode)
Class decorator
@suite('My Test Suite')
class MyTest {}
@suite('Parallel Suite', { mode: 'parallel', timeout: 10000, retries: 2 })
class ParallelTest {}
Readonly tagReadonly tagsReadonly testTest decorator factory
@test('should work')
Readonly testUse id instead. This is for Mocha compatibility.
TestCaseId decorator for Mocha migration
Readonly timeoutTimeout decorator factory
@timeout(5000)
Readonly todoTodo decorator factory
@todo()
Private #allureStep name or function
Use Allure step API directly. Mocha compatibility decorator. Step decorator for Mocha migration
Private #applyPrivate #attachmentAttachment name
Attachment content
Optional type: stringContent type
Use Allure attachment API directly. Mocha compatibility decorator. Attachment decorator for Mocha migration
Private #createCreate an Allure decorator factory
Allure method name
Whether to append multiple values
Rest ...args: string[]Optional propertyKey: stringOptional descriptor: PropertyDescriptorPrivate #createCreate an issue decorator with optional URL
Optional url: stringOptional propertyKey: stringOptional descriptor: PropertyDescriptorPrivate #createCreate a link decorator with optional type parameter
Optional name: stringOptional type: stringOptional propertyKey: stringOptional descriptor: PropertyDescriptorPrivate #dataTest parameters
Optional name: stringOptional test name
Data decorator for Mocha compatibility (parameterized tests). Use Vitest's native parameterized tests instead.
Private #onlyPrivate #onlyOnlyIfEnv decorator factory - run test only if env variable matches
Environment variable name
Expected value
Optional propertyKey: stringOptional descriptor: PropertyDescriptorPrivate #parallelWhether to enable parallel execution
Use #suite with { mode: 'parallel' } instead. Mocha compatibility decorator.
Parallel decorator factory for Mocha migration
Private #paramsRest ...paramsList: any[][]List of parameter sets
Params are handled differently in Vitest. Mocha compatibility decorator. Params decorator factory for Mocha migration
Private #pendingUse #skip instead. Mocha compatibility decorator.
Pending decorator factory for Mocha migration
Private #registerPrivate #registerPrivate #registerPrivate #registerPrivate #registerRegister a single test method with Vitest
Class instance
Method name
Method function
Rest ...args: any[]Test metadata
Private #repeatsRepeats decorator factory
Number of repeats (must be positive)
Optional options: { Repeat options
Optional mode?: "series" | "queue"Private #retriesNumber of retries (must be non-negative)
Use #repeats instead. Mocha compatibility decorator.
Retries decorator factory for Mocha migration
Private #setPrivate #skipPrivate #slowSlow threshold in milliseconds
Use #timeout instead. Mocha compatibility decorator.
Slow decorator factory for Mocha migration
Private #suiteSuite decorator factory
Optional name: stringSuite name (optional, defaults to class name)
Optional options: SuiteOptionsSuite options (timeout, retries, mode)
Private #testTest decorator factory
Optional name: stringTest name (optional, defaults to method name)
Private #testTest case ID
Use #id instead. Mocha compatibility decorator.
TestCaseId decorator for Mocha migration
Private #timeoutTimeout decorator factory
Timeout in milliseconds (must be positive)
Private #todoPrivate #walk
Main Vitest OOP decorator class Provides class-based test definition with Allure integration OOP test decorators for Vitest with Allure support
Remarks
Features:
Example
Example
Example
Example