Module: allure

Methods

---

<static> allure.addDescription(desc, type)

Adds test description if test is started.

Parameters:

Name	Type	Description
desc	string	Description.
type	string	Mime type.

Source:

• allure.js, line 105

---

<static> allure.addEnvironment(name, value)

Adds test environment value if test is started.

Parameters:

Name	Type	Description
name	string	Environment name.
value	string	Environment value.

Source:

• allure.js, line 93

---

<static> allure.attach(name, content, type)

Attach content to test if test is started.

Parameters:

Name	Type	Description
name	string	Content name.
content	string	Content body.
type	string	Mime type.

Source:

• allure.js, line 118

---

<static> allure.attachHtml(name, html)

Attach HTML to test if test is started.

Parameters:

Name	Type	Description
name	string	HTML name.
html	string	HTML content.

Source:

• allure.js, line 177

---

<static> allure.attachImage(name, imgPath)

Attach image to test if test is started.

Parameters:

Name	Type	Description
name	string	Image name.
imgPath	string	Image path.

Source:

• allure.js, line 142

---

<static> allure.attachJson(name, obj)

Attach JSON to test if test is started.

Parameters:

Name	Type	Description
name	string	JSON name.
obj	string	Object to convert to JSON.

Source:

• allure.js, line 130

---

<static> allure.attachText(name, txt)

Attach text to test if test is started.

Parameters:

Name	Type	Description
name	string	Text name.
txt	string	Text content.

Source:

• allure.js, line 166

---

<static> allure.attachVideo(name, videoPath)

Attach video to test if test is started.

Parameters:

Name	Type	Description
name	string	Video name.
videoPath	string	Video path.

Source:

• allure.js, line 154

---

<static> allure.feature(name)

Adds test feature if test is started.

Parameters:

Name	Type	Description
name	string	Feature name.

Source:

• allure.js, line 81

---

<static> allure.hasSteps()

Defines if allure helper has steps or no.

Source:

• allure.js, line 31

Returns:

true if it has steps, false otherwise.

Type

boolean

---

<static> allure.isTestStarted()

Defines if test is started or no.

Source:

• allure.js, line 41

Returns:

true if test is started, false otherwise.

Type

boolean

---

<static> allure.pass()

Ends step as passed if test is started.

Source:

• allure.js, line 60

---

<static> allure.step(name)

Starts step if test is started.

Parameters:

Name	Type	Description
name	string	Step name.

Source:

• allure.js, line 51

---

<static> allure.story(name)

Adds test story if test is started.

Parameters:

Name	Type	Description
name	string	Story name.

Source:

• allure.js, line 70