kui_shell_core.WatchPusher.md

Kui API Documentation - v11.0.0 / @kui-shell/core / WatchPusher

Interface: WatchPusher

@kui-shell/core.WatchPusher

callbacks to indicate state changes

Table of contents

Methods

• allOffline
• batchUpdateDone
• done
• footer
• header
• offline
• progress
• setBody
• update

Methods

allOffline

▸ allOffline(): void

The entire underlying model has disappared

Returns

void

Defined in

packages/core/src/core/jobs/watchable.ts:80

---

batchUpdateDone

▸ batchUpdateDone(): void

A batch of calls to update is complete

Returns

void

Defined in

packages/core/src/core/jobs/watchable.ts:71

---

done

▸ done(): void

No more updates will be performed

Returns

void

Defined in

packages/core/src/core/jobs/watchable.ts:77

---

footer

▸ footer(streams): void

Parameters

Name	Type
streams	string[]

Returns

void

Defined in

packages/core/src/core/jobs/watchable.ts:85

---

header

▸ header(response): void

The header model has changed

Parameters

Name	Type
response	Row

Returns

void

Defined in

packages/core/src/core/jobs/watchable.ts:83

---

offline

▸ offline(rowKey): void

The given keyed row is gone

Parameters

Name	Type
rowKey	string

Returns

void

Defined in

packages/core/src/core/jobs/watchable.ts:74

---

progress

▸ progress(progress): void

Update progress bar for a given row

Parameters

Name	Type
progress	Object
progress.fileName?	string
progress.message?	string
progress.percentComplete	number
progress.rowIdx	number
progress.totalSize?	number

Returns

void

Defined in

packages/core/src/core/jobs/watchable.ts:59

---

setBody

▸ setBody(response): void

set table body

Parameters

Name	Type
response	Row[]

Returns

void

Defined in

packages/core/src/core/jobs/watchable.ts:68

---

update

▸ update(response, batch?, changed?, idxToUpdate?): void

Parameters

Name	Type	Description
response	Row	Updated row model
batch?	boolean	-
changed?	boolean	-
idxToUpdate?	number	-

Returns

void

Defined in

packages/core/src/core/jobs/watchable.ts:47