kui_shell_test.TestTable.md

Kui API Documentation - v11.0.0 / @kui-shell/test / TestTable

Class: TestTable

@kui-shell/test.TestTable

Table of contents

Constructors

• constructor

Properties

• cmdIdx
• ctx
• outputCount
• testName
• tests

Methods

• drilldownFromTable
• evalStatus
• executeAndValidate
• run

Constructors

constructor

• new TestTable(testName?, tests?)

Parameters

Name	Type
testName?	string
tests?	Tests

Defined in

packages/test/src/api/table.ts:56

Properties

cmdIdx

• Private cmdIdx: number

Defined in

packages/test/src/api/table.ts:54

---

ctx

• Private ctx: ISuite

Defined in

packages/test/src/api/table.ts:52

---

outputCount

• Private outputCount: number

Defined in

packages/test/src/api/table.ts:51

---

testName

• Private testName: string

Defined in

packages/test/src/api/table.ts:50

---

tests

• Private tests: Tests

Defined in

packages/test/src/api/table.ts:53

Methods

drilldownFromTable

▸ drilldownFromTable(expectTable, _ctx?): void

drilldownFromTable() drilldowns from the table

Parameters

Name	Type	Description
expectTable	Table<Row>	is the expected table shown in the REPL
_ctx?	ISuite	-

Returns

void

Defined in

packages/test/src/api/table.ts:219

---

evalStatus

▸ evalStatus(_): void

Parameters

Name	Type
_	Object
_.command	string
_.ctx?	ISuite
_.expectRow	RowWithBadgeAndMessage[]
_.statusDescription?	string

Returns

void

Defined in

packages/test/src/api/table.ts:87

---

executeAndValidate

▸ Private executeAndValidate(command, expectTable, validation?, _ctx?): void

Execute the table-generating command, and validate the content.

Parameters

Name	Type
command	string
expectTable	Table<Row>
validation?	TableValidation
_ctx?	ISuite

Returns

void

Defined in

packages/test/src/api/table.ts:124

---

run

▸ run(): void

new TestTable().run() will start a mocha test suite

Returns

void

Defined in

packages/test/src/api/table.ts:62