Class AllureStep

Hierarchy

ExecutableItemWrapper
- AllureStep

Index

Constructors

Properties

Accessors

description descriptionHtml detailsMessage detailsTrace isAllStepsEnded isAnyStepFailed name stage status statusDetails wrappedItem

Methods

addAttachment addParameter addStep endStep parameter startStep wrap

Constructors

constructor

new AllureStep(stepResult, start?): AllureStep
Parameters
- stepResult: ExecutableItem
- Optional start: number
  Optional
Returns AllureStep
Overrides ExecutableItemWrapper.constructor
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:26

Properties

`Private` `Readonly` stepResult

stepResult: any

Accessors

description

set description(description): void
Parameters
- description: string
Returns void
Inherited from ExecutableItemWrapper.description
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:7

descriptionHtml

set descriptionHtml(descriptionHtml): void
Parameters
- descriptionHtml: string
Returns void
Inherited from ExecutableItemWrapper.descriptionHtml
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:8

detailsMessage

set detailsMessage(message): void
Parameters
- message: string
Returns void
Inherited from ExecutableItemWrapper.detailsMessage
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:12

detailsTrace

set detailsTrace(trace): void
Parameters
- trace: string
Returns void
Inherited from ExecutableItemWrapper.detailsTrace
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:13

isAllStepsEnded

get isAllStepsEnded(): boolean
Returns boolean
Inherited from ExecutableItemWrapper.isAllStepsEnded
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:17

isAnyStepFailed

get isAnyStepFailed(): boolean
Returns boolean
Inherited from ExecutableItemWrapper.isAnyStepFailed
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:16

name

set name(name): void
Parameters
- name: string
Returns void
Inherited from ExecutableItemWrapper.name
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:6

stage

set stage(stage): void
Parameters
- stage: Stage
Returns void
Inherited from ExecutableItemWrapper.stage
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:14

status

get status(): Status
Returns Status
Inherited from ExecutableItemWrapper.status
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:10
set status(status): void
Parameters
- status: Status
Returns void
Inherited from ExecutableItemWrapper.status
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:9

statusDetails

set statusDetails(details): void
Parameters
- details: StatusDetails
Returns void
Inherited from ExecutableItemWrapper.statusDetails
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:11

wrappedItem

get wrappedItem(): TestResult | ExecutableItem
Returns TestResult | ExecutableItem
Inherited from ExecutableItemWrapper.wrappedItem
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:5

Methods

addAttachment

addAttachment(name, options, fileName): void
Parameters
- name: string
- options: string | AttachmentOptions
- fileName: string
Returns void
Inherited from ExecutableItemWrapper.addAttachment
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:19

addParameter

addParameter(name, value, options?): void
Parameters
- name: string
- value: string
- Optional options: ParameterOptions
  Optional
Returns void
Inherited from ExecutableItemWrapper.addParameter
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:18

addStep

addStep(step): void
Parameters
- step: ExecutableItem
Returns void
Inherited from ExecutableItemWrapper.addStep
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:22

endStep

endStep(stop?): void
Parameters
- Optional stop: number
  Optional
Returns void
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:27

parameter

parameter(name, value, options?): void
Parameters
- name: string
- value: any
- Optional options: ParameterOptions
  Optional
Returns void
Inherited from ExecutableItemWrapper.parameter
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:15

startStep

startStep(name, start?): AllureStep
Parameters
- name: string
- Optional start: number
  Optional
Returns AllureStep
Inherited from ExecutableItemWrapper.startStep
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:20

wrap

wrap<T>(fun): ((...args) => T)
Type Parameters
- T
Parameters
- fun: ((...args) => T)
  - - (...args): T
    - Parameters
      
      Rest ...args: any[]
      Rest
      
      Returns T
Returns ((...args) => T)
- - (...args): T
  - Parameters
    - Rest ...args: any[]
      Rest
    Returns T
Inherited from ExecutableItemWrapper.wrap
- Defined in packages/@biorate/mocha/node_modules/allure-js-commons/dist/cjs/src/current/ExecutableItemWrapper.d.ts:21

Class AllureStep

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

stepResult: ExecutableItem

Optional start: number

Returns AllureStep

Properties

Private Readonly stepResult

Accessors

description

Parameters

description: string

Returns void

descriptionHtml

Parameters

descriptionHtml: string

Returns void

detailsMessage

Parameters

message: string

Returns void

detailsTrace

Parameters

trace: string

Returns void

isAllStepsEnded

Returns boolean

isAnyStepFailed

Returns boolean

name

Parameters

name: string

Returns void

stage

Parameters

stage: Stage

Returns void

status

Returns Status

Parameters

status: Status

Returns void

statusDetails

Parameters

details: StatusDetails

Returns void

wrappedItem

Returns TestResult | ExecutableItem

Methods

addAttachment

Parameters

name: string

options: string | AttachmentOptions

fileName: string

Returns void

addParameter

Parameters

name: string

value: string

Optional options: ParameterOptions

Returns void

addStep

Parameters

step: ExecutableItem

Returns void

endStep

Parameters

Optional stop: number

Returns void

parameter

Parameters

name: string

value: any

`Optional` start: number

`Private` `Readonly` stepResult

`Optional` options: ParameterOptions

`Optional` stop: number

`Optional` options: ParameterOptions

`Optional` start: number

`Rest` ...args: any[]

`Rest` ...args: any[]