HotPage

hotstaq / Modules / HotPage

Class: HotPage

A page to preprocess.

Implements

• IHotPage

Table of contents

Constructors

• constructor

Properties

• files
• name
• processor
• route
• testElements
• testPaths
• testerMap
• testerName

Methods

• addFile
• addTestElement
• createTestPath
• getAPI
• getTestElement
• getTesterAPI
• load
• process

Constructors

constructor

• new HotPage(copy)

Parameters

Name	Type
copy	HotStaq | IHotPage

Defined in

HotPage.ts:87

Properties

files

• files: HotFile[]

The name of the page. File ordering matters here. Every file is processed incrementally.

Implementation of

IHotPage.files

Defined in

HotPage.ts:69

---

name

• name: string

The name of the page.

Implementation of

IHotPage.name

Defined in

HotPage.ts:60

---

processor

• processor: HotStaq

The processor to use.

Implementation of

IHotPage.processor

Defined in

HotPage.ts:56

---

route

• route: string

The route used to get to this page.

Implementation of

IHotPage.route

Defined in

HotPage.ts:64

---

testElements

• testElements: Object

The elements to test on this page.

Index signature

▪ [name: string]: HotTestElement

Implementation of

IHotPage.testElements

Defined in

HotPage.ts:81

---

testPaths

• testPaths: Object

The test paths to test on this page.

Index signature

▪ [name: string]: HotTestPath

Implementation of

IHotPage.testPaths

Defined in

HotPage.ts:85

---

testerMap

• testerMap: string

The associated tester map.

Implementation of

IHotPage.testerMap

Defined in

HotPage.ts:77

---

testerName

• testerName: string

The associated tester name.

Implementation of

IHotPage.testerName

Defined in

HotPage.ts:73

Methods

addFile

▸ addFile(file): Promise<void>

Add a file to process. It's recommend to load the file prior to adding it to a page if it's about to be used.

Parameters

Name	Type
file	HotFile

Returns

Promise<void>

Defined in

HotPage.ts:117

---

addTestElement

▸ addTestElement(elm): void

Add a test element.

Parameters

Name	Type
elm	HotTestElement

Returns

void

Defined in

HotPage.ts:177

---

createTestPath

▸ createTestPath(pathName, driverFunc): void

Create a test path.

Parameters

Name	Type
pathName	string
driverFunc	HotTestPath

Returns

void

Defined in

HotPage.ts:199

---

getAPI

▸ getAPI(): HotAPI

Get the API associated with this page.

Returns

HotAPI

Defined in

HotPage.ts:127

---

getTestElement

▸ getTestElement(name): HotTestElement

Get a test element.

Parameters

Name	Type
name	string

Returns

HotTestElement

Defined in

HotPage.ts:188

---

getTesterAPI

▸ getTesterAPI(): HotAPI

Get the tester API associated with this page.

Returns

HotAPI

Defined in

HotPage.ts:135

---

load

▸ load(file): Promise<void>

Add all files in the page. Could decrease page loading performance. It's recommend to load the file prior to adding it to a page.

Parameters

Name	Type
file	HotFile

Returns

Promise<void>

Defined in

HotPage.ts:144

---

process

▸ process(args?): Promise<string>

Process a page and get the result.

Parameters

Name	Type	Default value
args	any	null

Returns

Promise<string>

Defined in

HotPage.ts:157