kui_shell_test.SidecarExpect.md

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

Namespace: SidecarExpect

@kui-shell/test.SidecarExpect

Table of contents

Functions

• badge
• breadcrumbs
• button
• closed
• defaultMode
• descriptionList
• form
• fullyClosed
• heroName
• keyToClose
• kind
• mode
• modes
• name
• namehash
• namespace
• notOpen
• open
• openInBlockAfter
• openWithFailure
• popupTitle
• showing
• showingLeftNav
• showingNotClickable
• showingTopNav
• tableContent
• textPlainContent
• textPlainContentFromMonaco
• toolbarAlert
• toolbarText
• yaml

Functions

badge

▸ Const badge(title, css?, absent?): (res: AppAndCount) => Promise<AppAndCount>

Expect the given badge to exist in the sidecar header

Parameters

Name	Type	Default value
title	string	undefined
css?	string	undefined
absent	boolean	false

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:71

---

breadcrumbs

▸ breadcrumbs(breadcrumbs): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
breadcrumbs	string[]

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:369

---

button

▸ Const button(button): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
button	Object
button.label?	string
button.mode	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:91

---

closed

▸ Const closed(res): Promise<AppAndCount>

either minimized or fully closed

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:60

---

defaultMode

▸ Const defaultMode(expected): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
expected	Object
expected.label?	string
expected.mode	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:181

---

descriptionList

▸ Const descriptionList(content): (res: AppAndCount) => Promise<AppAndCount>

Expect DescriptionList content in the current tab

Parameters

Name	Type
content	Record<string, string | number | boolean>

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:384

---

form

▸ form(form, idPrefix?): (res: AppAndCount) => Promise<AppAndCount>

expect a form in the sidecar content

Parameters

Name	Type	Default value
form	Record<string, string>	undefined
idPrefix	string	'kui-form'

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:260

---

fullyClosed

▸ Const fullyClosed(res): Promise<AppAndCount>

fully closed, not just minimized

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:52

---

heroName

▸ Const heroName(count, expectedName): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
count	number
expectedName	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:145

---

keyToClose

▸ Const keyToClose(res): Promise<AppAndCount>

close the sidecar by ESCAPE key

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:65

---

kind

▸ Const kind(expectedKind): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
expectedKind	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:153

---

mode

▸ Const mode(expectedMode): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
expectedMode	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:98

---

modes

▸ Const modes(expected): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
expected	{ dafaultMode?: boolean ; label?: string ; mode: string }[]

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:157

---

name

▸ Const name(count, expectedName): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
count	number
expectedName	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:143

---

namehash

▸ Const namehash(count, expectedNameHash): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
count	number
expectedNameHash	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:147

---

namespace

▸ Const namespace(expectedNamespace): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
expectedNamespace	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:150

---

notOpen

▸ Const notOpen(res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:37

---

open

▸ Const open(res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:25

---

openInBlockAfter

▸ openInBlockAfter(res, delta?): Promise<AppAndCount>

Same as open(), but in the block proceding the given block

Parameters

Name	Type	Default value
res	AppAndCount	undefined
delta	number	1

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:33

---

openWithFailure

▸ Const openWithFailure(res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:44

---

popupTitle

▸ popupTitle(res, expectedTitle): Promise<boolean>

Parameters

Name	Type
res	AppAndCount
expectedTitle	string

Returns

Promise<boolean>

Defined in

packages/test/src/api/sidecar-expect.ts:247

---

showing

▸ Const showing(expectedName, expectedActivationId?, expectSubstringMatchOnName?, expectedPackageName?, expectType?, waitThisLong?, which?, clickable?): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
expectedName	string
expectedActivationId?	string
expectSubstringMatchOnName?	boolean
expectedPackageName?	string
expectType?	string
waitThisLong?	number
which?	"leftnav" | "topnav"
clickable?	boolean

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:281

---

showingLeftNav

▸ Const showingLeftNav(expectedName): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
expectedName	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:366

---

showingNotClickable

▸ Const showingNotClickable(expectedName, expectedPackageName?): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
expectedName	string
expectedPackageName?	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:360

---

showingTopNav

▸ Const showingTopNav(expectedName): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
expectedName	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:363

---

tableContent

▸ tableContent(res, nRows, nCells): Promise<void>

Parameters

Name	Type
res	AppAndCount
nRows	number
nCells	number

Returns

Promise<void>

Defined in

packages/test/src/api/sidecar-expect.ts:227

---

textPlainContent

▸ Const textPlainContent(content): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
content	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:201

---

textPlainContentFromMonaco

▸ Const textPlainContentFromMonaco(expectedText, exact?): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type	Default value
expectedText	string	undefined
exact	boolean	true

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:206

---

toolbarAlert

▸ Const toolbarAlert(expect): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
expect	Object
expect.exact?	boolean
expect.text	string
expect.type	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:124

---

toolbarText

▸ Const toolbarText(expect): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
expect	Object
expect.exact?	boolean
expect.text	string
expect.timeout?	number
expect.type	string

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:112

---

yaml

▸ Const yaml(content): (res: AppAndCount) => Promise<AppAndCount>

Parameters

Name	Type
content	object

Returns

fn

▸ (res): Promise<AppAndCount>

Parameters

Name	Type
res	AppAndCount

Returns

Promise<AppAndCount>

Defined in

packages/test/src/api/sidecar-expect.ts:235