TestCollection.mdx

testplane / TestCollection

Class: TestCollection

Constructors

new TestCollection()

new TestCollection(specs): TestCollection

Parameters

Parameter	Type
specs	Record<string, Test[]>

Returns

TestCollection

Defined in

src/test-collection.ts:20

Methods

disableAll()

disableAll(browserId?): this

Parameters

Parameter	Type
browserId?	string

Returns

this

Defined in

src/test-collection.ts:122

---

disableTest()

disableTest(fullTitle, browserId?): this

Parameters

Parameter	Type
fullTitle	string
browserId?	string

Returns

this

Defined in

src/test-collection.ts:136

---

eachRootSuite()

eachRootSuite(cb): void

Parameters

Parameter	Type
cb	(root, browserId) => void

Returns

void

Defined in

src/test-collection.ts:30

---

eachTest()

eachTest(callback)

eachTest(callback): void

Parameters

Parameter	Type
callback	TestsCallback<void>

Returns

void

Defined in

src/test-collection.ts:87

eachTest(browserId, callback)

eachTest(browserId, callback): void

Parameters

Parameter	Type
browserId	undefined | string
callback	TestsCallback<void>

Returns

void

Defined in

src/test-collection.ts:88

---

eachTestByVersions()

eachTestByVersions(browserId, cb): void

Parameters

Parameter	Type
browserId	string
cb	(test, browserId, browserVersion?) => void

Returns

void

Defined in

src/test-collection.ts:102

---

enableAll()

enableAll(browserId?): this

Parameters

Parameter	Type
browserId?	string

Returns

this

Defined in

src/test-collection.ts:153

---

enableTest()

enableTest(fullTitle, browserId?): this

Parameters

Parameter	Type
fullTitle	string
browserId?	string

Returns

this

Defined in

src/test-collection.ts:163

---

getBrowsers()

getBrowsers(): string[]

Returns

string[]

Defined in

src/test-collection.ts:43

---

getRootSuite()

getRootSuite(browserId): null | RootSuite

Parameters

Parameter	Type
browserId	string

Returns

null | RootSuite

Defined in

src/test-collection.ts:25

---

mapTests()

mapTests(cb)

mapTests<T>(cb): T[]

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
cb	TestsCallback<T>

Returns

T[]

Defined in

src/test-collection.ts:47

mapTests(browserId, cb)

mapTests<T>(browserId, cb): T[]

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
browserId	undefined | string
cb	TestsCallback<T>

Returns

T[]

Defined in

src/test-collection.ts:48

---

sortTests()

sortTests(callback)

sortTests(callback): this

Parameters

Parameter	Type
callback	SortTestsCallback

Returns

this

Defined in

src/test-collection.ts:63

sortTests(browserId, callback)

sortTests(browserId, callback): this

Parameters

Parameter	Type
browserId	undefined | string
callback	SortTestsCallback

Returns

this

Defined in

src/test-collection.ts:64

---

create()

static create<T>(this, specs): T

Type Parameters

Type Parameter
T extends TestCollection

Parameters

Parameter	Type
this	(specs) => T
specs	Record<string, Test[]>

Returns

T

Defined in

src/test-collection.ts:13