Class PlayWright

Description

Main class that provides OOP decorators for Playwright tests with Allure integration.

Exposes the following decorators:

@suite(name?) — define a test suite
@test(name?) — define a test method
@skip() — skip a test/suite
@only() — run only this test/suite
@slow(...opts) — mark test as slow
@extend(params) — extend test fixtures
Allure annotations: @label, @link, @id, @epic, @feature, @story, @allureSuite, @parentSuite, @subSuite, @owner, @severity, @tag, @tags, @issue, @description

A singleton instance is created at module level and its decorators are exported directly.

Example

import { suite, test, epic, feature, severity } from '@biorate/playwright';
import { Severity } from 'allure-js-commons';

@suite('Login')
class LoginTest {
  @epic('Auth')
  @feature('Login')
  @severity(Severity.CRITICAL)
  @test('should login')
  async shouldLogin({ page }: TestArgs) {
    await page.goto('/login');
    // ...
  }
}

Index

Constructors

constructor

new PlayWright(): PlayWright
Returns PlayWright
- Defined in packages/@biorate/playwright/src/playwright.ts:98

Properties

`Readonly` allureSuite

allureSuite: any

`Readonly` description

description: any

`Readonly` epic

epic: any

`Readonly` extend

extend: any

`Readonly` feature

feature: any

`Readonly` id

id: any

`Readonly` issue

issue: any

`Readonly` label

label: any

`Readonly` link

link: any

`Readonly` only

only: any

`Readonly` owner

owner: any

`Readonly` parentSuite

parentSuite: any

`Readonly` severity

severity: any

`Readonly` skip

skip: any

`Readonly` slow

slow: any

`Readonly` story

story: any

`Readonly` subSuite

subSuite: any

`Readonly` suite

suite: any

`Readonly` tag

tag: any

`Readonly` tags

tags: any

`Readonly` test

test: any

Methods

`Private` #allureSuite

#allureSuite(name): ((target, propertyKey, descriptor) => void)
Parameters
- name: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure suite annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:309

`Private` #description

#description(value): ((target, propertyKey, descriptor) => void)
Parameters
- value: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure description annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:365

`Private` #epic

#epic(epic): ((target, propertyKey, descriptor) => void)
Parameters
- epic: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure epic annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:288

`Private` #extend

#extend(params): ((target, propertyKey, descriptor) => void)
Parameters
- params: Record<string, any>
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Decorator to extend test fixtures with custom values.
- Defined in packages/@biorate/playwright/src/playwright.ts:228

`Private` #feature

#feature(epic): ((target, propertyKey, descriptor) => void)
Parameters
- epic: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure feature annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:295

`Private` #id

#id(id): ((target, propertyKey, descriptor) => void)
Parameters
- id: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure test id annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:281

`Private` #issue

#issue(name, url?): ((target, propertyKey, descriptor) => void)
Parameters
- name: string
- Optional url: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure issue annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:358

`Private` #label

#label(name, value): ((target, propertyKey, descriptor) => void)
Parameters
- name: string
- value: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure label annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:267

`Private` #link

#link(url, name, type?): ((target, propertyKey, descriptor) => void)
Parameters
- url: string
- name: string
- Optional type: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure link annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:274

`Private` #only

#only(): ((target, ...args) => void)
Returns ((target, ...args) => void)
- - (target, ...args): void
  - Parameters
    - target: any
    - Rest ...args: any[]
    Returns void
Description
Decorator that runs only this test or suite.
- Defined in packages/@biorate/playwright/src/playwright.ts:253

`Private` #owner

#owner(name): ((target, propertyKey, descriptor) => void)
Parameters
- name: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure owner annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:330

`Private` #parentSuite

#parentSuite(name): ((target, propertyKey, descriptor) => void)
Parameters
- name: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure parent suite annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:316

`Private` #setAllureMethod

#setAllureMethod(target, method, args, append?): void
Parameters
- target: any
- method: string
- args: string[]
- append: boolean = false
Returns void
- Defined in packages/@biorate/playwright/src/playwright.ts:212

`Private` #severity

#severity(severity): ((target, propertyKey, descriptor) => void)
Parameters
- severity: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure severity annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:337

`Private` #skip

#skip(): ((target, ...args) => void)
Returns ((target, ...args) => void)
- - (target, ...args): void
  - Parameters
    - target: any
    - Rest ...args: any[]
    Returns void
Description
Decorator that skips a test or suite.
- Defined in packages/@biorate/playwright/src/playwright.ts:244

`Private` #slow

#slow(...opts): ((target, ...args) => void)
Parameters
- Rest ...opts: any[]
Returns ((target, ...args) => void)
- - (target, ...args): void
  - Parameters
    - target: any
    - Rest ...args: any[]
    Returns void
Description
Decorator that marks a test as slow.
- Defined in packages/@biorate/playwright/src/playwright.ts:261

`Private` #story

#story(story): ((target, propertyKey, descriptor) => void)
Parameters
- story: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure story annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:302

`Private` #subSuite

#subSuite(name): ((target, propertyKey, descriptor) => void)
Parameters
- name: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure sub suite annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:323

`Private` #suite

#suite(name?): ((Class) => void)
Parameters
- Optional name: string
Returns ((Class) => void)
- - (Class): void
  - Parameters
    - Class: any
    Returns void
Description
Decorator that defines a test suite.
- Defined in packages/@biorate/playwright/src/playwright.ts:186

`Private` #tag

#tag(tag): ((target, propertyKey, descriptor) => void)
Parameters
- tag: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure tag annotation.
- Defined in packages/@biorate/playwright/src/playwright.ts:344

`Private` #tags

#tags(...tags): ((target, propertyKey, descriptor) => void)
Parameters
- Rest ...tags: string[]
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Allure tags annotation (multiple).
- Defined in packages/@biorate/playwright/src/playwright.ts:351

`Private` #test

#test(name?): ((target, propertyKey, descriptor) => void)
Parameters
- Optional name: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
Description
Decorator that marks a method as a test.
- Defined in packages/@biorate/playwright/src/playwright.ts:236

`Protected` after

after(instance): void
Parameters
- instance: any
Returns void
Description
Register afterEach hook from instance method.
- Defined in packages/@biorate/playwright/src/playwright.ts:381

`Protected` afterAll

afterAll(Class): void
Parameters
- Class: any
Returns void
Description
Register afterAll hook from static class method.
- Defined in packages/@biorate/playwright/src/playwright.ts:396

`Protected` before

before(instance): void
Parameters
- instance: any
Returns void
Description
Register beforeEach hook from instance method.
- Defined in packages/@biorate/playwright/src/playwright.ts:373

`Protected` beforeAll

beforeAll(Class): void
Parameters
- Class: any
Returns void
Description
Register beforeAll hook from static class method.
- Defined in packages/@biorate/playwright/src/playwright.ts:389

`Protected` walkProto

walkProto(instance): void
Parameters
- instance: any
Returns void
Description
Walk the prototype chain of an instance and register test methods.
- Defined in packages/@biorate/playwright/src/playwright.ts:126

Class PlayWright

Description

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PlayWright

Properties

Readonly allureSuite

Readonly description

Readonly epic

Readonly extend

Readonly feature

Readonly id

Readonly issue

Readonly label

Readonly link

Readonly only

Readonly owner

Readonly parentSuite

Readonly severity

Readonly skip

Readonly slow

Readonly story

Readonly subSuite

Readonly suite

Readonly tag

Readonly tags

Readonly test

Methods

Private #allureSuite

Parameters

Returns ((target, propertyKey, descriptor) => void)

Parameters

Returns void

Description

Private #description

Parameters

Returns ((target, propertyKey, descriptor) => void)

Parameters

Returns void

Description

Private #epic

Parameters

Returns ((target, propertyKey, descriptor) => void)

Parameters

Returns void

Description

Private #extend

Parameters

Returns ((target, propertyKey, descriptor) => void)

Parameters

Returns void

Description

Private #feature

Parameters

Returns ((target, propertyKey, descriptor) => void)

Parameters

Returns void

Description

Private #id

Parameters

Returns ((target, propertyKey, descriptor) => void)

Parameters

Returns void

Description

Private #issue

Parameters

Returns ((target, propertyKey, descriptor) => void)

Parameters

Returns void

Description

Private #label

Parameters

Returns ((target, propertyKey, descriptor) => void)

Parameters

Returns void

`Readonly` allureSuite

`Readonly` description

`Readonly` epic

`Readonly` extend

`Readonly` feature

`Readonly` id

`Readonly` issue

`Readonly` label

`Readonly` link

`Readonly` only

`Readonly` owner

`Readonly` parentSuite

`Readonly` severity

`Readonly` skip

`Readonly` slow

`Readonly` story

`Readonly` subSuite

`Readonly` suite

`Readonly` tag

`Readonly` tags

`Readonly` test

`Private` #allureSuite

`Private` #description

`Private` #epic

`Private` #extend

`Private` #feature

`Private` #id

`Private` #issue

`Private` #label

`Private` #link

`Private` #only

`Private` #owner

`Private` #parentSuite

`Private` #setAllureMethod

`Private` #severity

`Private` #skip

`Private` #slow

`Private` #story

`Private` #subSuite

`Private` #suite

`Private` #tag

`Private` #tags