diff --git a/docs/api/README.md b/docs/api/README.md new file mode 100644 index 00000000000..f197d71c52a --- /dev/null +++ b/docs/api/README.md @@ -0,0 +1,18 @@ +Kui API Documentation - v10.8.0 + +# Kui API Documentation - v10.8.0 + +## Table of contents + +### Modules + +- [@kui-shell/core](modules/kui_shell_core.md) +- [@kui-shell/plugin-bash-like](modules/kui_shell_plugin_bash_like.md) +- [@kui-shell/plugin-client-common](modules/kui_shell_plugin_client_common.md) +- [@kui-shell/plugin-core-support](modules/kui_shell_plugin_core_support.md) +- [@kui-shell/plugin-electron-components](modules/kui_shell_plugin_electron_components.md) +- [@kui-shell/plugin-git](modules/kui_shell_plugin_git.md) +- [@kui-shell/plugin-kubectl](modules/kui_shell_plugin_kubectl.md) +- [@kui-shell/plugin-proxy-support](modules/kui_shell_plugin_proxy_support.md) +- [@kui-shell/plugin-s3](modules/kui_shell_plugin_s3.md) +- [@kui-shell/test](modules/kui_shell_test.md) diff --git a/docs/api/classes/kui_shell_core.Cell.md b/docs/api/classes/kui_shell_core.Cell.md new file mode 100644 index 00000000000..8de2bf260ff --- /dev/null +++ b/docs/api/classes/kui_shell_core.Cell.md @@ -0,0 +1,151 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Cell + +# Class: Cell + +[@kui-shell/core](../modules/kui_shell_core.md).Cell + +## Table of contents + +### Constructors + +- [constructor](kui_shell_core.Cell.md#constructor) + +### Properties + +- [className](kui_shell_core.Cell.md#classname) +- [css](kui_shell_core.Cell.md#css) +- [fontawesome](kui_shell_core.Cell.md#fontawesome) +- [innerClassName](kui_shell_core.Cell.md#innerclassname) +- [key](kui_shell_core.Cell.md#key) +- [onclick](kui_shell_core.Cell.md#onclick) +- [outerCSS](kui_shell_core.Cell.md#outercss) +- [tag](kui_shell_core.Cell.md#tag) +- [tagClass](kui_shell_core.Cell.md#tagclass) +- [value](kui_shell_core.Cell.md#value) +- [valueDom](kui_shell_core.Cell.md#valuedom) + +## Constructors + +### constructor + +• **new Cell**(`cell`) + +#### Parameters + +| Name | Type | +| :----- | :------------------------------- | +| `cell` | [`Cell`](kui_shell_core.Cell.md) | + +#### Defined in + +[packages/core/src/webapp/models/table.ts:121](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L121) + +## Properties + +### className + +• `Optional` **className**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:119](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L119) + +--- + +### css + +• `Optional` **css**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:103](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L103) + +--- + +### fontawesome + +• `Optional` **fontawesome**: `string` \| `string`[] + +#### Defined in + +[packages/core/src/webapp/models/table.ts:111](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L111) + +--- + +### innerClassName + +• `Optional` **innerClassName**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:117](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L117) + +--- + +### key + +• `Optional` **key**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:109](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L109) + +--- + +### onclick + +• `Optional` **onclick**: `any` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:107](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L107) + +--- + +### outerCSS + +• `Optional` **outerCSS**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:105](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L105) + +--- + +### tag + +• `Optional` **tag**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:113](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L113) + +--- + +### tagClass + +• `Optional` **tagClass**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:115](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L115) + +--- + +### value + +• **value**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:99](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L99) + +--- + +### valueDom + +• `Optional` **valueDom**: `ReactElement`<`any`, `string` \| `JSXElementConstructor`<`any`\>\> + +#### Defined in + +[packages/core/src/webapp/models/table.ts:101](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L101) diff --git a/docs/api/classes/kui_shell_core.DirectReplEval.md b/docs/api/classes/kui_shell_core.DirectReplEval.md new file mode 100644 index 00000000000..e59ee69e663 --- /dev/null +++ b/docs/api/classes/kui_shell_core.DirectReplEval.md @@ -0,0 +1,80 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / DirectReplEval + +# Class: DirectReplEval + +[@kui-shell/core](../modules/kui_shell_core.md).DirectReplEval + +Directly apply the given evaluator to the given arguments. This is +the default evaluator implementation. + +## Implements + +- [`ReplEval`](../interfaces/kui_shell_core.ReplEval.md) + +## Table of contents + +### Constructors + +- [constructor](kui_shell_core.DirectReplEval.md#constructor) + +### Properties + +- [name](kui_shell_core.DirectReplEval.md#name) + +### Methods + +- [apply](kui_shell_core.DirectReplEval.md#apply) + +## Constructors + +### constructor + +• **new DirectReplEval**() + +## Properties + +### name + +• **name**: `string` = `'DirectReplEval'` + +#### Implementation of + +[ReplEval](../interfaces/kui_shell_core.ReplEval.md).[name](../interfaces/kui_shell_core.ReplEval.md#name) + +#### Defined in + +[packages/core/src/repl/types.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/types.ts#L55) + +## Methods + +### apply + +▸ **apply**<`T`, `O`\>(`commandUntrimmed`, `execOptions`, `evaluator`, `args`): `T` \| `Promise`<`T`\> + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](../interfaces/kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------ | +| `commandUntrimmed` | `string` | +| `execOptions` | [`ExecOptions`](../interfaces/kui_shell_core.ExecOptions.md) | +| `evaluator` | [`Evaluator`](../interfaces/kui_shell_core.Evaluator.md)<`T`, `O`\> | +| `args` | [`Arguments`](../interfaces/kui_shell_core.Arguments.md)<`O`\> | + +#### Returns + +`T` \| `Promise`<`T`\> + +#### Implementation of + +[ReplEval](../interfaces/kui_shell_core.ReplEval.md).[apply](../interfaces/kui_shell_core.ReplEval.md#apply) + +#### Defined in + +[packages/core/src/repl/types.ts:57](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/types.ts#L57) diff --git a/docs/api/classes/kui_shell_core.ElementMimic.md b/docs/api/classes/kui_shell_core.ElementMimic.md new file mode 100644 index 00000000000..d81ec365a28 --- /dev/null +++ b/docs/api/classes/kui_shell_core.ElementMimic.md @@ -0,0 +1,444 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ElementMimic + +# Class: ElementMimic + +[@kui-shell/core](../modules/kui_shell_core.md).ElementMimic + +## Table of contents + +### Constructors + +- [constructor](kui_shell_core.ElementMimic.md#constructor) + +### Properties + +- [\_attrs](kui_shell_core.ElementMimic.md#_attrs) +- [\_isFakeDom](kui_shell_core.ElementMimic.md#_isfakedom) +- [cells](kui_shell_core.ElementMimic.md#cells) +- [children](kui_shell_core.ElementMimic.md#children) +- [classList](kui_shell_core.ElementMimic.md#classlist) +- [className](kui_shell_core.ElementMimic.md#classname) +- [innerHTML](kui_shell_core.ElementMimic.md#innerhtml) +- [innerText](kui_shell_core.ElementMimic.md#innertext) +- [nodeType](kui_shell_core.ElementMimic.md#nodetype) +- [rows](kui_shell_core.ElementMimic.md#rows) +- [style](kui_shell_core.ElementMimic.md#style) +- [value](kui_shell_core.ElementMimic.md#value) + +### Methods + +- [addEventListener](kui_shell_core.ElementMimic.md#addeventlistener) +- [appendChild](kui_shell_core.ElementMimic.md#appendchild) +- [cloneNode](kui_shell_core.ElementMimic.md#clonenode) +- [focus](kui_shell_core.ElementMimic.md#focus) +- [getAttribute](kui_shell_core.ElementMimic.md#getattribute) +- [hasStyle](kui_shell_core.ElementMimic.md#hasstyle) +- [insertCell](kui_shell_core.ElementMimic.md#insertcell) +- [insertRow](kui_shell_core.ElementMimic.md#insertrow) +- [querySelector](kui_shell_core.ElementMimic.md#queryselector) +- [querySelectorAll](kui_shell_core.ElementMimic.md#queryselectorall) +- [recursiveInnerTextLength](kui_shell_core.ElementMimic.md#recursiveinnertextlength) +- [remove](kui_shell_core.ElementMimic.md#remove) +- [removeAttribute](kui_shell_core.ElementMimic.md#removeattribute) +- [setAttribute](kui_shell_core.ElementMimic.md#setattribute) +- [isFakeDom](kui_shell_core.ElementMimic.md#isfakedom) + +## Constructors + +### constructor + +• **new ElementMimic**() + +## Properties + +### \_attrs + +• `Private` **\_attrs**: `Object` = `{}` + +#### Index signature + +▪ [key: `string`]: `string` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:76](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L76) + +--- + +### \_isFakeDom + +• `Private` `Readonly` **\_isFakeDom**: `true` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:54](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L54) + +--- + +### cells + +• **cells**: [`ElementMimic`](kui_shell_core.ElementMimic.md)[] = `[]` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:72](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L72) + +--- + +### children + +• **children**: [`ElementMimic`](kui_shell_core.ElementMimic.md)[] = `[]` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L70) + +--- + +### classList + +• **classList**: `ClassList` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:64](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L64) + +--- + +### className + +• **className**: `string` = `''` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:62](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L62) + +--- + +### innerHTML + +• **innerHTML**: `string` = `''` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:60](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L60) + +--- + +### innerText + +• **innerText**: `string` = `''` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L58) + +--- + +### nodeType + +• **nodeType**: `string` = `''` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:66](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L66) + +--- + +### rows + +• **rows**: [`ElementMimic`](kui_shell_core.ElementMimic.md)[] = `[]` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:74](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L74) + +--- + +### style + +• **style**: `Object` = `{}` + +#### Index signature + +▪ [key: `string`]: `string` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:68](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L68) + +--- + +### value + +• **value**: `string` = `''` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L56) + +## Methods + +### addEventListener + +▸ **addEventListener**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:118](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L118) + +--- + +### appendChild + +▸ **appendChild**(`c`): `number` + +#### Parameters + +| Name | Type | +| :--- | :----------------------------------------------- | +| `c` | [`ElementMimic`](kui_shell_core.ElementMimic.md) | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:82](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L82) + +--- + +### cloneNode + +▸ **cloneNode**(): [`ElementMimic`](kui_shell_core.ElementMimic.md) + +#### Returns + +[`ElementMimic`](kui_shell_core.ElementMimic.md) + +#### Defined in + +[packages/core/src/util/element-mimic.ts:105](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L105) + +--- + +### focus + +▸ **focus**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:78](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L78) + +--- + +### getAttribute + +▸ **getAttribute**(`k`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `k` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:86](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L86) + +--- + +### hasStyle + +▸ **hasStyle**(`style`, `desiredValue?`): `string` \| `boolean` + +#### Parameters + +| Name | Type | +| :-------------- | :------------------- | +| `style` | `string` | +| `desiredValue?` | `string` \| `number` | + +#### Returns + +`string` \| `boolean` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:122](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L122) + +--- + +### insertCell + +▸ **insertCell**(`idx`): [`ElementMimic`](kui_shell_core.ElementMimic.md) + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `idx` | `number` | + +#### Returns + +[`ElementMimic`](kui_shell_core.ElementMimic.md) + +#### Defined in + +[packages/core/src/util/element-mimic.ts:146](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L146) + +--- + +### insertRow + +▸ **insertRow**(`idx`): [`ElementMimic`](kui_shell_core.ElementMimic.md) + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `idx` | `number` | + +#### Returns + +[`ElementMimic`](kui_shell_core.ElementMimic.md) + +#### Defined in + +[packages/core/src/util/element-mimic.ts:136](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L136) + +--- + +### querySelector + +▸ **querySelector**(): [`ElementMimic`](kui_shell_core.ElementMimic.md) + +#### Returns + +[`ElementMimic`](kui_shell_core.ElementMimic.md) + +#### Defined in + +[packages/core/src/util/element-mimic.ts:114](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L114) + +--- + +### querySelectorAll + +▸ **querySelectorAll**(`selector`): [`ElementMimic`](kui_shell_core.ElementMimic.md)[] + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `selector` | `string` | + +#### Returns + +[`ElementMimic`](kui_shell_core.ElementMimic.md)[] + +#### Defined in + +[packages/core/src/util/element-mimic.ts:110](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L110) + +--- + +### recursiveInnerTextLength + +▸ **recursiveInnerTextLength**(): `number` + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:130](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L130) + +--- + +### remove + +▸ **remove**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:95](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L95) + +--- + +### removeAttribute + +▸ **removeAttribute**(`k`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `k` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:99](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L99) + +--- + +### setAttribute + +▸ **setAttribute**(`k`, `v`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `k` | `string` | +| `v` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/util/element-mimic.ts:90](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L90) + +--- + +### isFakeDom + +▸ `Static` **isFakeDom**(`dom`): dom is ElementMimic + +#### Parameters + +| Name | Type | +| :---- | :---- | +| `dom` | `any` | + +#### Returns + +dom is ElementMimic + +#### Defined in + +[packages/core/src/util/element-mimic.ts:155](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/element-mimic.ts#L155) diff --git a/docs/api/classes/kui_shell_core.HistoryModel.md b/docs/api/classes/kui_shell_core.HistoryModel.md new file mode 100644 index 00000000000..8d6acdee8eb --- /dev/null +++ b/docs/api/classes/kui_shell_core.HistoryModel.md @@ -0,0 +1,426 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / HistoryModel + +# Class: HistoryModel + +[@kui-shell/core](../modules/kui_shell_core.md).HistoryModel + +A tuple of History entries, one per Tab (as specified by its given uuid) + +## Table of contents + +### Constructors + +- [constructor](kui_shell_core.HistoryModel.md#constructor) + +### Properties + +- [\_cursor](kui_shell_core.HistoryModel.md#_cursor) +- [\_lines](kui_shell_core.HistoryModel.md#_lines) +- [masterUUID](kui_shell_core.HistoryModel.md#masteruuid) + +### Accessors + +- [cursor](kui_shell_core.HistoryModel.md#cursor) + +### Methods + +- [add](kui_shell_core.HistoryModel.md#add) +- [find](kui_shell_core.HistoryModel.md#find) +- [findIndex](kui_shell_core.HistoryModel.md#findindex) +- [first](kui_shell_core.HistoryModel.md#first) +- [guardedChange](kui_shell_core.HistoryModel.md#guardedchange) +- [key](kui_shell_core.HistoryModel.md#key) +- [last](kui_shell_core.HistoryModel.md#last) +- [line](kui_shell_core.HistoryModel.md#line) +- [lineByIncr](kui_shell_core.HistoryModel.md#linebyincr) +- [next](kui_shell_core.HistoryModel.md#next) +- [previous](kui_shell_core.HistoryModel.md#previous) +- [restore](kui_shell_core.HistoryModel.md#restore) +- [save](kui_shell_core.HistoryModel.md#save) +- [slice](kui_shell_core.HistoryModel.md#slice) +- [update](kui_shell_core.HistoryModel.md#update) +- [wipe](kui_shell_core.HistoryModel.md#wipe) + +## Constructors + +### constructor + +• **new HistoryModel**(`uuid`) + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `uuid` | `string` | + +#### Defined in + +[packages/core/src/models/history.ts:52](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L52) + +## Properties + +### \_cursor + +• `Private` **\_cursor**: `number` + +#### Defined in + +[packages/core/src/models/history.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L43) + +--- + +### \_lines + +• `Private` **\_lines**: [`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md)[] + +#### Defined in + +[packages/core/src/models/history.ts:42](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L42) + +--- + +### masterUUID + +▪ `Static` `Private` **masterUUID**: `string` + +Facilitate copying master history to new Tabs + +#### Defined in + +[packages/core/src/models/history.ts:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L46) + +## Accessors + +### cursor + +• `get` **cursor**(): `number` + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/models/history.ts:98](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L98) + +## Methods + +### add + +▸ **add**(`line`): `number` + +add a line of repl history + +#### Parameters + +| Name | Type | +| :----- | :----------------------------------------------------------------------------- | +| `line` | `Pick`<[`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md), `"raw"`\> | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/models/history.ts:147](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L147) + +--- + +### find + +▸ **find**(`filter`): [`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +Search the history model + +#### Parameters + +| Name | Type | Description | +| :------- | :--------------- | :------------------------------------------------- | +| `filter` | `FilterFunction` | a search string, search regexp, or search function | + +#### Returns + +[`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +#### Defined in + +[packages/core/src/models/history.ts:226](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L226) + +--- + +### findIndex + +▸ **findIndex**(`filter`, `startIdx?`): `number` + +Search the history model + +#### Parameters + +| Name | Type | Description | +| :---------- | :--------------------------------------- | :--------------------------------------------------------------------------------------------- | +| `filter` | `string` \| `RegExp` \| `FilterFunction` | a search string, search regexp, or search function | +| `startIdx?` | `number` | if undefined or negative, start from the end, otherwise, search backwards from the given index | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/models/history.ts:199](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L199) + +--- + +### first + +▸ **first**(): [`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +return to the oldest entry + +#### Returns + +[`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +#### Defined in + +[packages/core/src/models/history.ts:180](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L180) + +--- + +### guardedChange + +▸ `Private` **guardedChange**(`incr`): `number` + +change the cursor, protecting against under- and overflow + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `incr` | `number` | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/models/history.ts:103](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L103) + +--- + +### key + +▸ `Private` **key**(`uuid?`): `string` + +The persistence key for this tab + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `uuid` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/models/history.ts:85](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L85) + +--- + +### last + +▸ **last**(): [`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +return to the newest entry + +#### Returns + +[`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +#### Defined in + +[packages/core/src/models/history.ts:186](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L186) + +--- + +### line + +▸ **line**(`idx`): [`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +return the given line of history + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `idx` | `number` | + +#### Returns + +[`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +#### Defined in + +[packages/core/src/models/history.ts:90](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L90) + +--- + +### lineByIncr + +▸ **lineByIncr**(`incr`): [`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `incr` | `number` | + +#### Returns + +[`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +#### Defined in + +[packages/core/src/models/history.ts:165](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L165) + +--- + +### next + +▸ **next**(): [`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +go forward one entry + +#### Returns + +[`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +#### Defined in + +[packages/core/src/models/history.ts:175](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L175) + +--- + +### previous + +▸ **previous**(): [`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +go back one entry + +#### Returns + +[`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md) + +#### Defined in + +[packages/core/src/models/history.ts:170](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L170) + +--- + +### restore + +▸ `Private` **restore**(`uuid?`): `any` + +Low-level restore from persistent storage + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `uuid` | `string` | + +#### Returns + +`any` + +#### Defined in + +[packages/core/src/models/history.ts:124](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L124) + +--- + +### save + +▸ `Private` **save**(`lines?`, `uuid?`): `void` + +Low-level save to persistent storage + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------- | +| `lines` | [`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md)[] | +| `uuid` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/history.ts:119](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L119) + +--- + +### slice + +▸ **slice**(`start`, `end?`): [`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `start` | `number` | +| `end?` | `number` | + +#### Returns + +[`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md)[] + +#### Defined in + +[packages/core/src/models/history.ts:94](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L94) + +--- + +### update + +▸ **update**(`cursor`, `updateFn`): `Promise`<`void`\> + +update a line of repl history -- for async operations + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------------------------------------------------------------------------- | +| `cursor` | `number` | +| `updateFn` | (`line`: [`HistoryLine`](../interfaces/kui_shell_core.HistoryLine.md)) => `void` \| `Promise`<`void`\> | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/models/history.ts:159](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L159) + +--- + +### wipe + +▸ **wipe**(): `boolean` + +Clear out all history + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/models/history.ts:140](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L140) diff --git a/docs/api/classes/kui_shell_core.Icon.md b/docs/api/classes/kui_shell_core.Icon.md new file mode 100644 index 00000000000..addfc386550 --- /dev/null +++ b/docs/api/classes/kui_shell_core.Icon.md @@ -0,0 +1,99 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Icon + +# Class: Icon + +[@kui-shell/core](../modules/kui_shell_core.md).Icon + +## Table of contents + +### Constructors + +- [constructor](kui_shell_core.Icon.md#constructor) + +### Properties + +- [balloon](kui_shell_core.Icon.md#balloon) +- [balloonLength](kui_shell_core.Icon.md#balloonlength) +- [balloonPos](kui_shell_core.Icon.md#balloonpos) +- [fontawesome](kui_shell_core.Icon.md#fontawesome) +- [onclick](kui_shell_core.Icon.md#onclick) + +## Constructors + +### constructor + +• **new Icon**(`icon`) + +#### Parameters + +| Name | Type | +| :----- | :------------------------------- | +| `icon` | [`Icon`](kui_shell_core.Icon.md) | + +#### Defined in + +[packages/core/src/webapp/models/table.ts:267](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L267) + +## Properties + +### balloon + +• `Optional` **balloon**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:261](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L261) + +--- + +### balloonLength + +• `Optional` **balloonLength**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:263](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L263) + +--- + +### balloonPos + +• `Optional` **balloonPos**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:265](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L265) + +--- + +### fontawesome + +• **fontawesome**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:257](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L257) + +--- + +### onclick + +• `Optional` **onclick**: (`evt`: `Event`) => `void` + +#### Type declaration + +▸ (`evt`): `void` + +##### Parameters + +| Name | Type | +| :---- | :------ | +| `evt` | `Event` | + +##### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:259](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L259) diff --git a/docs/api/classes/kui_shell_core.Row.md b/docs/api/classes/kui_shell_core.Row.md new file mode 100644 index 00000000000..b7f952bc451 --- /dev/null +++ b/docs/api/classes/kui_shell_core.Row.md @@ -0,0 +1,384 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Row + +# Class: Row + +[@kui-shell/core](../modules/kui_shell_core.md).Row + +## Table of contents + +### Constructors + +- [constructor](kui_shell_core.Row.md#constructor) + +### Properties + +- [attributes](kui_shell_core.Row.md#attributes) +- [beforeAttributes](kui_shell_core.Row.md#beforeattributes) +- [css](kui_shell_core.Row.md#css) +- [done](kui_shell_core.Row.md#done) +- [fontawesome](kui_shell_core.Row.md#fontawesome) +- [fontawesomeCSS](kui_shell_core.Row.md#fontawesomecss) +- [fullName](kui_shell_core.Row.md#fullname) +- [isDeleted](kui_shell_core.Row.md#isdeleted) +- [key](kui_shell_core.Row.md#key) +- [kind](kui_shell_core.Row.md#kind) +- [name](kui_shell_core.Row.md#name) +- [nameCss](kui_shell_core.Row.md#namecss) +- [nameDom](kui_shell_core.Row.md#namedom) +- [object](kui_shell_core.Row.md#object) +- [onclick](kui_shell_core.Row.md#onclick) +- [onclickExec](kui_shell_core.Row.md#onclickexec) +- [onclickIdempotent](kui_shell_core.Row.md#onclickidempotent) +- [outerCSS](kui_shell_core.Row.md#outercss) +- [packageName](kui_shell_core.Row.md#packagename) +- [prettyKind](kui_shell_core.Row.md#prettykind) +- [prettyName](kui_shell_core.Row.md#prettyname) +- [prettyType](kui_shell_core.Row.md#prettytype) +- [prettyVersion](kui_shell_core.Row.md#prettyversion) +- [rowCSS](kui_shell_core.Row.md#rowcss) +- [rowKey](kui_shell_core.Row.md#rowkey) +- [setSelected](kui_shell_core.Row.md#setselected) +- [setUnselected](kui_shell_core.Row.md#setunselected) +- [status](kui_shell_core.Row.md#status) +- [type](kui_shell_core.Row.md#type) +- [version](kui_shell_core.Row.md#version) + +## Constructors + +### constructor + +• **new Row**(`row`) + +#### Parameters + +| Name | Type | +| :---- | :----------------------------- | +| `row` | [`Row`](kui_shell_core.Row.md) | + +#### Defined in + +[packages/core/src/webapp/models/table.ts:93](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L93) + +## Properties + +### attributes + +• `Optional` **attributes**: [`Cell`](kui_shell_core.Cell.md)[] + +#### Defined in + +[packages/core/src/webapp/models/table.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L24) + +--- + +### beforeAttributes + +• `Optional` **beforeAttributes**: [`Cell`](kui_shell_core.Cell.md)[] + +#### Defined in + +[packages/core/src/webapp/models/table.ts:77](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L77) + +--- + +### css + +• `Optional` **css**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:87](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L87) + +--- + +### done + +• `Optional` **done**: `boolean` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:91](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L91) + +--- + +### fontawesome + +• `Optional` **fontawesome**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:53](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L53) + +--- + +### fontawesomeCSS + +• `Optional` **fontawesomeCSS**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L55) + +--- + +### fullName + +• `Optional` **fullName**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:65](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L65) + +--- + +### isDeleted + +• `Optional` **isDeleted**: `boolean` + +does this row represent a recently deleted resource? + +#### Defined in + +[packages/core/src/webapp/models/table.ts:45](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L45) + +--- + +### key + +• `Optional` **key**: `string` + +the key-value pair for the first column + +#### Defined in + +[packages/core/src/webapp/models/table.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L39) + +--- + +### kind + +• `Optional` **kind**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:67](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L67) + +--- + +### name + +• **name**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L40) + +--- + +### nameCss + +• `Optional` **nameCss**: `string` \| `string`[] + +#### Defined in + +[packages/core/src/webapp/models/table.ts:61](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L61) + +--- + +### nameDom + +• `Optional` **nameDom**: `Element` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:42](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L42) + +--- + +### object + +• `Optional` **object**: `Pick`<[`MetadataNamedResource`](../interfaces/kui_shell_core.MetadataNamedResource.md), `"metadata"`\> & { `spec?`: { `selector?`: { `matchLabels?`: `Record`<`string`, `string`\> } } } + +optional associated metadata for the corresponding resource + +#### Defined in + +[packages/core/src/webapp/models/table.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L30) + +--- + +### onclick + +• `Optional` **onclick**: `any` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:85](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L85) + +--- + +### onclickExec + +• `Optional` **onclickExec**: `"pexec"` \| `"qexec"` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:83](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L83) + +--- + +### onclickIdempotent + +• `Optional` **onclickIdempotent**: `boolean` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:81](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L81) + +--- + +### outerCSS + +• `Optional` **outerCSS**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:89](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L89) + +--- + +### packageName + +• `Optional` **packageName**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L49) + +--- + +### prettyKind + +• `Optional` **prettyKind**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:69](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L69) + +--- + +### prettyName + +• `Optional` **prettyName**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:63](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L63) + +--- + +### prettyType + +• `Optional` **prettyType**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L51) + +--- + +### prettyVersion + +• `Optional` **prettyVersion**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:75](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L75) + +--- + +### rowCSS + +• `Optional` **rowCSS**: `string` \| `string`[] + +#### Defined in + +[packages/core/src/webapp/models/table.ts:79](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L79) + +--- + +### rowKey + +• `Optional` **rowKey**: `string` + +uniquely identifies this row in a given table; if not defined, we will use the name field as the row key + +#### Defined in + +[packages/core/src/webapp/models/table.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L27) + +--- + +### setSelected + +• `Optional` **setSelected**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:57](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L57) + +--- + +### setUnselected + +• `Optional` **setUnselected**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:59](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L59) + +--- + +### status + +• `Optional` **status**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:71](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L71) + +--- + +### type + +• `Optional` **type**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L47) + +--- + +### version + +• `Optional` **version**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:73](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L73) diff --git a/docs/api/classes/kui_shell_core.TabState.md b/docs/api/classes/kui_shell_core.TabState.md new file mode 100644 index 00000000000..95b27fdac96 --- /dev/null +++ b/docs/api/classes/kui_shell_core.TabState.md @@ -0,0 +1,364 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / TabState + +# Class: TabState + +[@kui-shell/core](../modules/kui_shell_core.md).TabState + +State that we want to keep per tab + +## Table of contents + +### Constructors + +- [constructor](kui_shell_core.TabState.md#constructor) + +### Properties + +- [\_state](kui_shell_core.TabState.md#_state) +- [captures](kui_shell_core.TabState.md#captures) +- [closed](kui_shell_core.TabState.md#closed) +- [ready](kui_shell_core.TabState.md#ready) +- [restores](kui_shell_core.TabState.md#restores) +- [switchTos](kui_shell_core.TabState.md#switchtos) +- [uuid](kui_shell_core.TabState.md#uuid) + +### Accessors + +- [desiredStatusStripeDecoration](kui_shell_core.TabState.md#desiredstatusstripedecoration) +- [state](kui_shell_core.TabState.md#state) + +### Methods + +- [capture](kui_shell_core.TabState.md#capture) +- [checkExistence](kui_shell_core.TabState.md#checkexistence) +- [cloneWithUUID](kui_shell_core.TabState.md#clonewithuuid) +- [getState](kui_shell_core.TabState.md#getstate) +- [register](kui_shell_core.TabState.md#register) +- [restore](kui_shell_core.TabState.md#restore) +- [setState](kui_shell_core.TabState.md#setstate) +- [switchTo](kui_shell_core.TabState.md#switchto) +- [updateStatusStripe](kui_shell_core.TabState.md#updatestatusstripe) + +## Constructors + +### constructor + +• **new TabState**(`uuid`, `_desiredStatusStripeDecoration?`, `_parent?`) + +#### Parameters + +| Name | Type | +| :------------------------------- | :--------------------------------------------------------------------------------------- | +| `uuid` | `string` | +| `_desiredStatusStripeDecoration` | [`StatusStripeChangeEvent`](../modules/kui_shell_core.Events.md#statusstripechangeevent) | +| `_parent?` | [`TabState`](kui_shell_core.TabState.md) | + +#### Defined in + +[packages/core/src/models/tab-state.ts:68](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L68) + +## Properties + +### \_state + +• `Private` **\_state**: `Record`<`string`, `Record`<`string`, `any`\>\> = `{}` + +state map +outer key is `TabStateRegistrar.name`, inner key is `TabStateRegistrar.apiVersion` +e.g. { 'plugins/plugin-core': {'v1': {'cwd': '/'}}} + +#### Defined in + +[packages/core/src/models/tab-state.ts:57](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L57) + +--- + +### captures + +• `Private` **captures**: `CaptureFn`[] = `[]` + +functions to capture the states of tab + +#### Defined in + +[packages/core/src/models/tab-state.ts:60](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L60) + +--- + +### closed + +• **closed**: `boolean` + +is the tab closed? + +#### Defined in + +[packages/core/src/models/tab-state.ts:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L51) + +--- + +### ready + +• **ready**: `boolean` = `false` + +is the tab ready for command execution? + +#### Defined in + +[packages/core/src/models/tab-state.ts:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L48) + +--- + +### restores + +• `Private` **restores**: `RestoreFn`[] = `[]` + +functions to restore the states of the tab + +#### Defined in + +[packages/core/src/models/tab-state.ts:63](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L63) + +--- + +### switchTos + +• `Private` **switchTos**: `SwitchToFn`[] = `[]` + +functions to capture this tab state and restore another tab state + +#### Defined in + +[packages/core/src/models/tab-state.ts:66](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L66) + +--- + +### uuid + +• `Readonly` **uuid**: `string` + +## Accessors + +### desiredStatusStripeDecoration + +• `get` **desiredStatusStripeDecoration**(): [`StatusStripeChangeEvent`](../modules/kui_shell_core.Events.md#statusstripechangeevent) + +#### Returns + +[`StatusStripeChangeEvent`](../modules/kui_shell_core.Events.md#statusstripechangeevent) + +#### Defined in + +[packages/core/src/models/tab-state.ts:154](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L154) + +• `set` **desiredStatusStripeDecoration**(`decor`): `void` + +#### Parameters + +| Name | Type | +| :------ | :--------------------------------------------------------------------------------------- | +| `decor` | [`StatusStripeChangeEvent`](../modules/kui_shell_core.Events.md#statusstripechangeevent) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/tab-state.ts:158](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L158) + +--- + +### state + +• `get` **state**(): `Record`<`string`, `Record`<`string`, `any`\>\> + +#### Returns + +`Record`<`string`, `Record`<`string`, `any`\>\> + +#### Defined in + +[packages/core/src/models/tab-state.ts:78](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L78) + +## Methods + +### capture + +▸ **capture**(): `void` + +Capture contextual global state + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/tab-state.ts:124](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L124) + +--- + +### checkExistence + +▸ `Private` **checkExistence**(`name`, `apiVersion`): `boolean` + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `name` | `string` | +| `apiVersion` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/models/tab-state.ts:82](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L82) + +--- + +### cloneWithUUID + +▸ **cloneWithUUID**(`uuid`): [`TabState`](kui_shell_core.TabState.md) + +Clone the captured state + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `uuid` | `string` | + +#### Returns + +[`TabState`](kui_shell_core.TabState.md) + +#### Defined in + +[packages/core/src/models/tab-state.ts:137](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L137) + +--- + +### getState + +▸ **getState**(`name`, `apiVersion`, `key`): `any` + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `name` | `string` | +| `apiVersion` | `string` | +| `key` | `string` | + +#### Returns + +`any` + +#### Defined in + +[packages/core/src/models/tab-state.ts:107](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L107) + +--- + +### register + +▸ **register**(`name`, `apiVersion`, `capture`, `restore`, `switchTo`): `void` + +#### Parameters + +| Name | Type | +| :----------- | :----------- | +| `name` | `string` | +| `apiVersion` | `string` | +| `capture` | `CaptureFn` | +| `restore` | `RestoreFn` | +| `switchTo` | `SwitchToFn` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/tab-state.ts:92](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L92) + +--- + +### restore + +▸ **restore**(): `Promise`<`void`\> + +Restore tab state + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/models/tab-state.ts:171](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L171) + +--- + +### setState + +▸ **setState**(`name`, `apiVersion`, `key`, `value`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `name` | `string` | +| `apiVersion` | `string` | +| `key` | `string` | +| `value` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/models/tab-state.ts:117](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L117) + +--- + +### switchTo + +▸ **switchTo**(`nextTabState`): `Promise`<`void`\> + +Capture contextual global state and then restore `nextTabState` + +#### Parameters + +| Name | Type | +| :------------- | :--------------------------------------- | +| `nextTabState` | [`TabState`](kui_shell_core.TabState.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/models/tab-state.ts:129](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L129) + +--- + +### updateStatusStripe + +▸ **updateStatusStripe**(): `void` + +Enforce our desired status stripe decorations + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/tab-state.ts:146](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L146) diff --git a/docs/api/classes/kui_shell_core.Table.md b/docs/api/classes/kui_shell_core.Table.md new file mode 100644 index 00000000000..1dc30e2e8ca --- /dev/null +++ b/docs/api/classes/kui_shell_core.Table.md @@ -0,0 +1,347 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Table + +# Class: Table + +[@kui-shell/core](../modules/kui_shell_core.md).Table + +## Type parameters + +| Name | Type | +| :-------- | :------------------------------------------------------------------- | +| `RowType` | extends [`Row`](kui_shell_core.Row.md)[`Row`](kui_shell_core.Row.md) | + +## Table of contents + +### Constructors + +- [constructor](kui_shell_core.Table.md#constructor) + +### Properties + +- [allowedPresentations](kui_shell_core.Table.md#allowedpresentations) +- [body](kui_shell_core.Table.md#body) +- [breadcrumbs](kui_shell_core.Table.md#breadcrumbs) +- [coldStartColumnIdx](kui_shell_core.Table.md#coldstartcolumnidx) +- [colorBy](kui_shell_core.Table.md#colorby) +- [completeColumnIdx](kui_shell_core.Table.md#completecolumnidx) +- [defaultPresentation](kui_shell_core.Table.md#defaultpresentation) +- [drilldownTo](kui_shell_core.Table.md#drilldownto) +- [durationColumnIdx](kui_shell_core.Table.md#durationcolumnidx) +- [flexWrap](kui_shell_core.Table.md#flexwrap) +- [fontawesome](kui_shell_core.Table.md#fontawesome) +- [fontawesomeBalloon](kui_shell_core.Table.md#fontawesomeballoon) +- [fontawesomeCSS](kui_shell_core.Table.md#fontawesomecss) +- [footer](kui_shell_core.Table.md#footer) +- [header](kui_shell_core.Table.md#header) +- [markdown](kui_shell_core.Table.md#markdown) +- [nFooterMessages](kui_shell_core.Table.md#nfootermessages) +- [noSort](kui_shell_core.Table.md#nosort) +- [queueingDelayColumnIdx](kui_shell_core.Table.md#queueingdelaycolumnidx) +- [resourceVersion](kui_shell_core.Table.md#resourceversion) +- [startColumnIdx](kui_shell_core.Table.md#startcolumnidx) +- [statusColumnIdx](kui_shell_core.Table.md#statuscolumnidx) +- [style](kui_shell_core.Table.md#style) +- [tableCSS](kui_shell_core.Table.md#tablecss) +- [title](kui_shell_core.Table.md#title) + +## Constructors + +### constructor + +• **new Table**<`RowType`\>(`table`) + +#### Type parameters + +| Name | Type | +| :-------- | :------------------------------------------------------------------------------- | +| `RowType` | extends [`Row`](kui_shell_core.Row.md)<`RowType`\>[`Row`](kui_shell_core.Row.md) | + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------ | +| `table` | [`Table`](kui_shell_core.Table.md)<[`Row`](kui_shell_core.Row.md)\> | + +#### Defined in + +[packages/core/src/webapp/models/table.ts:212](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L212) + +## Properties + +### allowedPresentations + +• `Optional` **allowedPresentations**: `PresentationStyle`[] + +Allowed presentations? + +#### Defined in + +[packages/core/src/webapp/models/table.ts:161](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L161) + +--- + +### body + +• **body**: `RowType`[] + +#### Defined in + +[packages/core/src/webapp/models/table.ts:142](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L142) + +--- + +### breadcrumbs + +• `Optional` **breadcrumbs**: [`Breadcrumb`](../interfaces/kui_shell_core.Breadcrumb.md)[] \| () => [`Breadcrumb`](../interfaces/kui_shell_core.Breadcrumb.md)[] + +#### Defined in + +[packages/core/src/webapp/models/table.ts:200](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L200) + +--- + +### coldStartColumnIdx + +• `Optional` **coldStartColumnIdx**: `number` + +Column index to be interpreted as a time to initialize the computation + +#### Defined in + +[packages/core/src/webapp/models/table.ts:170](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L170) + +--- + +### colorBy + +• `Optional` **colorBy**: `"default"` \| `"status"` \| `"duration"` + +Coloring strategy for e.g. 'grid' and 'sequence-diagram' and 'histogram' + +#### Defined in + +[packages/core/src/webapp/models/table.ts:182](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L182) + +--- + +### completeColumnIdx + +• `Optional` **completeColumnIdx**: `number` + +Column index to be interpreted as a complete timestamp column + +#### Defined in + +[packages/core/src/webapp/models/table.ts:179](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L179) + +--- + +### defaultPresentation + +• `Optional` **defaultPresentation**: `PresentationStyle` + +Default presentation? + +#### Defined in + +[packages/core/src/webapp/models/table.ts:158](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L158) + +--- + +### drilldownTo + +• `Optional` **drilldownTo**: `"side-split"` \| `"this-split"` \| `"new-window"` + +Should drilldowns go to a side split, or to this split? Default: +`side-split`, unless the user chords the click with the Meta key +(which is Command on macOS, and Option on Linux/Windows + +#### Defined in + +[packages/core/src/webapp/models/table.ts:155](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L155) + +--- + +### durationColumnIdx + +• `Optional` **durationColumnIdx**: `number` + +Column index to be interpreted as a duration column + +#### Defined in + +[packages/core/src/webapp/models/table.ts:167](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L167) + +--- + +### flexWrap + +• `Optional` **flexWrap**: `number` \| `boolean` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:202](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L202) + +--- + +### fontawesome + +• `Optional` **fontawesome**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:206](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L206) + +--- + +### fontawesomeBalloon + +• `Optional` **fontawesomeBalloon**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:210](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L210) + +--- + +### fontawesomeCSS + +• `Optional` **fontawesomeCSS**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:208](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L208) + +--- + +### footer + +• `Optional` **footer**: `string`[] + +#### Defined in + +[packages/core/src/webapp/models/table.ts:188](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L188) + +--- + +### header + +• `Optional` **header**: `RowType` & { `isSortable?`: `boolean` } + +#### Defined in + +[packages/core/src/webapp/models/table.ts:186](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L186) + +--- + +### markdown + +• `Optional` **markdown**: `boolean` + +Markdown cells? + +#### Defined in + +[packages/core/src/webapp/models/table.ts:145](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L145) + +--- + +### nFooterMessages + +• `Optional` **nFooterMessages**: `number` + +E.g. when displaying events for a Kubernetes table, how many +events to show in the viewport. Use -1 to show them +all. [Default: 6] + +#### Defined in + +[packages/core/src/webapp/models/table.ts:195](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L195) + +--- + +### noSort + +• `Optional` **noSort**: `boolean` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:197](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L197) + +--- + +### queueingDelayColumnIdx + +• `Optional` **queueingDelayColumnIdx**: `number` + +Column index to be interpreted as a time spent in a run queue + +#### Defined in + +[packages/core/src/webapp/models/table.ts:173](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L173) + +--- + +### resourceVersion + +• `Optional` **resourceVersion**: `string` \| `number` + +This field helps with watching/paginating + +#### Defined in + +[packages/core/src/webapp/models/table.ts:148](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L148) + +--- + +### startColumnIdx + +• `Optional` **startColumnIdx**: `number` + +Column index to be interpreted as a start timestamp column + +#### Defined in + +[packages/core/src/webapp/models/table.ts:176](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L176) + +--- + +### statusColumnIdx + +• `Optional` **statusColumnIdx**: `number` + +Column index to be interpreted as a status column + +#### Defined in + +[packages/core/src/webapp/models/table.ts:164](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L164) + +--- + +### style + +• `Optional` **style**: [`TableStyle`](../enums/kui_shell_core.TableStyle.md) + +#### Defined in + +[packages/core/src/webapp/models/table.ts:184](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L184) + +--- + +### tableCSS + +• `Optional` **tableCSS**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:204](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L204) + +--- + +### title + +• `Optional` **title**: `string` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:199](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L199) diff --git a/docs/api/classes/kui_shell_core.UsageError.md b/docs/api/classes/kui_shell_core.UsageError.md new file mode 100644 index 00000000000..f9497551d1f --- /dev/null +++ b/docs/api/classes/kui_shell_core.UsageError.md @@ -0,0 +1,281 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / UsageError + +# Class: UsageError + +[@kui-shell/core](../modules/kui_shell_core.md).UsageError + +## Hierarchy + +- `Error` + + ↳ **`UsageError`** + +## Implements + +- [`CodedError`](../interfaces/kui_shell_core.CodedError.md) +- `UsageErrorLike` + +## Table of contents + +### Constructors + +- [constructor](kui_shell_core.UsageError.md#constructor) + +### Properties + +- [code](kui_shell_core.UsageError.md#code) +- [formattedMessage](kui_shell_core.UsageError.md#formattedmessage) +- [message](kui_shell_core.UsageError.md#message) +- [name](kui_shell_core.UsageError.md#name) +- [raw](kui_shell_core.UsageError.md#raw) +- [stack](kui_shell_core.UsageError.md#stack) +- [stackTraceLimit](kui_shell_core.UsageError.md#stacktracelimit) + +### Methods + +- [getUsageModel](kui_shell_core.UsageError.md#getusagemodel) +- [captureStackTrace](kui_shell_core.UsageError.md#capturestacktrace) +- [getFormattedMessage](kui_shell_core.UsageError.md#getformattedmessage) +- [isUsageError](kui_shell_core.UsageError.md#isusageerror) +- [prepareStackTrace](kui_shell_core.UsageError.md#preparestacktrace) + +## Constructors + +### constructor + +• **new UsageError**(`message`, `extra?`) + +#### Parameters + +| Name | Type | +| :-------- | :------------- | +| `message` | `UsageLike` | +| `extra?` | `UsageOptions` | + +#### Overrides + +Error.constructor + +#### Defined in + +[packages/core/src/core/usage-error.ts:901](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L901) + +## Properties + +### code + +• **code**: `number` + +#### Implementation of + +[CodedError](../interfaces/kui_shell_core.CodedError.md).[code](../interfaces/kui_shell_core.CodedError.md#code) + +#### Defined in + +[packages/core/src/core/usage-error.ts:899](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L899) + +--- + +### formattedMessage + +• **formattedMessage**: `Promise`<`HTMLElement`\> + +#### Implementation of + +UsageErrorLike.formattedMessage + +#### Defined in + +[packages/core/src/core/usage-error.ts:895](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L895) + +--- + +### message + +• **message**: `string` + +#### Implementation of + +[CodedError](../interfaces/kui_shell_core.CodedError.md).[message](../interfaces/kui_shell_core.CodedError.md#message) + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:974 + +--- + +### name + +• **name**: `string` + +#### Implementation of + +[CodedError](../interfaces/kui_shell_core.CodedError.md).[name](../interfaces/kui_shell_core.CodedError.md#name) + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:973 + +--- + +### raw + +• **raw**: `UsageLike` + +#### Implementation of + +UsageErrorLike.raw + +#### Defined in + +[packages/core/src/core/usage-error.ts:897](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L897) + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Implementation of + +[CodedError](../interfaces/kui_shell_core.CodedError.md).[stack](../interfaces/kui_shell_core.CodedError.md#stack) + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:975 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:142 + +## Methods + +### getUsageModel + +▸ **getUsageModel**(): [`UsageModel`](../interfaces/kui_shell_core.UsageModel.md) + +#### Returns + +[`UsageModel`](../interfaces/kui_shell_core.UsageModel.md) + +#### Defined in + +[packages/core/src/core/usage-error.ts:917](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L917) + +--- + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `Object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:133 + +--- + +### getFormattedMessage + +▸ `Static` **getFormattedMessage**(`err`): `Promise`<`HTMLElement`\> + +#### Parameters + +| Name | Type | +| :---- | :--------------- | +| `err` | `UsageErrorLike` | + +#### Returns + +`Promise`<`HTMLElement`\> + +#### Defined in + +[packages/core/src/core/usage-error.ts:921](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L921) + +--- + +### isUsageError + +▸ `Static` **isUsageError**(`error`): error is UsageErrorLike + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `error` | `Entity`<`void`, [`Row`](kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> \| `UsageErrorLike` | + +#### Returns + +error is UsageErrorLike + +#### Defined in + +[packages/core/src/core/usage-error.ts:929](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L929) + +--- + +### prepareStackTrace + +▸ `Static` `Optional` **prepareStackTrace**(`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`see`** https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces + +#### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +#### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:140 diff --git a/docs/api/classes/kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md b/docs/api/classes/kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md new file mode 100644 index 00000000000..c7164fb4a5d --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md @@ -0,0 +1,600 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-bash-like](../modules/kui_shell_plugin_bash_like.md) / StdioChannelWebsocketSide + +# Class: StdioChannelWebsocketSide + +[@kui-shell/plugin-bash-like](../modules/kui_shell_plugin_bash_like.md).StdioChannelWebsocketSide + +stdin/stdout channel + +## Hierarchy + +- `EventEmitter` + + ↳ **`StdioChannelWebsocketSide`** + +## Implements + +- `Channel` + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#constructor) + +### Properties + +- [readyState](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#readystate) +- [ws](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#ws) +- [wss](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#wss) +- [defaultMaxListeners](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#defaultmaxlisteners) + +### Methods + +- [addListener](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#addlistener) +- [close](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#close) +- [emit](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#emit) +- [eventNames](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#eventnames) +- [getMaxListeners](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#getmaxlisteners) +- [init](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#init) +- [listenerCount](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#listenercount) +- [listeners](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#listeners) +- [off](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#off) +- [on](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#on) +- [once](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#once) +- [prependListener](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#prependlistener) +- [prependOnceListener](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#prependoncelistener) +- [rawListeners](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#rawlisteners) +- [removeAllListeners](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#removealllisteners) +- [removeEventListener](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#removeeventlistener) +- [removeListener](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#removelistener) +- [send](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#send) +- [setMaxListeners](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#setmaxlisteners) +- [listenerCount](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md#listenercount) + +## Constructors + +### constructor + +• **new StdioChannelWebsocketSide**(`wss`) + +#### Parameters + +| Name | Type | +| :---- | :------------- | +| `wss` | `EventEmitter` | + +#### Overrides + +EventEmitter.constructor + +#### Defined in + +[plugins/plugin-bash-like/src/pty/stdio-channel.ts:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/pty/stdio-channel.ts#L46) + +## Properties + +### readyState + +• **readyState**: `ReadyState` = `ReadyState.CONNECTING` + +#### Implementation of + +Channel.readyState + +#### Defined in + +[plugins/plugin-bash-like/src/pty/stdio-channel.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/pty/stdio-channel.ts#L40) + +--- + +### ws + +• `Private` **ws**: `Channel` + +#### Defined in + +[plugins/plugin-bash-like/src/pty/stdio-channel.ts:42](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/pty/stdio-channel.ts#L42) + +--- + +### wss + +• `Private` `Readonly` **wss**: `EventEmitter` + +#### Defined in + +[plugins/plugin-bash-like/src/pty/stdio-channel.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/pty/stdio-channel.ts#L44) + +--- + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +#### Inherited from + +EventEmitter.defaultMaxListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:18 + +## Methods + +### addListener + +▸ **addListener**(`event`, `listener`): [`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Inherited from + +EventEmitter.addListener + +#### Defined in + +node_modules/@types/node/events.d.ts:20 + +--- + +### close + +▸ **close**(): `void` + +Forcibly close the channel + +#### Returns + +`void` + +#### Implementation of + +Channel.close + +#### Defined in + +[plugins/plugin-bash-like/src/pty/stdio-channel.ts:144](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/pty/stdio-channel.ts#L144) + +--- + +### emit + +▸ **emit**(`event`, ...`args`): `boolean` + +#### Parameters + +| Name | Type | +| :-------- | :------------------- | +| `event` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Inherited from + +EventEmitter.emit + +#### Defined in + +node_modules/@types/node/events.d.ts:32 + +--- + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +#### Returns + +(`string` \| `symbol`)[] + +#### Inherited from + +EventEmitter.eventNames + +#### Defined in + +node_modules/@types/node/events.d.ts:33 + +--- + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +#### Returns + +`number` + +#### Inherited from + +EventEmitter.getMaxListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:29 + +--- + +### init + +▸ **init**(`child`, `pollInterval?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------------- | :------------- | :------------ | +| `child` | `ChildProcess` | `undefined` | +| `pollInterval` | `number` | `30000` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-bash-like/src/pty/stdio-channel.ts:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/pty/stdio-channel.ts#L51) + +--- + +### listenerCount + +▸ **listenerCount**(`type`): `number` + +#### Parameters + +| Name | Type | +| :----- | :------------------- | +| `type` | `string` \| `symbol` | + +#### Returns + +`number` + +#### Inherited from + +EventEmitter.listenerCount + +#### Defined in + +node_modules/@types/node/events.d.ts:34 + +--- + +### listeners + +▸ **listeners**(`event`): `Function`[] + +#### Parameters + +| Name | Type | +| :------ | :------------------- | +| `event` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Inherited from + +EventEmitter.listeners + +#### Defined in + +node_modules/@types/node/events.d.ts:30 + +--- + +### off + +▸ **off**(`event`, `listener`): [`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Inherited from + +EventEmitter.off + +#### Defined in + +node_modules/@types/node/events.d.ts:26 + +--- + +### on + +▸ **on**(`event`, `listener`): [`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Implementation of + +Channel.on + +#### Inherited from + +EventEmitter.on + +#### Defined in + +node_modules/@types/node/events.d.ts:21 + +--- + +### once + +▸ **once**(`event`, `listener`): [`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Inherited from + +EventEmitter.once + +#### Defined in + +node_modules/@types/node/events.d.ts:22 + +--- + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Inherited from + +EventEmitter.prependListener + +#### Defined in + +node_modules/@types/node/events.d.ts:23 + +--- + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Inherited from + +EventEmitter.prependOnceListener + +#### Defined in + +node_modules/@types/node/events.d.ts:24 + +--- + +### rawListeners + +▸ **rawListeners**(`event`): `Function`[] + +#### Parameters + +| Name | Type | +| :------ | :------------------- | +| `event` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Inherited from + +EventEmitter.rawListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:31 + +--- + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Parameters + +| Name | Type | +| :------- | :------------------- | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Inherited from + +EventEmitter.removeAllListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:27 + +--- + +### removeEventListener + +▸ **removeEventListener**(`eventType`, `handler`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `eventType` | `string` | +| `handler` | `any` | + +#### Returns + +`void` + +#### Implementation of + +Channel.removeEventListener + +#### Defined in + +[plugins/plugin-bash-like/src/pty/stdio-channel.ts:174](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/pty/stdio-channel.ts#L174) + +--- + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Inherited from + +EventEmitter.removeListener + +#### Defined in + +node_modules/@types/node/events.d.ts:25 + +--- + +### send + +▸ **send**(`msg`): `void` + +emit 'message' on the other side + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `msg` | `string` | + +#### Returns + +`void` + +#### Implementation of + +Channel.send + +#### Defined in + +[plugins/plugin-bash-like/src/pty/stdio-channel.ts:150](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/pty/stdio-channel.ts#L150) + +--- + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `n` | `number` | + +#### Returns + +[`StdioChannelWebsocketSide`](kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +#### Inherited from + +EventEmitter.setMaxListeners + +#### Defined in + +node_modules/@types/node/events.d.ts:28 + +--- + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `event`): `number` + +**`deprecated`** since v4.0.0 + +#### Parameters + +| Name | Type | +| :-------- | :------------------- | +| `emitter` | `EventEmitter` | +| `event` | `string` \| `symbol` | + +#### Returns + +`number` + +#### Inherited from + +EventEmitter.listenerCount + +#### Defined in + +node_modules/@types/node/events.d.ts:17 diff --git a/docs/api/classes/kui_shell_plugin_client_common.ContextWidgets.md b/docs/api/classes/kui_shell_plugin_client_common.ContextWidgets.md new file mode 100644 index 00000000000..7623f0c476f --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.ContextWidgets.md @@ -0,0 +1,657 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / ContextWidgets + +# Class: ContextWidgets + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).ContextWidgets + +## Hierarchy + +- `PureComponent`<`Props`\> + + ↳ **`ContextWidgets`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.ContextWidgets.md#constructor) + +### Properties + +- [context](kui_shell_plugin_client_common.ContextWidgets.md#context) +- [props](kui_shell_plugin_client_common.ContextWidgets.md#props) +- [refs](kui_shell_plugin_client_common.ContextWidgets.md#refs) +- [state](kui_shell_plugin_client_common.ContextWidgets.md#state) +- [contextType](kui_shell_plugin_client_common.ContextWidgets.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.ContextWidgets.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.ContextWidgets.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.ContextWidgets.md#unsafe_componentwillupdate) +- [componentDidCatch](kui_shell_plugin_client_common.ContextWidgets.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.ContextWidgets.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.ContextWidgets.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.ContextWidgets.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.ContextWidgets.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.ContextWidgets.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.ContextWidgets.md#componentwillupdate) +- [forceUpdate](kui_shell_plugin_client_common.ContextWidgets.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.ContextWidgets.md#getsnapshotbeforeupdate) +- [render](kui_shell_plugin_client_common.ContextWidgets.md#render) +- [setState](kui_shell_plugin_client_common.ContextWidgets.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.ContextWidgets.md#shouldcomponentupdate) + +## Constructors + +### constructor + +• **new ContextWidgets**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------ | +| `props` | `Props` \| `Readonly`<`Props`\> | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:475 + +• **new ContextWidgets**(`props`, `context`) + +**`deprecated`** + +**`see`** https://reactjs.org/docs/legacy-context.html + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `props` | `Props` | +| `context` | `any` | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:480 + +## Properties + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :-------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`Object`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :-------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`Object`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/ContextWidgets.tsx:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/ContextWidgets.tsx#L27) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------- | +| `K` | extends `never` | + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------------------------------------------------------------------------------------------- | +| `state` | {} \| (`prevState`: `Readonly`<`Object`\>, `props`: `Readonly`<`Props`\>) => {} \| `Pick`<`Object`, `K`\> \| `Pick`<`Object`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 diff --git a/docs/api/classes/kui_shell_plugin_client_common.CurrentWorkingDirectory.md b/docs/api/classes/kui_shell_plugin_client_common.CurrentWorkingDirectory.md new file mode 100644 index 00000000000..b022175c269 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.CurrentWorkingDirectory.md @@ -0,0 +1,664 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / CurrentWorkingDirectory + +# Class: CurrentWorkingDirectory + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).CurrentWorkingDirectory + +## Hierarchy + +- `PureComponent`<`Props`, `State`\> + + ↳ **`CurrentWorkingDirectory`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#constructor) + +### Properties + +- [context](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#context) +- [handler](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#handler) +- [props](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#props) +- [refs](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#refs) +- [state](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#state) +- [contextType](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#unsafe_componentwillupdate) +- [componentDidCatch](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#componentwillupdate) +- [forceUpdate](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#getsnapshotbeforeupdate) +- [render](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#render) +- [reportCurrentDirectory](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#reportcurrentdirectory) +- [setState](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.CurrentWorkingDirectory.md#shouldcomponentupdate) + +## Constructors + +### constructor + +• **new CurrentWorkingDirectory**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Overrides + +React.PureComponent<Props, State\>.constructor + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx:36](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx#L36) + +## Properties + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### handler + +• `Private` `Readonly` **handler**: `any` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx#L34) + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`State`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ **componentDidMount**(): `void` + +Once we have mounted, we immediately check the state, +and schedule an update based on standard REPL events. + +#### Returns + +`void` + +#### Overrides + +React.PureComponent.componentDidMount + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx:62](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx#L62) + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ **componentWillUnmount**(): `void` + +Make sure to unsubscribe! + +#### Returns + +`void` + +#### Overrides + +React.PureComponent.componentWillUnmount + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx:68](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx#L68) + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx:72](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx#L72) + +--- + +### reportCurrentDirectory + +▸ `Private` **reportCurrentDirectory**(): `Promise`<`void`\> + +Check the current working directory + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx#L49) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------- | +| `K` | extends keyof `State` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `State` \| (`prevState`: `Readonly`<`State`\>, `props`: `Readonly`<`Props`\>) => `State` \| `Pick`<`State`, `K`\> \| `Pick`<`State`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 diff --git a/docs/api/classes/kui_shell_plugin_client_common.FancyPipeline.md b/docs/api/classes/kui_shell_plugin_client_common.FancyPipeline.md new file mode 100644 index 00000000000..2b629e84122 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.FancyPipeline.md @@ -0,0 +1,696 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / FancyPipeline + +# Class: FancyPipeline + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).FancyPipeline + +## Hierarchy + +- `PureComponent`<`Props`\> + + ↳ **`FancyPipeline`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.FancyPipeline.md#constructor) + +### Properties + +- [context](kui_shell_plugin_client_common.FancyPipeline.md#context) +- [props](kui_shell_plugin_client_common.FancyPipeline.md#props) +- [refs](kui_shell_plugin_client_common.FancyPipeline.md#refs) +- [state](kui_shell_plugin_client_common.FancyPipeline.md#state) +- [contextType](kui_shell_plugin_client_common.FancyPipeline.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.FancyPipeline.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.FancyPipeline.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.FancyPipeline.md#unsafe_componentwillupdate) +- [componentDidCatch](kui_shell_plugin_client_common.FancyPipeline.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.FancyPipeline.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.FancyPipeline.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.FancyPipeline.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.FancyPipeline.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.FancyPipeline.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.FancyPipeline.md#componentwillupdate) +- [forceUpdate](kui_shell_plugin_client_common.FancyPipeline.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.FancyPipeline.md#getsnapshotbeforeupdate) +- [linebreak](kui_shell_plugin_client_common.FancyPipeline.md#linebreak) +- [pipe](kui_shell_plugin_client_common.FancyPipeline.md#pipe) +- [render](kui_shell_plugin_client_common.FancyPipeline.md#render) +- [setState](kui_shell_plugin_client_common.FancyPipeline.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.FancyPipeline.md#shouldcomponentupdate) + +## Constructors + +### constructor + +• **new FancyPipeline**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------ | +| `props` | `Props` \| `Readonly`<`Props`\> | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:475 + +• **new FancyPipeline**(`props`, `context`) + +**`deprecated`** + +**`see`** https://reactjs.org/docs/legacy-context.html + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `props` | `Props` | +| `context` | `any` | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:480 + +## Properties + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :-------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`Object`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :-------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`Object`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### linebreak + +▸ `Private` **linebreak**(): `Element` + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/FancyPipeline.tsx:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/FancyPipeline.tsx#L23) + +--- + +### pipe + +▸ `Private` **pipe**(`c`): `Element` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `c` | `string` | + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/FancyPipeline.tsx:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/FancyPipeline.tsx#L27) + +--- + +### render + +▸ **render**(): `Element` + +Pretty-print the command line with `pipeStages` +e.g. somePrefix -- foo | bar > baz + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/FancyPipeline.tsx:35](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/FancyPipeline.tsx#L35) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------- | +| `K` | extends `never` | + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------------------------------------------------------------------------------------------- | +| `state` | {} \| (`prevState`: `Readonly`<`Object`\>, `props`: `Readonly`<`Props`\>) => {} \| `Pick`<`Object`, `K`\> \| `Pick`<`Object`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 diff --git a/docs/api/classes/kui_shell_plugin_client_common.HTMLDom.md b/docs/api/classes/kui_shell_plugin_client_common.HTMLDom.md new file mode 100644 index 00000000000..bea8be99c2d --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.HTMLDom.md @@ -0,0 +1,660 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / HTMLDom + +# Class: HTMLDom + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).HTMLDom + +for html pre-rendered dom content + +## Hierarchy + +- `PureComponent`<`Props`\> + + ↳ **`HTMLDom`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.HTMLDom.md#constructor) + +### Properties + +- [context](kui_shell_plugin_client_common.HTMLDom.md#context) +- [props](kui_shell_plugin_client_common.HTMLDom.md#props) +- [refs](kui_shell_plugin_client_common.HTMLDom.md#refs) +- [state](kui_shell_plugin_client_common.HTMLDom.md#state) +- [contextType](kui_shell_plugin_client_common.HTMLDom.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.HTMLDom.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.HTMLDom.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.HTMLDom.md#unsafe_componentwillupdate) +- [componentDidCatch](kui_shell_plugin_client_common.HTMLDom.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.HTMLDom.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.HTMLDom.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.HTMLDom.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.HTMLDom.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.HTMLDom.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.HTMLDom.md#componentwillupdate) +- [forceUpdate](kui_shell_plugin_client_common.HTMLDom.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.HTMLDom.md#getsnapshotbeforeupdate) +- [render](kui_shell_plugin_client_common.HTMLDom.md#render) +- [setState](kui_shell_plugin_client_common.HTMLDom.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.HTMLDom.md#shouldcomponentupdate) +- [getDerivedStateFromProps](kui_shell_plugin_client_common.HTMLDom.md#getderivedstatefromprops) + +## Constructors + +### constructor + +• **new HTMLDom**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Overrides + +React.PureComponent<Props\>.constructor + +#### Defined in + +[plugins/plugin-client-common/src/components/Content/Scalar/HTMLDom.tsx:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Content/Scalar/HTMLDom.tsx#L31) + +## Properties + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :-------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`Object`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :-------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`Object`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Content/Scalar/HTMLDom.tsx:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Content/Scalar/HTMLDom.tsx#L51) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------- | +| `K` | extends `never` | + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------------------------------------------------------------------------------------------- | +| `state` | {} \| (`prevState`: `Readonly`<`Object`\>, `props`: `Readonly`<`Props`\>) => {} \| `Pick`<`Object`, `K`\> \| `Pick`<`Object`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 + +--- + +### getDerivedStateFromProps + +▸ `Static` **getDerivedStateFromProps**(`props`, `state`): `State` \| { `isRendered`: `boolean` = true } + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | +| `state` | `State` | + +#### Returns + +`State` \| { `isRendered`: `boolean` = true } + +#### Defined in + +[plugins/plugin-client-common/src/components/Content/Scalar/HTMLDom.tsx:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Content/Scalar/HTMLDom.tsx#L40) diff --git a/docs/api/classes/kui_shell_plugin_client_common.InputProvider.md b/docs/api/classes/kui_shell_plugin_client_common.InputProvider.md new file mode 100644 index 00000000000..3461ba7d771 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.InputProvider.md @@ -0,0 +1,837 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / InputProvider + +# Class: InputProvider + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).InputProvider + +## Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `S` | extends [`InputProviderState`](../interfaces/kui_shell_plugin_client_common.InputProviderState.md)[`InputProviderState`](../interfaces/kui_shell_plugin_client_common.InputProviderState.md) | + +## Hierarchy + +- `PureComponent`<[`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops), `S`\> + + ↳ **`InputProvider`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.InputProvider.md#constructor) + +### Properties + +- [\_cancelReEdit](kui_shell_plugin_client_common.InputProvider.md#_cancelreedit) +- [context](kui_shell_plugin_client_common.InputProvider.md#context) +- [props](kui_shell_plugin_client_common.InputProvider.md#props) +- [refs](kui_shell_plugin_client_common.InputProvider.md#refs) +- [state](kui_shell_plugin_client_common.InputProvider.md#state) +- [contextType](kui_shell_plugin_client_common.InputProvider.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.InputProvider.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.InputProvider.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.InputProvider.md#unsafe_componentwillupdate) +- [cancelReEdit](kui_shell_plugin_client_common.InputProvider.md#cancelreedit) +- [componentDidCatch](kui_shell_plugin_client_common.InputProvider.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.InputProvider.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.InputProvider.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.InputProvider.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.InputProvider.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.InputProvider.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.InputProvider.md#componentwillupdate) +- [contextContent](kui_shell_plugin_client_common.InputProvider.md#contextcontent) +- [forceUpdate](kui_shell_plugin_client_common.InputProvider.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.InputProvider.md#getsnapshotbeforeupdate) +- [input](kui_shell_plugin_client_common.InputProvider.md#input) +- [isearchPrompt](kui_shell_plugin_client_common.InputProvider.md#isearchprompt) +- [normalPrompt](kui_shell_plugin_client_common.InputProvider.md#normalprompt) +- [prompt](kui_shell_plugin_client_common.InputProvider.md#prompt) +- [promptLeft](kui_shell_plugin_client_common.InputProvider.md#promptleft) +- [promptRight](kui_shell_plugin_client_common.InputProvider.md#promptright) +- [render](kui_shell_plugin_client_common.InputProvider.md#render) +- [setState](kui_shell_plugin_client_common.InputProvider.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.InputProvider.md#shouldcomponentupdate) +- [status](kui_shell_plugin_client_common.InputProvider.md#status) + +## Constructors + +### constructor + +• **new InputProvider**<`S`\>(`props`) + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `S` | extends [`InputProviderState`](../interfaces/kui_shell_plugin_client_common.InputProviderState.md)[`InputProviderState`](../interfaces/kui_shell_plugin_client_common.InputProviderState.md) | + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | [`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops) \| `Readonly`<[`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops)\> | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:475 + +• **new InputProvider**<`S`\>(`props`, `context`) + +**`deprecated`** + +**`see`** https://reactjs.org/docs/legacy-context.html + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `S` | extends [`InputProviderState`](../interfaces/kui_shell_plugin_client_common.InputProviderState.md)[`InputProviderState`](../interfaces/kui_shell_plugin_client_common.InputProviderState.md) | + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------------------------------------------------------------- | +| `props` | [`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops) | +| `context` | `any` | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:480 + +## Properties + +### \_cancelReEdit + +• `Private` `Readonly` **\_cancelReEdit**: `any` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:212](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L212) + +--- + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<[`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops)\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`S`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops)\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops)\> | +| `nextState` | `Readonly`<`S`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### cancelReEdit + +▸ `Protected` **cancelReEdit**(): `void` + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:204](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L204) + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :--------------------------------------------------------------------------------------------------- | +| `prevProps` | `Readonly`<[`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops)\> | +| `prevState` | `Readonly`<`S`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops)\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops)\> | +| `nextState` | `Readonly`<`S`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### contextContent + +▸ `Protected` **contextContent**(`insideBrackets?`): `ReactNode` + +#### Parameters + +| Name | Type | +| :--------------- | :---------- | +| `insideBrackets` | `ReactNode` | + +#### Returns + +`ReactNode` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:214](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L214) + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :--------------------------------------------------------------------------------------------------- | +| `prevProps` | `Readonly`<[`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops)\> | +| `prevState` | `Readonly`<`S`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### input + +▸ `Protected` `Abstract` **input**(): `any` + +this is what the InputProvider needs to provide, minimially + +#### Returns + +`any` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:198](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L198) + +--- + +### isearchPrompt + +▸ `Protected` **isearchPrompt**(): `Element` + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:277](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L277) + +--- + +### normalPrompt + +▸ `Protected` **normalPrompt**(): `Element` + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:281](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L281) + +--- + +### prompt + +▸ `Protected` **prompt**(): `Element` + +the "xxx >" prompt part of the input section + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:299](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L299) + +--- + +### promptLeft + +▸ `Protected` **promptLeft**(): `Element` + +the "xxx" part of "xxx >" of the prompt + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:236](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L236) + +--- + +### promptRight + +▸ `Protected` **promptRight**(): `Element` + +the ">" part of "xxx >" of the prompt + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:254](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L254) + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:312](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L312) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------- | +| `K` | extends `string` \| `number` \| `symbol` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `S` \| (`prevState`: `Readonly`<`S`\>, `props`: `Readonly`<[`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops)\>) => `S` \| `Pick`<`S`, `K`\> \| `Pick`<`S`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`InputProviderProps`](../modules/kui_shell_plugin_client_common.md#inputproviderprops)\> | +| `nextState` | `Readonly`<`S`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 + +--- + +### status + +▸ `Protected` **status**(): `void` + +rendered to the left of the input element + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:202](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L202) diff --git a/docs/api/classes/kui_shell_plugin_client_common.Kui.md b/docs/api/classes/kui_shell_plugin_client_common.Kui.md new file mode 100644 index 00000000000..37f32d246e4 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.Kui.md @@ -0,0 +1,851 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / Kui + +# Class: Kui + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).Kui + +Render the main body of our client. + +|Notes on Session Initialization|: to provide custom views for +session initialization (only relevant for browser-based hosted +Kui), you can instantiate with these properties (defined in +KuiConfiguration), show here with some sample views: + +Hold on...} +reinit={
Connection broken...
} +loadingError={err =>
{err.toString()}
} +loadingDone={
Welcome to Kui
} +/> + +## Hierarchy + +- `PureComponent`<[`KuiProps`](../modules/kui_shell_plugin_client_common.md#kuiprops), `State`\> + + ↳ **`Kui`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.Kui.md#constructor) + +### Properties + +- [\_onTabReady](kui_shell_plugin_client_common.Kui.md#_ontabready) +- [context](kui_shell_plugin_client_common.Kui.md#context) +- [firstTab](kui_shell_plugin_client_common.Kui.md#firsttab) +- [props](kui_shell_plugin_client_common.Kui.md#props) +- [refs](kui_shell_plugin_client_common.Kui.md#refs) +- [state](kui_shell_plugin_client_common.Kui.md#state) +- [contextType](kui_shell_plugin_client_common.Kui.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.Kui.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.Kui.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.Kui.md#unsafe_componentwillupdate) +- [componentDidCatch](kui_shell_plugin_client_common.Kui.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.Kui.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.Kui.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.Kui.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.Kui.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.Kui.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.Kui.md#componentwillupdate) +- [defaultFeatureFlag](kui_shell_plugin_client_common.Kui.md#defaultfeatureflag) +- [defaultLoading](kui_shell_plugin_client_common.Kui.md#defaultloading) +- [defaultLoadingDone](kui_shell_plugin_client_common.Kui.md#defaultloadingdone) +- [defaultLoadingError](kui_shell_plugin_client_common.Kui.md#defaultloadingerror) +- [defaultReinit](kui_shell_plugin_client_common.Kui.md#defaultreinit) +- [defaultSessionBehavior](kui_shell_plugin_client_common.Kui.md#defaultsessionbehavior) +- [forceUpdate](kui_shell_plugin_client_common.Kui.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.Kui.md#getsnapshotbeforeupdate) +- [onTabReady](kui_shell_plugin_client_common.Kui.md#ontabready) +- [onThemeChange](kui_shell_plugin_client_common.Kui.md#onthemechange) +- [render](kui_shell_plugin_client_common.Kui.md#render) +- [setState](kui_shell_plugin_client_common.Kui.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.Kui.md#shouldcomponentupdate) +- [statusStripeProps](kui_shell_plugin_client_common.Kui.md#statusstripeprops) + +## Constructors + +### constructor + +• **new Kui**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------ | +| `props` | [`KuiProps`](../modules/kui_shell_plugin_client_common.md#kuiprops) | + +#### Overrides + +React.PureComponent<Props, State\>.constructor + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:97](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L97) + +## Properties + +### \_onTabReady + +• `Private` `Readonly` **\_onTabReady**: `any` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:281](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L281) + +--- + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### firstTab + +• `Private` **firstTab**: `boolean` = `true` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:268](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L268) + +--- + +### props + +• `Readonly` **props**: `Readonly`<[`KuiProps`](../modules/kui_shell_plugin_client_common.md#kuiprops)\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`State`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`KuiProps`](../modules/kui_shell_plugin_client_common.md#kuiprops)\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`KuiProps`](../modules/kui_shell_plugin_client_common.md#kuiprops)\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### componentDidCatch + +▸ **componentDidCatch**(`error`, `errorInfo`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Overrides + +React.PureComponent.componentDidCatch + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:264](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L264) + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------------------------------- | +| `prevProps` | `Readonly`<[`KuiProps`](../modules/kui_shell_plugin_client_common.md#kuiprops)\> | +| `prevState` | `Readonly`<`State`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`KuiProps`](../modules/kui_shell_plugin_client_common.md#kuiprops)\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`KuiProps`](../modules/kui_shell_plugin_client_common.md#kuiprops)\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### defaultFeatureFlag + +▸ `Private` **defaultFeatureFlag**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :--------------- | :------- | +| `showWelcomeMax` | `number` | +| `sidecarName` | `string` | + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:172](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L172) + +--- + +### defaultLoading + +▸ `Private` **defaultLoading**(): `Element` + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:179](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L179) + +--- + +### defaultLoadingDone + +▸ `Private` **defaultLoadingDone**(): (`repl`: `default`) => `Element` + +#### Returns + +`fn` + +▸ (`repl`): `Element` + +##### Parameters + +| Name | Type | +| :----- | :-------- | +| `repl` | `default` | + +##### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:199](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L199) + +--- + +### defaultLoadingError + +▸ `Private` **defaultLoadingError**(): (`err`: `any`) => `Element` + +#### Returns + +`fn` + +▸ (`err`): `Element` + +##### Parameters + +| Name | Type | +| :---- | :---- | +| `err` | `any` | + +##### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:203](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L203) + +--- + +### defaultReinit + +▸ `Private` **defaultReinit**(): `Element` + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:185](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L185) + +--- + +### defaultSessionBehavior + +▸ `Private` **defaultSessionBehavior**(): `KuiConfiguration` + +For browser-based clients, this defines the default UI for +session initialization. + +#### Returns + +`KuiConfiguration` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:217](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L217) + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------------------------------- | +| `prevProps` | `Readonly`<[`KuiProps`](../modules/kui_shell_plugin_client_common.md#kuiprops)\> | +| `prevState` | `Readonly`<`State`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### onTabReady + +▸ `Private` **onTabReady**(): `void` + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:269](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L269) + +--- + +### onThemeChange + +▸ `Private` **onThemeChange**(`__namedParameters`): `void` + +#### Parameters + +| Name | Type | +| :----------------------------- | :------- | +| `__namedParameters` | `Object` | +| `__namedParameters.themeModel` | `Theme` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:231](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L231) + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:283](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L283) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `K` | extends keyof `ThemeProperties` \| keyof `InputProps` \| keyof `SessionProps` \| `"productName"` \| keyof `FeatureFlags` \| `"_for_testing_"` \| `"userOverrides"` \| `"isBootstrapped"` \| `"commandLine"` \| `"quietExecCommand"` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `State` \| (`prevState`: `Readonly`<`State`\>, `props`: `Readonly`<[`KuiProps`](../modules/kui_shell_plugin_client_common.md#kuiprops)\>) => `State` \| `Pick`<`State`, `K`\> \| `Pick`<`State`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`KuiProps`](../modules/kui_shell_plugin_client_common.md#kuiprops)\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 + +--- + +### statusStripeProps + +▸ `Private` **statusStripeProps**(): `Props` + +Props to pass to StatusStripe. This allows us to set the desired +status stripe color at startup time, rather than seeing the +default color, followed quickly by a change to the color desired +by the controller backing the given `props.commandLine`. The +controller may still want to specialize the status stripe +further, but at least we can avoid that odd +e.g. defaultColor-then-blue effect. + +#### Returns + +`Props` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:255](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L255) diff --git a/docs/api/classes/kui_shell_plugin_client_common.MeterWidgets.md b/docs/api/classes/kui_shell_plugin_client_common.MeterWidgets.md new file mode 100644 index 00000000000..6d1c8d02fe7 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.MeterWidgets.md @@ -0,0 +1,711 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / MeterWidgets + +# Class: MeterWidgets + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).MeterWidgets + +## Hierarchy + +- `PureComponent`<`Props`\> + + ↳ **`MeterWidgets`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.MeterWidgets.md#constructor) + +### Properties + +- [context](kui_shell_plugin_client_common.MeterWidgets.md#context) +- [props](kui_shell_plugin_client_common.MeterWidgets.md#props) +- [refs](kui_shell_plugin_client_common.MeterWidgets.md#refs) +- [state](kui_shell_plugin_client_common.MeterWidgets.md#state) +- [contextType](kui_shell_plugin_client_common.MeterWidgets.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.MeterWidgets.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.MeterWidgets.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.MeterWidgets.md#unsafe_componentwillupdate) +- [children](kui_shell_plugin_client_common.MeterWidgets.md#children) +- [className](kui_shell_plugin_client_common.MeterWidgets.md#classname) +- [componentDidCatch](kui_shell_plugin_client_common.MeterWidgets.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.MeterWidgets.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.MeterWidgets.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.MeterWidgets.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.MeterWidgets.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.MeterWidgets.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.MeterWidgets.md#componentwillupdate) +- [forceUpdate](kui_shell_plugin_client_common.MeterWidgets.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.MeterWidgets.md#getsnapshotbeforeupdate) +- [graft](kui_shell_plugin_client_common.MeterWidgets.md#graft) +- [render](kui_shell_plugin_client_common.MeterWidgets.md#render) +- [setState](kui_shell_plugin_client_common.MeterWidgets.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.MeterWidgets.md#shouldcomponentupdate) + +## Constructors + +### constructor + +• **new MeterWidgets**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------ | +| `props` | `Props` \| `Readonly`<`Props`\> | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:475 + +• **new MeterWidgets**(`props`, `context`) + +**`deprecated`** + +**`see`** https://reactjs.org/docs/legacy-context.html + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `props` | `Props` | +| `context` | `any` | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:480 + +## Properties + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### children + +▸ `Private` **children**(): `Object` + +Graft on the REPL focus management + +#### Returns + +`Object` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/MeterWidgets.tsx:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/MeterWidgets.tsx#L48) + +--- + +### className + +▸ `Private` **className**(): `string` + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/MeterWidgets.tsx:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/MeterWidgets.tsx#L31) + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :-------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`Object`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :-------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`Object`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### graft + +▸ `Private` **graft**(`node`, `key?`): `Object` + +#### Parameters + +| Name | Type | +| :----- | :---------- | +| `node` | `ReactNode` | +| `key?` | `number` | + +#### Returns + +`Object` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/MeterWidgets.tsx:35](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/MeterWidgets.tsx#L35) + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/MeterWidgets.tsx:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/MeterWidgets.tsx#L56) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------- | +| `K` | extends `never` | + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------------------------------------------------------------------------------------------- | +| `state` | {} \| (`prevState`: `Readonly`<`Object`\>, `props`: `Readonly`<`Props`\>) => {} \| `Pick`<`Object`, `K`\> \| `Pick`<`Object`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 diff --git a/docs/api/classes/kui_shell_plugin_client_common.Settings.md b/docs/api/classes/kui_shell_plugin_client_common.Settings.md new file mode 100644 index 00000000000..7728597162d --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.Settings.md @@ -0,0 +1,651 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / Settings + +# Class: Settings + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).Settings + +## Hierarchy + +- `PureComponent`<`Props`, `State`\> + + ↳ **`Settings`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.Settings.md#constructor) + +### Properties + +- [context](kui_shell_plugin_client_common.Settings.md#context) +- [props](kui_shell_plugin_client_common.Settings.md#props) +- [refs](kui_shell_plugin_client_common.Settings.md#refs) +- [state](kui_shell_plugin_client_common.Settings.md#state) +- [contextType](kui_shell_plugin_client_common.Settings.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.Settings.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.Settings.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.Settings.md#unsafe_componentwillupdate) +- [componentDidCatch](kui_shell_plugin_client_common.Settings.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.Settings.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.Settings.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.Settings.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.Settings.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.Settings.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.Settings.md#componentwillupdate) +- [forceUpdate](kui_shell_plugin_client_common.Settings.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.Settings.md#getsnapshotbeforeupdate) +- [recomputeThemeList](kui_shell_plugin_client_common.Settings.md#recomputethemelist) +- [render](kui_shell_plugin_client_common.Settings.md#render) +- [setState](kui_shell_plugin_client_common.Settings.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.Settings.md#shouldcomponentupdate) + +## Constructors + +### constructor + +• **new Settings**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Overrides + +React.PureComponent<Props, State\>.constructor + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/Settings.tsx:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/Settings.tsx#L40) + +## Properties + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`State`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### recomputeThemeList + +▸ `Private` **recomputeThemeList**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/Settings.tsx:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/Settings.tsx#L55) + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/Settings.tsx:73](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/Settings.tsx#L73) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------- | +| `K` | extends keyof `State` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `State` \| (`prevState`: `Readonly`<`State`\>, `props`: `Readonly`<`Props`\>) => `State` \| `Pick`<`State`, `K`\> \| `Pick`<`State`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 diff --git a/docs/api/classes/kui_shell_plugin_client_common.StatusStripe.md b/docs/api/classes/kui_shell_plugin_client_common.StatusStripe.md new file mode 100644 index 00000000000..ec037fb8e9c --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.StatusStripe.md @@ -0,0 +1,779 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / StatusStripe + +# Class: StatusStripe + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).StatusStripe + +## Hierarchy + +- `PureComponent`<`Props`, `State`\> + + ↳ **`StatusStripe`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.StatusStripe.md#constructor) + +### Properties + +- [context](kui_shell_plugin_client_common.StatusStripe.md#context) +- [helpRef](kui_shell_plugin_client_common.StatusStripe.md#helpref) +- [props](kui_shell_plugin_client_common.StatusStripe.md#props) +- [refs](kui_shell_plugin_client_common.StatusStripe.md#refs) +- [state](kui_shell_plugin_client_common.StatusStripe.md#state) +- [contextType](kui_shell_plugin_client_common.StatusStripe.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.StatusStripe.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.StatusStripe.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.StatusStripe.md#unsafe_componentwillupdate) +- [className](kui_shell_plugin_client_common.StatusStripe.md#classname) +- [componentDidCatch](kui_shell_plugin_client_common.StatusStripe.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.StatusStripe.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.StatusStripe.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.StatusStripe.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.StatusStripe.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.StatusStripe.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.StatusStripe.md#componentwillupdate) +- [doAbout](kui_shell_plugin_client_common.StatusStripe.md#doabout) +- [filler](kui_shell_plugin_client_common.StatusStripe.md#filler) +- [forceUpdate](kui_shell_plugin_client_common.StatusStripe.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.StatusStripe.md#getsnapshotbeforeupdate) +- [message](kui_shell_plugin_client_common.StatusStripe.md#message) +- [onChangeRequest](kui_shell_plugin_client_common.StatusStripe.md#onchangerequest) +- [render](kui_shell_plugin_client_common.StatusStripe.md#render) +- [setState](kui_shell_plugin_client_common.StatusStripe.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.StatusStripe.md#shouldcomponentupdate) +- [widgets](kui_shell_plugin_client_common.StatusStripe.md#widgets) +- [withStateDefaults](kui_shell_plugin_client_common.StatusStripe.md#withstatedefaults) + +## Constructors + +### constructor + +• **new StatusStripe**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Overrides + +React.PureComponent<Props, State\>.constructor + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx#L48) + +## Properties + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### helpRef + +• `Private` `Readonly` **helpRef**: `RefObject`<`HTMLAnchorElement`\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx#L46) + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`StatusStripeChangeEvent`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`StatusStripeChangeEvent`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### className + +▸ `Private` **className**(): `string` + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx:116](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx#L116) + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`StatusStripeChangeEvent`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`StatusStripeChangeEvent`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### doAbout + +▸ `Private` **doAbout**(): `Promise`<`void`\> + +User has clicked on the Settings icon. + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx:75](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx#L75) + +--- + +### filler + +▸ `Private` **filler**(): `Element` + +If the Client offers no status stripe widgets, we should insert a +filler, so that the Settings icon is presented flush-right. + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx:84](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx#L84) + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`StatusStripeChangeEvent`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### message + +▸ `Private` **message**(): `Element` + +Render the current State.message, if any + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx:92](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx#L92) + +--- + +### onChangeRequest + +▸ `Private` **onChangeRequest**(`evt`): `void` + +Status Stripe change request + +#### Parameters + +| Name | Type | +| :---- | :------------------------ | +| `evt` | `StatusStripeChangeEvent` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx:67](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx#L67) + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx:120](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx#L120) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------- | +| `K` | extends keyof `StatusStripeChangeEvent` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `StatusStripeChangeEvent` \| (`prevState`: `Readonly`<`StatusStripeChangeEvent`\>, `props`: `Readonly`<`Props`\>) => `StatusStripeChangeEvent` \| `Pick`<`StatusStripeChangeEvent`, `K`\> \| `Pick`<`StatusStripeChangeEvent`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`StatusStripeChangeEvent`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 + +--- + +### widgets + +▸ `Private` **widgets**(): `ReactNode` + +Render any widgets specified by the client. Note how we don't +show widgets if we were given a message. See +https://github.com/IBM/kui/issues/5490 + +#### Returns + +`ReactNode` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx:108](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx#L108) + +--- + +### withStateDefaults + +▸ `Private` **withStateDefaults**(`evt`): `Omit`<`Required`<`StatusStripeChangeEvent`\>, `"message"`\> + +Overlay default values for required state variables + +#### Parameters + +| Name | Type | +| :---- | :------------------------------------ | +| `evt` | `Partial`<`StatusStripeChangeEvent`\> | + +#### Returns + +`Omit`<`Required`<`StatusStripeChangeEvent`\>, `"message"`\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx#L56) diff --git a/docs/api/classes/kui_shell_plugin_client_common.StatusVisualizer.md b/docs/api/classes/kui_shell_plugin_client_common.StatusVisualizer.md new file mode 100644 index 00000000000..8f9599f2cd8 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.StatusVisualizer.md @@ -0,0 +1,687 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / StatusVisualizer + +# Class: StatusVisualizer + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).StatusVisualizer + +## Hierarchy + +- `PureComponent`<`Props`\> + + ↳ **`StatusVisualizer`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.StatusVisualizer.md#constructor) + +### Properties + +- [context](kui_shell_plugin_client_common.StatusVisualizer.md#context) +- [props](kui_shell_plugin_client_common.StatusVisualizer.md#props) +- [refs](kui_shell_plugin_client_common.StatusVisualizer.md#refs) +- [state](kui_shell_plugin_client_common.StatusVisualizer.md#state) +- [contextType](kui_shell_plugin_client_common.StatusVisualizer.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.StatusVisualizer.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.StatusVisualizer.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.StatusVisualizer.md#unsafe_componentwillupdate) +- [componentDidCatch](kui_shell_plugin_client_common.StatusVisualizer.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.StatusVisualizer.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.StatusVisualizer.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.StatusVisualizer.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.StatusVisualizer.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.StatusVisualizer.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.StatusVisualizer.md#componentwillupdate) +- [forceUpdate](kui_shell_plugin_client_common.StatusVisualizer.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.StatusVisualizer.md#getsnapshotbeforeupdate) +- [render](kui_shell_plugin_client_common.StatusVisualizer.md#render) +- [sections](kui_shell_plugin_client_common.StatusVisualizer.md#sections) +- [setState](kui_shell_plugin_client_common.StatusVisualizer.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.StatusVisualizer.md#shouldcomponentupdate) +- [title](kui_shell_plugin_client_common.StatusVisualizer.md#title) + +## Constructors + +### constructor + +• **new StatusVisualizer**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------ | +| `props` | `Props` \| `Readonly`<`Props`\> | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:475 + +• **new StatusVisualizer**(`props`, `context`) + +**`deprecated`** + +**`see`** https://reactjs.org/docs/legacy-context.html + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `props` | `Props` | +| `context` | `any` | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:480 + +## Properties + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :-------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`Object`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :-------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`Object`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Content/StatusVisualizer/index.tsx:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Content/StatusVisualizer/index.tsx#L58) + +--- + +### sections + +▸ `Private` **sections**(): `Element` + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Content/StatusVisualizer/index.tsx:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Content/StatusVisualizer/index.tsx#L31) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------- | +| `K` | extends `never` | + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------------------------------------------------------------------------------------------- | +| `state` | {} \| (`prevState`: `Readonly`<`Object`\>, `props`: `Readonly`<`Props`\>) => {} \| `Pick`<`Object`, `K`\> \| `Pick`<`Object`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :-------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 + +--- + +### title + +▸ `Private` **title**(): `void` + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Content/StatusVisualizer/index.tsx:53](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Content/StatusVisualizer/index.tsx#L53) diff --git a/docs/api/classes/kui_shell_plugin_client_common.TabContainer.md b/docs/api/classes/kui_shell_plugin_client_common.TabContainer.md new file mode 100644 index 00000000000..6b31cc3b919 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.TabContainer.md @@ -0,0 +1,987 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / TabContainer + +# Class: TabContainer + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).TabContainer + +## Hierarchy + +- `PureComponent`<`Props`, `State`\> + + ↳ **`TabContainer`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.TabContainer.md#constructor) + +### Properties + +- [\_onCloseTab](kui_shell_plugin_client_common.TabContainer.md#_onclosetab) +- [\_onSwitchTab](kui_shell_plugin_client_common.TabContainer.md#_onswitchtab) +- [\_onTabReady](kui_shell_plugin_client_common.TabContainer.md#_ontabready) +- [context](kui_shell_plugin_client_common.TabContainer.md#context) +- [isFirstTabReady](kui_shell_plugin_client_common.TabContainer.md#isfirsttabready) +- [props](kui_shell_plugin_client_common.TabContainer.md#props) +- [refs](kui_shell_plugin_client_common.TabContainer.md#refs) +- [state](kui_shell_plugin_client_common.TabContainer.md#state) +- [contextType](kui_shell_plugin_client_common.TabContainer.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.TabContainer.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.TabContainer.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.TabContainer.md#unsafe_componentwillupdate) +- [\_onNewTab](kui_shell_plugin_client_common.TabContainer.md#_onnewtab) +- [captureState](kui_shell_plugin_client_common.TabContainer.md#capturestate) +- [children](kui_shell_plugin_client_common.TabContainer.md#children) +- [componentDidCatch](kui_shell_plugin_client_common.TabContainer.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.TabContainer.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.TabContainer.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.TabContainer.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.TabContainer.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.TabContainer.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.TabContainer.md#componentwillupdate) +- [forceUpdate](kui_shell_plugin_client_common.TabContainer.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.TabContainer.md#getsnapshotbeforeupdate) +- [graft](kui_shell_plugin_client_common.TabContainer.md#graft) +- [listenForTabClose](kui_shell_plugin_client_common.TabContainer.md#listenfortabclose) +- [newTabModel](kui_shell_plugin_client_common.TabContainer.md#newtabmodel) +- [onCloseTab](kui_shell_plugin_client_common.TabContainer.md#onclosetab) +- [onNewTab](kui_shell_plugin_client_common.TabContainer.md#onnewtab) +- [onSwitchTab](kui_shell_plugin_client_common.TabContainer.md#onswitchtab) +- [onTabReady](kui_shell_plugin_client_common.TabContainer.md#ontabready) +- [render](kui_shell_plugin_client_common.TabContainer.md#render) +- [restoreState](kui_shell_plugin_client_common.TabContainer.md#restorestate) +- [setState](kui_shell_plugin_client_common.TabContainer.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.TabContainer.md#shouldcomponentupdate) +- [tabContent](kui_shell_plugin_client_common.TabContainer.md#tabcontent) +- [topTabStripe](kui_shell_plugin_client_common.TabContainer.md#toptabstripe) +- [willUpdateTopTabButtons](kui_shell_plugin_client_common.TabContainer.md#willupdatetoptabbuttons) + +## Constructors + +### constructor + +• **new TabContainer**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Overrides + +React.PureComponent<Props, State\>.constructor + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:57](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L57) + +## Properties + +### \_onCloseTab + +• `Private` `Readonly` **\_onCloseTab**: `any` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:162](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L162) + +--- + +### \_onSwitchTab + +• `Private` `Readonly` **\_onSwitchTab**: `any` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:142](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L142) + +--- + +### \_onTabReady + +• `Private` `Readonly` **\_onTabReady**: `any` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:295](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L295) + +--- + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### isFirstTabReady + +• `Private` **isFirstTabReady**: `boolean` = `false` + +Has the first tab activated itself? + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L55) + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`State`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### \_onNewTab + +▸ `Private` `Readonly` **\_onNewTab**(): `void` + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:222](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L222) + +--- + +### captureState + +▸ `Private` **captureState**(): `void` + +save tab state such as CWD prior to a tab switch + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:110](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L110) + +--- + +### children + +▸ `Private` **children**(`uuid`): `Object` + +Graft the tab `uuid` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `uuid` | `string` | + +#### Returns + +`Object` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:237](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L237) + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### graft + +▸ `Private` **graft**(`node`, `uuid`, `key?`): `Object` + +#### Parameters + +| Name | Type | +| :----- | :---------- | +| `node` | `ReactNode` | +| `uuid` | `string` | +| `key?` | `number` | + +#### Returns + +`Object` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:224](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L224) + +--- + +### listenForTabClose + +▸ `Private` **listenForTabClose**(`model`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `model` | [`TabModel`](kui_shell_plugin_client_common.TabModel.md) | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:164](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L164) + +--- + +### newTabModel + +▸ `Private` **newTabModel**(`spec?`, `doNotChangeActiveTab?`): [`TabModel`](kui_shell_plugin_client_common.TabModel.md) + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------------------- | :------------------------ | :------------ | :----------------------------------------------------------------------- | +| `spec` | `Object` | `{}` | - | +| `spec.cmdline?` | `string` | `undefined` | Optionally execute a command in the new tab | +| `spec.exec?` | `"pexec"` \| `"qexec"` | `undefined` | Execute the command line with qexec or pexec? Default: pexec. | +| `spec.onClose?` | `string` | `undefined` | Optionally execute a command when the tab is closed | +| `spec.replaceCurrentTab?` | `boolean` | `undefined` | Replace the contents of the current tab with that of the given snapshot? | +| `spec.snapshot?` | `Buffer` | `undefined` | Optionally open a snapshot file in the new tab | +| `spec.statusStripeDecoration?` | `StatusStripeChangeEvent` | `undefined` | Optionally specify color and message to display in the StatusStripe | +| `spec.title?` | `string` | `undefined` | Optional tab title | +| `doNotChangeActiveTab` | `boolean` | `false` | - | + +#### Returns + +[`TabModel`](kui_shell_plugin_client_common.TabModel.md) + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:175](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L175) + +--- + +### onCloseTab + +▸ `Private` **onCloseTab**(`idx`): `Promise`<`void`\> + +Close Tab event + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `idx` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:148](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L148) + +--- + +### onNewTab + +▸ `Private` **onNewTab**(`spec?`, `doNotChangeActiveTab?`): `void` + +New Tab event + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------------------- | :------------------------ | :------------ | :----------------------------------------------------------------------- | +| `spec` | `Object` | `{}` | - | +| `spec.cmdline?` | `string` | `undefined` | Optionally execute a command in the new tab | +| `spec.exec?` | `"pexec"` \| `"qexec"` | `undefined` | Execute the command line with qexec or pexec? Default: pexec. | +| `spec.onClose?` | `string` | `undefined` | Optionally execute a command when the tab is closed | +| `spec.replaceCurrentTab?` | `boolean` | `undefined` | Replace the contents of the current tab with that of the given snapshot? | +| `spec.snapshot?` | `Buffer` | `undefined` | Optionally open a snapshot file in the new tab | +| `spec.statusStripeDecoration?` | `StatusStripeChangeEvent` | `undefined` | Optionally specify color and message to display in the StatusStripe | +| `spec.title?` | `string` | `undefined` | Optional tab title | +| `doNotChangeActiveTab` | `boolean` | `false` | - | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:199](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L199) + +--- + +### onSwitchTab + +▸ `Private` **onSwitchTab**(`idx`): `Promise`<`void`\> + +Switch Tab event: update state so that activeIdx=idx + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `idx` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:127](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L127) + +--- + +### onTabReady + +▸ `Private` **onTabReady**(`tab`): `void` + +#### Parameters + +| Name | Type | +| :---- | :---- | +| `tab` | `Tab` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:259](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L259) + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:333](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L333) + +--- + +### restoreState + +▸ `Private` **restoreState**(`tabIdx`): `void` + +restore tab state after a tab switch + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `tabIdx` | `number` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:119](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L119) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------- | +| `K` | extends keyof `State` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `State` \| (`prevState`: `Readonly`<`State`\>, `props`: `Readonly`<`Props`\>) => `State` \| `Pick`<`State`, `K`\> \| `Pick`<`State`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 + +--- + +### tabContent + +▸ `Private` **tabContent**(): `Element` + +Render the content of the tabs + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:312](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L312) + +--- + +### topTabStripe + +▸ `Private` **topTabStripe**(): `Element` + +Render the row of Tabs along the top + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:298](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L298) + +--- + +### willUpdateTopTabButtons + +▸ `Private` **willUpdateTopTabButtons**(`uuid`, `buttons`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------- | +| `uuid` | `string` | +| `buttons` | `TopTabButton`<`Object`\>[] | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContainer.tsx:245](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContainer.tsx#L245) diff --git a/docs/api/classes/kui_shell_plugin_client_common.TabContent.md b/docs/api/classes/kui_shell_plugin_client_common.TabContent.md new file mode 100644 index 00000000000..dbfb406c6e4 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.TabContent.md @@ -0,0 +1,1024 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / TabContent + +# Class: TabContent + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).TabContent + +TabContent +---------------- from here down +| ST | | +| | | +| | | +| | | +| | | +| | | + +--- + +ST: + +## Hierarchy + +- `PureComponent`<`Props`, `State`\> + + ↳ **`TabContent`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.TabContent.md#constructor) + +### Properties + +- [\_firstRenderDone](kui_shell_plugin_client_common.TabContent.md#_firstrenderdone) +- [activateHandlers](kui_shell_plugin_client_common.TabContent.md#activatehandlers) +- [cleaners](kui_shell_plugin_client_common.TabContent.md#cleaners) +- [context](kui_shell_plugin_client_common.TabContent.md#context) +- [props](kui_shell_plugin_client_common.TabContent.md#props) +- [refs](kui_shell_plugin_client_common.TabContent.md#refs) +- [state](kui_shell_plugin_client_common.TabContent.md#state) +- [contextType](kui_shell_plugin_client_common.TabContent.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.TabContent.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.TabContent.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.TabContent.md#unsafe_componentwillupdate) +- [\_onClear](kui_shell_plugin_client_common.TabContent.md#_onclear) +- [\_toggleAttribute](kui_shell_plugin_client_common.TabContent.md#_toggleattribute) +- [\_toggleBottomStripMode](kui_shell_plugin_client_common.TabContent.md#_togglebottomstripmode) +- [\_toggleLeftStripMode](kui_shell_plugin_client_common.TabContent.md#_toggleleftstripmode) +- [body](kui_shell_plugin_client_common.TabContent.md#body) +- [bottom](kui_shell_plugin_client_common.TabContent.md#bottom) +- [children](kui_shell_plugin_client_common.TabContent.md#children) +- [componentDidCatch](kui_shell_plugin_client_common.TabContent.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.TabContent.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.TabContent.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.TabContent.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.TabContent.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.TabContent.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.TabContent.md#componentwillupdate) +- [defaultLoading](kui_shell_plugin_client_common.TabContent.md#defaultloading) +- [forceUpdate](kui_shell_plugin_client_common.TabContent.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.TabContent.md#getsnapshotbeforeupdate) +- [graft](kui_shell_plugin_client_common.TabContent.md#graft) +- [initTab](kui_shell_plugin_client_common.TabContent.md#inittab) +- [onOffline](kui_shell_plugin_client_common.TabContent.md#onoffline) +- [oneTimeInit](kui_shell_plugin_client_common.TabContent.md#onetimeinit) +- [proxyDisconnectNotice](kui_shell_plugin_client_common.TabContent.md#proxydisconnectnotice) +- [render](kui_shell_plugin_client_common.TabContent.md#render) +- [setState](kui_shell_plugin_client_common.TabContent.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.TabContent.md#shouldcomponentupdate) +- [tabClassName](kui_shell_plugin_client_common.TabContent.md#tabclassname) +- [terminal](kui_shell_plugin_client_common.TabContent.md#terminal) +- [toggleEditMode](kui_shell_plugin_client_common.TabContent.md#toggleeditmode) +- [delayedFocus](kui_shell_plugin_client_common.TabContent.md#delayedfocus) +- [getDerivedStateFromProps](kui_shell_plugin_client_common.TabContent.md#getderivedstatefromprops) +- [onSessionInitError](kui_shell_plugin_client_common.TabContent.md#onsessioniniterror) + +## Constructors + +### constructor + +• **new TabContent**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Overrides + +React.PureComponent<Props, State\>.constructor + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:99](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L99) + +## Properties + +### \_firstRenderDone + +• `Private` **\_firstRenderDone**: `boolean` = `false` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:86](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L86) + +--- + +### activateHandlers + +• `Private` **activateHandlers**: (`isActive`: `boolean`) => `void`[] = `[]` + +switching back or away from this tab + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:91](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L91) + +--- + +### cleaners + +• `Private` `Readonly` **cleaners**: `Cleaner`[] = `[]` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:88](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L88) + +--- + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`State`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### \_onClear + +▸ `Private` `Readonly` **\_onClear**(): `void` + +Request to clear the contents of the ScrollableTerminal + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:283](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L283) + +--- + +### \_toggleAttribute + +▸ `Private` `Readonly` **\_toggleAttribute**(`attr`): `void` + +Toggle attribute on Tab DOM + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `attr` | `string` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:276](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L276) + +--- + +### \_toggleBottomStripMode + +▸ `Private` `Readonly` **\_toggleBottomStripMode**(): `void` + +Enter/exit mode where one split is displayed along the bottom + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:272](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L272) + +--- + +### \_toggleLeftStripMode + +▸ `Private` `Readonly` **\_toggleLeftStripMode**(): `void` + +Enter/exit mode where one split is displayed along the left + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:269](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L269) + +--- + +### body + +▸ `Private` **body**(): `Element` + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:382](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L382) + +--- + +### bottom + +▸ `Private` **bottom**(): `ReactElement`<`WithTabUUID` & `WithTab`<`Tab`\>, `string` \| `JSXElementConstructor`<`any`\>\> + +Graft on the tab uuid + +#### Returns + +`ReactElement`<`WithTabUUID` & `WithTab`<`Tab`\>, `string` \| `JSXElementConstructor`<`any`\>\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:361](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L361) + +--- + +### children + +▸ `Private` **children**(): `Object` + +Graft on the REPL focus management + +#### Returns + +`Object` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:352](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L352) + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ **componentDidMount**(): `void` + +#### Returns + +`void` + +#### Overrides + +React.PureComponent.componentDidMount + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:137](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L137) + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ **componentWillUnmount**(): `void` + +#### Returns + +`void` + +#### Overrides + +React.PureComponent.componentWillUnmount + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:258](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L258) + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### defaultLoading + +▸ `Private` **defaultLoading**(): `string` + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:263](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L263) + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### graft + +▸ `Private` **graft**(`node`, `key?`): `Object` + +#### Parameters + +| Name | Type | +| :----- | :---------- | +| `node` | `ReactNode` | +| `key?` | `number` | + +#### Returns + +`Object` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:338](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L338) + +--- + +### initTab + +▸ `Private` **initTab**(`tab`): `void` + +#### Parameters + +| Name | Type | +| :---- | :---- | +| `tab` | `Tab` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:215](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L215) + +--- + +### onOffline + +▸ `Private` **onOffline**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:170](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L170) + +--- + +### oneTimeInit + +▸ `Private` **oneTimeInit**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------------ | :------- | +| `sessionInit` | `string` | + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:188](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L188) + +--- + +### proxyDisconnectNotice + +▸ `Private` **proxyDisconnectNotice**(): `Element` + +Use client-provided (or default) proxy disconnected notice, if warranted + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:320](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L320) + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:407](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L407) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `K` | extends `"active"` \| keyof `WithTab`<`RefObject`<`Tab`\>\> \| `"sessionInit"` \| `"sessionInitError"` \| `"showSessionInitDone"` \| `"hasLeftStrip"` \| `"hasBottomStrip"` \| `"_terminal"` \| `"mutability"` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `State` \| (`prevState`: `Readonly`<`State`\>, `props`: `Readonly`<`Props`\>) => `State` \| `Pick`<`State`, `K`\> \| `Pick`<`State`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 + +--- + +### tabClassName + +▸ `Private` **tabClassName**(): `string` + +Construct the `className` property of the tab element + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:374](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L374) + +--- + +### terminal + +▸ `Private` **terminal**(): `Element` + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:292](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L292) + +--- + +### toggleEditMode + +▸ `Private` `Readonly` **toggleEditMode**(): `void` + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:93](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L93) + +--- + +### delayedFocus + +▸ `Static` **delayedFocus**(`state`, `delayMillis?`): `void` + +#### Parameters + +| Name | Type | Default value | +| :------------ | :------- | :------------ | +| `state` | `State` | `undefined` | +| `delayMillis` | `number` | `300` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:127](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L127) + +--- + +### getDerivedStateFromProps + +▸ `Static` **getDerivedStateFromProps**(`props`, `state`): `State` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | +| `state` | `State` | + +#### Returns + +`State` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:114](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L114) + +--- + +### onSessionInitError + +▸ `Static` `Private` **onSessionInitError**(`uuid`, `sessionInitError`): `void` + +#### Parameters + +| Name | Type | +| :----------------- | :------- | +| `uuid` | `string` | +| `sessionInitError` | `Error` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabContent.tsx:184](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabContent.tsx#L184) diff --git a/docs/api/classes/kui_shell_plugin_client_common.TabModel.md b/docs/api/classes/kui_shell_plugin_client_common.TabModel.md new file mode 100644 index 00000000000..8824505aa9a --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.TabModel.md @@ -0,0 +1,198 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / TabModel + +# Class: TabModel + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).TabModel + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.TabModel.md#constructor) + +### Accessors + +- [buttons](kui_shell_plugin_client_common.TabModel.md#buttons) +- [exec](kui_shell_plugin_client_common.TabModel.md#exec) +- [initialCommandLine](kui_shell_plugin_client_common.TabModel.md#initialcommandline) +- [isNotebook](kui_shell_plugin_client_common.TabModel.md#isnotebook) +- [onClose](kui_shell_plugin_client_common.TabModel.md#onclose) +- [snapshot](kui_shell_plugin_client_common.TabModel.md#snapshot) +- [state](kui_shell_plugin_client_common.TabModel.md#state) +- [title](kui_shell_plugin_client_common.TabModel.md#title) +- [uuid](kui_shell_plugin_client_common.TabModel.md#uuid) + +### Methods + +- [update](kui_shell_plugin_client_common.TabModel.md#update) + +## Constructors + +### constructor + +• **new TabModel**(`_uuid?`, `desiredStatusStripeDecoration?`, `doNotChangeActiveTab?`, `_title?`, `_state?`, `_buttons?`, `_initialCommandLine?`, `_onClose?`, `_exec?`, `_snapshot?`) + +#### Parameters + +| Name | Type | Default value | +| :------------------------------- | :-------------------------- | :------------ | +| `_uuid` | `string` | `undefined` | +| `desiredStatusStripeDecoration?` | `StatusStripeChangeEvent` | `undefined` | +| `doNotChangeActiveTab?` | `boolean` | `undefined` | +| `_title?` | `string` | `undefined` | +| `_state` | `default` | `undefined` | +| `_buttons` | `TopTabButton`<`Object`\>[] | `[]` | +| `_initialCommandLine?` | `string` | `undefined` | +| `_onClose?` | `string` | `undefined` | +| `_exec?` | `"pexec"` \| `"qexec"` | `undefined` | +| `_snapshot?` | `Buffer` | `undefined` | + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L30) + +## Accessors + +### buttons + +• `get` **buttons**(): `TopTabButton`<`Object`\>[] + +#### Returns + +`TopTabButton`<`Object`\>[] + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L58) + +--- + +### exec + +• `get` **exec**(): `"pexec"` \| `"qexec"` + +#### Returns + +`"pexec"` \| `"qexec"` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:74](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L74) + +--- + +### initialCommandLine + +• `get` **initialCommandLine**(): `string` + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:66](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L66) + +--- + +### isNotebook + +• `get` **isNotebook**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:82](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L82) + +--- + +### onClose + +• `get` **onClose**(): `string` + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L70) + +--- + +### snapshot + +• `get` **snapshot**(): `Buffer` + +#### Returns + +`Buffer` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:78](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L78) + +--- + +### state + +• `get` **state**(): `default` + +#### Returns + +`default` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:54](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L54) + +--- + +### title + +• `get` **title**(): `string` + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:62](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L62) + +--- + +### uuid + +• `get` **uuid**(): `string` + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:50](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L50) + +## Methods + +### update + +▸ **update**(`buttons`): [`TabModel`](kui_shell_plugin_client_common.TabModel.md) + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------- | +| `buttons` | `TopTabButton`<`Object`\>[] | + +#### Returns + +[`TabModel`](kui_shell_plugin_client_common.TabModel.md) + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:86](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L86) diff --git a/docs/api/classes/kui_shell_plugin_client_common.TextWithIconWidget.md b/docs/api/classes/kui_shell_plugin_client_common.TextWithIconWidget.md new file mode 100644 index 00000000000..89a6fc5301c --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_client_common.TextWithIconWidget.md @@ -0,0 +1,693 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / TextWithIconWidget + +# Class: TextWithIconWidget + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).TextWithIconWidget + +## Hierarchy + +- `PureComponent`<[`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md)\> + + ↳ **`TextWithIconWidget`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_client_common.TextWithIconWidget.md#constructor) + +### Properties + +- [\_onClick](kui_shell_plugin_client_common.TextWithIconWidget.md#_onclick) +- [context](kui_shell_plugin_client_common.TextWithIconWidget.md#context) +- [props](kui_shell_plugin_client_common.TextWithIconWidget.md#props) +- [refs](kui_shell_plugin_client_common.TextWithIconWidget.md#refs) +- [state](kui_shell_plugin_client_common.TextWithIconWidget.md#state) +- [contextType](kui_shell_plugin_client_common.TextWithIconWidget.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_client_common.TextWithIconWidget.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_client_common.TextWithIconWidget.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_client_common.TextWithIconWidget.md#unsafe_componentwillupdate) +- [componentDidCatch](kui_shell_plugin_client_common.TextWithIconWidget.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_client_common.TextWithIconWidget.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_client_common.TextWithIconWidget.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_client_common.TextWithIconWidget.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_client_common.TextWithIconWidget.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_client_common.TextWithIconWidget.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_client_common.TextWithIconWidget.md#componentwillupdate) +- [content](kui_shell_plugin_client_common.TextWithIconWidget.md#content) +- [forceUpdate](kui_shell_plugin_client_common.TextWithIconWidget.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_client_common.TextWithIconWidget.md#getsnapshotbeforeupdate) +- [render](kui_shell_plugin_client_common.TextWithIconWidget.md#render) +- [setState](kui_shell_plugin_client_common.TextWithIconWidget.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_client_common.TextWithIconWidget.md#shouldcomponentupdate) + +## Constructors + +### constructor + +• **new TextWithIconWidget**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `props` | [`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md) \| `Readonly`<[`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md)\> | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:475 + +• **new TextWithIconWidget**(`props`, `context`) + +**`deprecated`** + +**`see`** https://reactjs.org/docs/legacy-context.html + +#### Parameters + +| Name | Type | +| :-------- | :--------------------------------------------------------------------------------------------------- | +| `props` | [`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md) | +| `context` | `any` | + +#### Inherited from + +React.PureComponent.constructor + +#### Defined in + +node_modules/@types/react/index.d.ts:480 + +## Properties + +### \_onClick + +• `Private` `Readonly` **\_onClick**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:97](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L97) + +--- + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<[`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md)\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md)\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md)\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------------------------------------------------------------------------- | +| `prevProps` | `Readonly`<[`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md)\> | +| `prevState` | `Readonly`<`Object`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md)\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md)\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### content + +▸ `Private` **content**(): `Element` + +Render the content (excluding any popover/tooltip wrappers) part + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L51) + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------------------------------------------------------------------------- | +| `prevProps` | `Readonly`<[`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md)\> | +| `prevState` | `Readonly`<`Object`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:107](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L107) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------- | +| `K` | extends `never` | + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | {} \| (`prevState`: `Readonly`<`Object`\>, `props`: `Readonly`<[`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md)\>) => {} \| `Pick`<`Object`, `K`\> \| `Pick`<`Object`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------------------------------------------------------------------------- | +| `nextProps` | `Readonly`<[`TextWithIconWidgetProps`](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md)\> | +| `nextState` | `Readonly`<`Object`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 diff --git a/docs/api/classes/kui_shell_plugin_core_support.NotebookVFS.md b/docs/api/classes/kui_shell_plugin_core_support.NotebookVFS.md new file mode 100644 index 00000000000..923dd5780e6 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_core_support.NotebookVFS.md @@ -0,0 +1,448 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-core-support](../modules/kui_shell_plugin_core_support.md) / NotebookVFS + +# Class: NotebookVFS + +[@kui-shell/plugin-core-support](../modules/kui_shell_plugin_core_support.md).NotebookVFS + +## Implements + +- `VFS` + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_core_support.NotebookVFS.md#constructor) + +### Properties + +- [isLocal](kui_shell_plugin_core_support.NotebookVFS.md#islocal) +- [isVirtual](kui_shell_plugin_core_support.NotebookVFS.md#isvirtual) +- [mountPath](kui_shell_plugin_core_support.NotebookVFS.md#mountpath) +- [prefix](kui_shell_plugin_core_support.NotebookVFS.md#prefix) +- [trie](kui_shell_plugin_core_support.NotebookVFS.md#trie) + +### Methods + +- [cp](kui_shell_plugin_core_support.NotebookVFS.md#cp) +- [dirPattern](kui_shell_plugin_core_support.NotebookVFS.md#dirpattern) +- [enumerate](kui_shell_plugin_core_support.NotebookVFS.md#enumerate) +- [find](kui_shell_plugin_core_support.NotebookVFS.md#find) +- [findExact](kui_shell_plugin_core_support.NotebookVFS.md#findexact) +- [fslice](kui_shell_plugin_core_support.NotebookVFS.md#fslice) +- [fstat](kui_shell_plugin_core_support.NotebookVFS.md#fstat) +- [fwrite](kui_shell_plugin_core_support.NotebookVFS.md#fwrite) +- [glob2RegExp](kui_shell_plugin_core_support.NotebookVFS.md#glob2regexp) +- [load](kui_shell_plugin_core_support.NotebookVFS.md#load) +- [ls](kui_shell_plugin_core_support.NotebookVFS.md#ls) +- [mkdir](kui_shell_plugin_core_support.NotebookVFS.md#mkdir) +- [rm](kui_shell_plugin_core_support.NotebookVFS.md#rm) +- [rmdir](kui_shell_plugin_core_support.NotebookVFS.md#rmdir) + +## Constructors + +### constructor + +• **new NotebookVFS**(`mountPath?`) + +#### Parameters + +| Name | Type | Default value | +| :---------- | :------- | :------------ | +| `mountPath` | `string` | `'/kui'` | + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:62](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L62) + +## Properties + +### isLocal + +• `Readonly` **isLocal**: `false` + +#### Implementation of + +VFS.isLocal + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:54](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L54) + +--- + +### isVirtual + +• `Readonly` **isVirtual**: `true` + +#### Implementation of + +VFS.isVirtual + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L55) + +--- + +### mountPath + +• `Readonly` **mountPath**: `string` = `'/kui'` + +#### Implementation of + +VFS.mountPath + +--- + +### prefix + +• `Protected` `Readonly` **prefix**: `RegExp` + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:57](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L57) + +--- + +### trie + +• `Private` `Readonly` **trie**: `any` + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:59](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L59) + +## Methods + +### cp + +▸ **cp**(`_`, `srcFilepaths`, `dstFilepath`): `Promise`<`string`\> + +Insert filepath into directory + +#### Parameters + +| Name | Type | +| :------------- | :--------- | +| `_` | `any` | +| `srcFilepaths` | `string`[] | +| `dstFilepath` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Implementation of + +VFS.cp + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:228](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L228) + +--- + +### dirPattern + +▸ `Private` **dirPattern**(`filepath`): `RegExp` + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `filepath` | `string` | + +#### Returns + +`RegExp` + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:69](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L69) + +--- + +### enumerate + +▸ `Private` **enumerate**(`__namedParameters`): `Promise`<{ `dirent`: { `isDirectory`: `boolean` = isDir; `isExecutable`: `boolean` = false; `isFile`: `boolean` = !isDir; `isSpecial`: `boolean` = false; `isSymbolicLink`: `boolean` = false; `mount`: { `isLocal`: `boolean` ; `mountPath`: `string` } ; `permissions`: `string` = ''; `username`: `string` } ; `name`: `string` ; `nameForDisplay`: `string` ; `path`: `string` = mount.mountPath; `stats`: { `gid`: `number` ; `mode`: `number` = 0; `mtimeMs`: `number` = 0; `size`: `number` = 0; `uid`: `number` } }[]\> + +#### Parameters + +| Name | Type | +| :-------------------------- | :-------- | +| `__namedParameters` | `Object` | +| `__namedParameters.entries` | `Entry`[] | + +#### Returns + +`Promise`<{ `dirent`: { `isDirectory`: `boolean` = isDir; `isExecutable`: `boolean` = false; `isFile`: `boolean` = !isDir; `isSpecial`: `boolean` = false; `isSymbolicLink`: `boolean` = false; `mount`: { `isLocal`: `boolean` ; `mountPath`: `string` } ; `permissions`: `string` = ''; `username`: `string` } ; `name`: `string` ; `nameForDisplay`: `string` ; `path`: `string` = mount.mountPath; `stats`: { `gid`: `number` ; `mode`: `number` = 0; `mtimeMs`: `number` = 0; `size`: `number` = 0; `uid`: `number` } }[]\> + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:139](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L139) + +--- + +### find + +▸ `Private` **find**(`filepath`, `dashD?`, `exact?`): `Entry`[] + +Looks in the trie for any matches for the given filepath, handling the "contents of directory" case + +#### Parameters + +| Name | Type | Default value | +| :--------- | :-------- | :------------ | +| `filepath` | `string` | `undefined` | +| `dashD` | `boolean` | `false` | +| `exact` | `boolean` | `false` | + +#### Returns + +`Entry`[] + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:79](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L79) + +--- + +### findExact + +▸ `Private` **findExact**(`filepath`, `withData`): `Promise`<`FStat`\> + +Looks in the trie for a single precise match + +#### Parameters + +| Name | Type | +| :--------- | :-------- | +| `filepath` | `string` | +| `withData` | `boolean` | + +#### Returns + +`Promise`<`FStat`\> + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:96](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L96) + +--- + +### fslice + +▸ **fslice**(`filename`, `offset`, `length`): `Promise`<`string`\> + +Fetch content slice + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `filename` | `string` | +| `offset` | `number` | +| `length` | `number` | + +#### Returns + +`Promise`<`string`\> + +#### Implementation of + +VFS.fslice + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:284](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L284) + +--- + +### fstat + +▸ **fstat**(`opts`, `filepath`, `withData`, `enoentOk`): `Promise`<`FStat`\> + +Fetch contents + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `opts` | `Pick`<`EvaluatorArgs`<`ParsedOptions`\>, `"REPL"` \| `"parsedOptions"`\> | +| `filepath` | `string` | +| `withData` | `boolean` | +| `enoentOk` | `boolean` | + +#### Returns + +`Promise`<`FStat`\> + +#### Implementation of + +VFS.fstat + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:259](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L259) + +--- + +### fwrite + +▸ **fwrite**(`opts`, `filepath`, `data`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------------------------------- | +| `opts` | `Pick`<`EvaluatorArgs`<`ParsedOptions`\>, `"REPL"`\> | +| `filepath` | `string` | +| `data` | `string` \| `Buffer` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +VFS.fwrite + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:279](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L279) + +--- + +### glob2RegExp + +▸ `Private` **glob2RegExp**(`filepath`): `string` + +Turn an ls-style glob into a nodejs-style regexp + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `filepath` | `string` | + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:65](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L65) + +--- + +### load + +▸ `Private` **load**(`data`): `Promise`<`Notebook`\> + +Load Notebook data from bundles + +#### Parameters + +| Name | Type | +| :----- | :---------------------------------------- | +| `data` | `Notebook` \| { `srcFilepath`: `string` } | + +#### Returns + +`Promise`<`Notebook`\> + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:185](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L185) + +--- + +### ls + +▸ **ls**(`__namedParameters`, `filepaths`): `Promise`<{ `dirent`: { `isDirectory`: `boolean` = isDir; `isExecutable`: `boolean` = false; `isFile`: `boolean` = !isDir; `isSpecial`: `boolean` = false; `isSymbolicLink`: `boolean` = false; `mount`: { `isLocal`: `boolean` ; `mountPath`: `string` } ; `permissions`: `string` = ''; `username`: `string` } ; `name`: `string` ; `nameForDisplay`: `string` ; `path`: `string` = mount.mountPath; `stats`: { `gid`: `number` ; `mode`: `number` = 0; `mtimeMs`: `number` = 0; `size`: `number` = 0; `uid`: `number` } }[]\> + +#### Parameters + +| Name | Type | +| :------------------ | :------------------------------------------------------------------------------------ | +| `__namedParameters` | `Pick`<`EvaluatorArgs`<`KuiGlobOptions`\>, `"tab"` \| `"REPL"` \| `"parsedOptions"`\> | +| `filepaths` | `string`[] | + +#### Returns + +`Promise`<{ `dirent`: { `isDirectory`: `boolean` = isDir; `isExecutable`: `boolean` = false; `isFile`: `boolean` = !isDir; `isSpecial`: `boolean` = false; `isSymbolicLink`: `boolean` = false; `mount`: { `isLocal`: `boolean` ; `mountPath`: `string` } ; `permissions`: `string` = ''; `username`: `string` } ; `name`: `string` ; `nameForDisplay`: `string` ; `path`: `string` = mount.mountPath; `stats`: { `gid`: `number` ; `mode`: `number` = 0; `mtimeMs`: `number` = 0; `size`: `number` = 0; `uid`: `number` } }[]\> + +#### Implementation of + +VFS.ls + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:173](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L173) + +--- + +### mkdir + +▸ **mkdir**(`opts`): `Promise`<`void`\> + +Create a directory/bucket + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------ | +| `opts` | `Pick`<`EvaluatorArgs`<`ParsedOptions`\>, `"argvNoOptions"`\> | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +VFS.mkdir + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:300](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L300) + +--- + +### rm + +▸ **rm**(): `Promise`<`string` \| `boolean`\> + +Remove filepath + +#### Returns + +`Promise`<`string` \| `boolean`\> + +#### Implementation of + +VFS.rm + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:254](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L254) + +--- + +### rmdir + +▸ **rmdir**(): `Promise`<`void`\> + +Remove a directory/bucket + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +VFS.rmdir + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:306](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L306) diff --git a/docs/api/classes/kui_shell_plugin_electron_components.Screenshot.md b/docs/api/classes/kui_shell_plugin_electron_components.Screenshot.md new file mode 100644 index 00000000000..447e463fd7a --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_electron_components.Screenshot.md @@ -0,0 +1,839 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-electron-components](../modules/kui_shell_plugin_electron_components.md) / Screenshot + +# Class: Screenshot + +[@kui-shell/plugin-electron-components](../modules/kui_shell_plugin_electron_components.md).Screenshot + +## Hierarchy + +- `PureComponent`<`Props`, `State`\> + + ↳ **`Screenshot`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_electron_components.Screenshot.md#constructor) + +### Properties + +- [\_onClose](kui_shell_plugin_electron_components.Screenshot.md#_onclose) +- [cleaners](kui_shell_plugin_electron_components.Screenshot.md#cleaners) +- [context](kui_shell_plugin_electron_components.Screenshot.md#context) +- [overlayCleaner](kui_shell_plugin_electron_components.Screenshot.md#overlaycleaner) +- [props](kui_shell_plugin_electron_components.Screenshot.md#props) +- [refs](kui_shell_plugin_electron_components.Screenshot.md#refs) +- [renderOverlayTransparent](kui_shell_plugin_electron_components.Screenshot.md#renderoverlaytransparent) +- [state](kui_shell_plugin_electron_components.Screenshot.md#state) +- [toggleOverlayTransparency](kui_shell_plugin_electron_components.Screenshot.md#toggleoverlaytransparency) +- [contextType](kui_shell_plugin_electron_components.Screenshot.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_electron_components.Screenshot.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_electron_components.Screenshot.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_electron_components.Screenshot.md#unsafe_componentwillupdate) +- [captureRegion](kui_shell_plugin_electron_components.Screenshot.md#captureregion) +- [closeNotification](kui_shell_plugin_electron_components.Screenshot.md#closenotification) +- [componentDidCatch](kui_shell_plugin_electron_components.Screenshot.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_electron_components.Screenshot.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_electron_components.Screenshot.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_electron_components.Screenshot.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_electron_components.Screenshot.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_electron_components.Screenshot.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_electron_components.Screenshot.md#componentwillupdate) +- [deactivate](kui_shell_plugin_electron_components.Screenshot.md#deactivate) +- [forceUpdate](kui_shell_plugin_electron_components.Screenshot.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_electron_components.Screenshot.md#getsnapshotbeforeupdate) +- [notification](kui_shell_plugin_electron_components.Screenshot.md#notification) +- [onClickScreenshotRegion](kui_shell_plugin_electron_components.Screenshot.md#onclickscreenshotregion) +- [render](kui_shell_plugin_electron_components.Screenshot.md#render) +- [saveToDisk](kui_shell_plugin_electron_components.Screenshot.md#savetodisk) +- [saveToDiskButton](kui_shell_plugin_electron_components.Screenshot.md#savetodiskbutton) +- [setState](kui_shell_plugin_electron_components.Screenshot.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_electron_components.Screenshot.md#shouldcomponentupdate) + +## Constructors + +### constructor + +• **new Screenshot**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Overrides + +React.PureComponent<Props, State\>.constructor + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L56) + +## Properties + +### \_onClose + +• `Private` `Readonly` **\_onClose**: `any` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:185](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L185) + +--- + +### cleaners + +• `Private` **cleaners**: () => `void`[] = `[]` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:50](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L50) + +--- + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### overlayCleaner + +• `Private` **overlayCleaner**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L49) + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### renderOverlayTransparent + +• `Private` **renderOverlayTransparent**: `boolean` = `false` + +**`see`** https://github.com/IBM/kui/issues/4170 + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:53](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L53) + +--- + +### state + +• **state**: `Readonly`<`State`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### toggleOverlayTransparency + +• `Private` **toggleOverlayTransparency**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:54](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L54) + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### captureRegion + +▸ `Private` **captureRegion**(`element`): `Promise`<`void`\> + +This is the actual work to screenshot a given region of the +screen defined by the extent of the given dom. + +#### Parameters + +| Name | Type | +| :-------- | :-------- | +| `element` | `Element` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:102](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L102) + +--- + +### closeNotification + +▸ `Private` **closeNotification**(): `void` + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:181](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L181) + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### deactivate + +▸ `Private` **deactivate**(): `void` + +Transition back to a normal state, where are aren't ready to capture a screenshot + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:69](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L69) + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### notification + +▸ `Private` **notification**(): `Element` + +Render an Alert to tell the user what we captured + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:188](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L188) + +--- + +### onClickScreenshotRegion + +▸ `Private` **onClickScreenshotRegion**(`element`): `void` + +User has clicked on a region to be captured + +#### Parameters + +| Name | Type | +| :-------- | :-------- | +| `element` | `Element` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:82](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L82) + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:208](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L208) + +--- + +### saveToDisk + +▸ `Private` **saveToDisk**(): `Promise`<`void`\> + +User has clicked on the Save to Desktop button + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:148](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L148) + +--- + +### saveToDiskButton + +▸ `Private` **saveToDiskButton**(): `Element` + +Inside of the ToastNotification, render a Save to Desktop button + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Screenshot.tsx:168](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Screenshot.tsx#L168) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------- | +| `K` | extends keyof `State` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `State` \| (`prevState`: `Readonly`<`State`\>, `props`: `Readonly`<`Props`\>) => `State` \| `Pick`<`State`, `K`\> \| `Pick`<`State`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 diff --git a/docs/api/classes/kui_shell_plugin_electron_components.Search.md b/docs/api/classes/kui_shell_plugin_electron_components.Search.md new file mode 100644 index 00000000000..343abfb68e2 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_electron_components.Search.md @@ -0,0 +1,872 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-electron-components](../modules/kui_shell_plugin_electron_components.md) / Search + +# Class: Search + +[@kui-shell/plugin-electron-components](../modules/kui_shell_plugin_electron_components.md).Search + +## Hierarchy + +- `Component`<`Props`, `State`\> + + ↳ **`Search`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_electron_components.Search.md#constructor) + +### Properties + +- [\_input](kui_shell_plugin_electron_components.Search.md#_input) +- [\_onChange](kui_shell_plugin_electron_components.Search.md#_onchange) +- [\_onClear](kui_shell_plugin_electron_components.Search.md#_onclear) +- [\_onNext](kui_shell_plugin_electron_components.Search.md#_onnext) +- [\_onPrevious](kui_shell_plugin_electron_components.Search.md#_onprevious) +- [context](kui_shell_plugin_electron_components.Search.md#context) +- [props](kui_shell_plugin_electron_components.Search.md#props) +- [refs](kui_shell_plugin_electron_components.Search.md#refs) +- [state](kui_shell_plugin_electron_components.Search.md#state) +- [contextType](kui_shell_plugin_electron_components.Search.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_electron_components.Search.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_electron_components.Search.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_electron_components.Search.md#unsafe_componentwillupdate) +- [\_onRef](kui_shell_plugin_electron_components.Search.md#_onref) +- [componentDidCatch](kui_shell_plugin_electron_components.Search.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_electron_components.Search.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_electron_components.Search.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_electron_components.Search.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_electron_components.Search.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_electron_components.Search.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_electron_components.Search.md#componentwillupdate) +- [doFocus](kui_shell_plugin_electron_components.Search.md#dofocus) +- [findInPage](kui_shell_plugin_electron_components.Search.md#findinpage) +- [forceUpdate](kui_shell_plugin_electron_components.Search.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_electron_components.Search.md#getsnapshotbeforeupdate) +- [hack](kui_shell_plugin_electron_components.Search.md#hack) +- [initEvents](kui_shell_plugin_electron_components.Search.md#initevents) +- [onChange](kui_shell_plugin_electron_components.Search.md#onchange) +- [onClear](kui_shell_plugin_electron_components.Search.md#onclear) +- [onNext](kui_shell_plugin_electron_components.Search.md#onnext) +- [onPrevious](kui_shell_plugin_electron_components.Search.md#onprevious) +- [render](kui_shell_plugin_electron_components.Search.md#render) +- [resultsRender](kui_shell_plugin_electron_components.Search.md#resultsrender) +- [setState](kui_shell_plugin_electron_components.Search.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_electron_components.Search.md#shouldcomponentupdate) +- [stopFindInPage](kui_shell_plugin_electron_components.Search.md#stopfindinpage) + +## Constructors + +### constructor + +• **new Search**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Overrides + +React.Component<Props, State\>.constructor + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L34) + +## Properties + +### \_input + +• `Private` **\_input**: `HTMLInputElement` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:32](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L32) + +--- + +### \_onChange + +• `Private` **\_onChange**: `any` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:80](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L80) + +--- + +### \_onClear + +• `Private` `Readonly` **\_onClear**: `any` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:125](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L125) + +--- + +### \_onNext + +• `Private` `Readonly` **\_onNext**: `any` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:139](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L139) + +--- + +### \_onPrevious + +• `Private` `Readonly` **\_onPrevious**: `any` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:154](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L154) + +--- + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.Component.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.Component.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.Component.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`State`\> + +#### Inherited from + +React.Component.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.Component.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.Component.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.Component.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.Component.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### \_onRef + +▸ `Private` `Readonly` **\_onRef**(`c`): `void` + +#### Parameters + +| Name | Type | +| :--- | :----------------- | +| `c` | `HTMLInputElement` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:167](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L167) + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.Component.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.Component.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.Component.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.Component.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.Component.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ `Optional` **componentWillUnmount**(): `void` + +Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. + +#### Returns + +`void` + +#### Inherited from + +React.Component.componentWillUnmount + +#### Defined in + +node_modules/@types/react/index.d.ts:635 + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.Component.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### doFocus + +▸ `Private` **doFocus**(): `void` + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:119](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L119) + +--- + +### findInPage + +▸ `Private` **findInPage**(`options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :------------------ | +| `options?` | `FindInPageOptions` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:92](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L92) + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.Component.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | + +#### Returns + +`any` + +#### Inherited from + +React.Component.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### hack + +▸ `Private` **hack**(): `void` + +findInPage api seems to result in a loss of focus + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:112](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L112) + +--- + +### initEvents + +▸ `Private` **initEvents**(): `void` + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:57](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L57) + +--- + +### onChange + +▸ `Private` **onChange**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:81](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L81) + +--- + +### onClear + +▸ `Private` **onClear**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:126](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L126) + +--- + +### onNext + +▸ `Private` **onNext**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:140](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L140) + +--- + +### onPrevious + +▸ `Private` **onPrevious**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:155](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L155) + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.Component.render + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:182](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L182) + +--- + +### resultsRender + +▸ `Private` **resultsRender**(): `string` + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:174](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L174) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------- | +| `K` | extends keyof `State` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `State` \| (`prevState`: `Readonly`<`State`\>, `props`: `Readonly`<`Props`\>) => `State` \| `Pick`<`State`, `K`\> \| `Pick`<`State`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.Component.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.Component.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 + +--- + +### stopFindInPage + +▸ `Private` **stopFindInPage**(): `Promise`<`void`\> + +stop findInPage, and clear selections in page + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-electron-components/src/components/Search.tsx:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/Search.tsx#L48) diff --git a/docs/api/classes/kui_shell_plugin_electron_components.UpdateChecker.md b/docs/api/classes/kui_shell_plugin_electron_components.UpdateChecker.md new file mode 100644 index 00000000000..a0860f08516 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_electron_components.UpdateChecker.md @@ -0,0 +1,784 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-electron-components](../modules/kui_shell_plugin_electron_components.md) / UpdateChecker + +# Class: UpdateChecker + +[@kui-shell/plugin-electron-components](../modules/kui_shell_plugin_electron_components.md).UpdateChecker + +## Hierarchy + +- `PureComponent`<`Props`, `State`\> + + ↳ **`UpdateChecker`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_electron_components.UpdateChecker.md#constructor) + +### Properties + +- [context](kui_shell_plugin_electron_components.UpdateChecker.md#context) +- [props](kui_shell_plugin_electron_components.UpdateChecker.md#props) +- [refs](kui_shell_plugin_electron_components.UpdateChecker.md#refs) +- [state](kui_shell_plugin_electron_components.UpdateChecker.md#state) +- [contextType](kui_shell_plugin_electron_components.UpdateChecker.md#contexttype) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_electron_components.UpdateChecker.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_electron_components.UpdateChecker.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_electron_components.UpdateChecker.md#unsafe_componentwillupdate) +- [\_brewUpgrade](kui_shell_plugin_electron_components.UpdateChecker.md#_brewupgrade) +- [checkForUpdates](kui_shell_plugin_electron_components.UpdateChecker.md#checkforupdates) +- [componentDidCatch](kui_shell_plugin_electron_components.UpdateChecker.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_electron_components.UpdateChecker.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_electron_components.UpdateChecker.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_electron_components.UpdateChecker.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_electron_components.UpdateChecker.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_electron_components.UpdateChecker.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_electron_components.UpdateChecker.md#componentwillupdate) +- [dulyNoted](kui_shell_plugin_electron_components.UpdateChecker.md#dulynoted) +- [forceUpdate](kui_shell_plugin_electron_components.UpdateChecker.md#forceupdate) +- [getCurrentVersion](kui_shell_plugin_electron_components.UpdateChecker.md#getcurrentversion) +- [getSnapshotBeforeUpdate](kui_shell_plugin_electron_components.UpdateChecker.md#getsnapshotbeforeupdate) +- [initPinger](kui_shell_plugin_electron_components.UpdateChecker.md#initpinger) +- [isUpdateAvailable](kui_shell_plugin_electron_components.UpdateChecker.md#isupdateavailable) +- [popover](kui_shell_plugin_electron_components.UpdateChecker.md#popover) +- [render](kui_shell_plugin_electron_components.UpdateChecker.md#render) +- [setState](kui_shell_plugin_electron_components.UpdateChecker.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_electron_components.UpdateChecker.md#shouldcomponentupdate) +- [text](kui_shell_plugin_electron_components.UpdateChecker.md#text) + +## Constructors + +### constructor + +• **new UpdateChecker**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Overrides + +React.PureComponent<Props, State\>.constructor + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:108](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L108) + +## Properties + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`State`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### \_brewUpgrade + +▸ `Private` `Readonly` **\_brewUpgrade**(): `Promise`<`KResponse`<`any`\>\> + +#### Returns + +`Promise`<`KResponse`<`any`\>\> + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:157](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L157) + +--- + +### checkForUpdates + +▸ `Private` **checkForUpdates**(): `void` + +Ping the release feed to check for the latest release + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:130](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L130) + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ **componentDidMount**(): `void` + +#### Returns + +`void` + +#### Overrides + +React.PureComponent.componentDidMount + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:208](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L208) + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ **componentWillUnmount**(): `void` + +Bye! + +#### Returns + +`void` + +#### Overrides + +React.PureComponent.componentWillUnmount + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:213](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L213) + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### dulyNoted + +▸ `Private` **dulyNoted**(): `Promise`<`void`\> + +User has acknoledged the notification + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:245](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L245) + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getCurrentVersion + +▸ `Private` **getCurrentVersion**(): `Promise`<`void`\> + +What version are we running? + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:193](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L193) + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### initPinger + +▸ `Private` **initPinger**(): `Timeout` + +Initialize a timer that periodically checks for updates + +#### Returns + +`Timeout` + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:123](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L123) + +--- + +### isUpdateAvailable + +▸ `Private` **isUpdateAvailable**(): `boolean` + +Given current state, is an update available? + +#### Returns + +`boolean` + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:220](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L220) + +--- + +### popover + +▸ `Private` **popover**(`entryForLatestVersion`): `Object` + +#### Parameters + +| Name | Type | +| :------------------------------- | :------- | +| `entryForLatestVersion` | `Object` | +| `entryForLatestVersion.content` | `string` | +| `entryForLatestVersion.download` | `string` | +| `entryForLatestVersion.title` | `string` | +| `entryForLatestVersion.updated` | `string` | +| `entryForLatestVersion.version` | `string` | + +#### Returns + +`Object` + +| Name | Type | +| :-------------- | :----------------------- | +| `bodyContent` | `Element` | +| `className` | `string` | +| `headerContent` | `Element` | +| `maxWidth` | `string` | +| `onHide` | () => `Promise`<`void`\> | + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:159](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L159) + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:257](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L257) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------- | +| `K` | extends keyof `State` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `State` \| (`prevState`: `Readonly`<`State`\>, `props`: `Readonly`<`Props`\>) => `State` \| `Pick`<`State`, `K`\> \| `Pick`<`State`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 + +--- + +### text + +▸ `Private` **text**(): `string` + +Text for update available notification + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-electron-components/src/components/UpdateChecker.tsx:240](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-electron-components/src/components/UpdateChecker.tsx#L240) diff --git a/docs/api/classes/kui_shell_plugin_git.CurrentGitBranch.md b/docs/api/classes/kui_shell_plugin_git.CurrentGitBranch.md new file mode 100644 index 00000000000..bef0e3509a3 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_git.CurrentGitBranch.md @@ -0,0 +1,875 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-git](../modules/kui_shell_plugin_git.md) / CurrentGitBranch + +# Class: CurrentGitBranch + +[@kui-shell/plugin-git](../modules/kui_shell_plugin_git.md).CurrentGitBranch + +## Hierarchy + +- `PureComponent`<`Props`, `State`\> + + ↳ **`CurrentGitBranch`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_git.CurrentGitBranch.md#constructor) + +### Properties + +- [\_unmounted](kui_shell_plugin_git.CurrentGitBranch.md#_unmounted) +- [context](kui_shell_plugin_git.CurrentGitBranch.md#context) +- [handler](kui_shell_plugin_git.CurrentGitBranch.md#handler) +- [last](kui_shell_plugin_git.CurrentGitBranch.md#last) +- [props](kui_shell_plugin_git.CurrentGitBranch.md#props) +- [refs](kui_shell_plugin_git.CurrentGitBranch.md#refs) +- [state](kui_shell_plugin_git.CurrentGitBranch.md#state) +- [contextType](kui_shell_plugin_git.CurrentGitBranch.md#contexttype) + +### Accessors + +- [unmounted](kui_shell_plugin_git.CurrentGitBranch.md#unmounted) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_git.CurrentGitBranch.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_git.CurrentGitBranch.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_git.CurrentGitBranch.md#unsafe_componentwillupdate) +- [changeBranch](kui_shell_plugin_git.CurrentGitBranch.md#changebranch) +- [changes](kui_shell_plugin_git.CurrentGitBranch.md#changes) +- [componentDidCatch](kui_shell_plugin_git.CurrentGitBranch.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_git.CurrentGitBranch.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_git.CurrentGitBranch.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_git.CurrentGitBranch.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_git.CurrentGitBranch.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_git.CurrentGitBranch.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_git.CurrentGitBranch.md#componentwillupdate) +- [debounce](kui_shell_plugin_git.CurrentGitBranch.md#debounce) +- [forceUpdate](kui_shell_plugin_git.CurrentGitBranch.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_git.CurrentGitBranch.md#getsnapshotbeforeupdate) +- [popover](kui_shell_plugin_git.CurrentGitBranch.md#popover) +- [popoverBody](kui_shell_plugin_git.CurrentGitBranch.md#popoverbody) +- [popoverHeader](kui_shell_plugin_git.CurrentGitBranch.md#popoverheader) +- [render](kui_shell_plugin_git.CurrentGitBranch.md#render) +- [reportCurrentBranch](kui_shell_plugin_git.CurrentGitBranch.md#reportcurrentbranch) +- [setState](kui_shell_plugin_git.CurrentGitBranch.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_git.CurrentGitBranch.md#shouldcomponentupdate) +- [statusModel](kui_shell_plugin_git.CurrentGitBranch.md#statusmodel) +- [summary](kui_shell_plugin_git.CurrentGitBranch.md#summary) + +## Constructors + +### constructor + +• **new CurrentGitBranch**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Overrides + +React.PureComponent<Props, State\>.constructor + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L39) + +## Properties + +### \_unmounted + +• `Private` **\_unmounted**: `boolean` = `true` + +So we don't handle events after unmounting + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:50](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L50) + +--- + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### handler + +• `Private` `Readonly` **handler**: `any` + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L37) + +--- + +### last + +• `Private` **last**: `number` + +Avoid recomputation for a flurry of events + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:60](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L60) + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`State`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +## Accessors + +### unmounted + +• `Private` `get` **unmounted**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L51) + +• `Private` `set` **unmounted**(`umm`): `void` + +#### Parameters + +| Name | Type | +| :---- | :-------- | +| `umm` | `boolean` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L55) + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### changeBranch + +▸ `Private` **changeBranch**(): `Element` + +#### Returns + +`Element` + +UI for changing branches + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:230](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L230) + +--- + +### changes + +▸ `Private` **changes**(`statusModel`): `Element` + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------- | +| `statusModel` | { `M`: `string` ; `file`: `string` }[] | + +#### Returns + +`Element` + +UI for changes represented by `statusModel` + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:195](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L195) + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ **componentDidMount**(): `void` + +Once we have mounted, we immediately check the current branch, +and schedule an update based on standard REPL events. + +#### Returns + +`void` + +#### Overrides + +React.PureComponent.componentDidMount + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:126](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L126) + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ **componentWillUnmount**(): `void` + +Make sure to unsubscribe! + +#### Returns + +`void` + +#### Overrides + +React.PureComponent.componentWillUnmount + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:138](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L138) + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### debounce + +▸ `Private` **debounce**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:61](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L61) + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### popover + +▸ `Private` **popover**(): `Object` + +#### Returns + +`Object` + +desired Popover model + +| Name | Type | +| :-------------- | :-------- | +| `bodyContent` | `Element` | +| `headerContent` | `Element` | + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:222](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L222) + +--- + +### popoverBody + +▸ `Private` **popoverBody**(): `Element` + +#### Returns + +`Element` + +the body for the Popover component + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:157](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L157) + +--- + +### popoverHeader + +▸ `Private` **popoverHeader**(): `Element` + +#### Returns + +`Element` + +the header for the Popover component + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:144](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L144) + +--- + +### render + +▸ **render**(): `Element` + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:238](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L238) + +--- + +### reportCurrentBranch + +▸ `Private` **reportCurrentBranch**(): `Promise`<`void`\> + +Check the current branch, and the dirtiness thereof. + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:73](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L73) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------- | +| `K` | extends keyof `State` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `State` \| (`prevState`: `Readonly`<`State`\>, `props`: `Readonly`<`Props`\>) => `State` \| `Pick`<`State`, `K`\> \| `Pick`<`State`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 + +--- + +### statusModel + +▸ `Private` **statusModel**(): { `M`: `string` ; `file`: `string` }[] + +#### Returns + +{ `M`: `string` ; `file`: `string` }[] + +a model of `git status -s` + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:169](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L169) + +--- + +### summary + +▸ `Private` **summary**(`statusModel`): `Element` + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------- | +| `statusModel` | { `M`: `string` ; `file`: `string` }[] | + +#### Returns + +`Element` + +UI that summarizes the `statusModel` changes + +#### Defined in + +[plugins/plugin-git/src/CurrentGitBranch.tsx:184](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-git/src/CurrentGitBranch.tsx#L184) diff --git a/docs/api/classes/kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md b/docs/api/classes/kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md new file mode 100644 index 00000000000..8f135d2922d --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md @@ -0,0 +1,661 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-proxy-support](../modules/kui_shell_plugin_proxy_support.md) / ProxyOfflineIndicator + +# Class: ProxyOfflineIndicator + +[@kui-shell/plugin-proxy-support](../modules/kui_shell_plugin_proxy_support.md).ProxyOfflineIndicator + +## Hierarchy + +- `PureComponent`<`Props`, `State`\> + + ↳ **`ProxyOfflineIndicator`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#constructor) + +### Properties + +- [cleaners](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#cleaners) +- [context](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#context) +- [props](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#props) +- [refs](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#refs) +- [state](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#state) +- [contextType](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#contexttype) +- [rememberedOffline](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#rememberedoffline) + +### Methods + +- [UNSAFE_componentWillMount](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#unsafe_componentwillmount) +- [UNSAFE_componentWillReceiveProps](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#unsafe_componentwillreceiveprops) +- [UNSAFE_componentWillUpdate](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#unsafe_componentwillupdate) +- [componentDidCatch](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#componentdidcatch) +- [componentDidMount](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#componentdidmount) +- [componentDidUpdate](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#componentdidupdate) +- [componentWillMount](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#componentwillmount) +- [componentWillReceiveProps](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#componentwillreceiveprops) +- [componentWillUnmount](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#componentwillunmount) +- [componentWillUpdate](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#componentwillupdate) +- [forceUpdate](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#forceupdate) +- [getSnapshotBeforeUpdate](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#getsnapshotbeforeupdate) +- [render](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#render) +- [setState](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#setstate) +- [shouldComponentUpdate](kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md#shouldcomponentupdate) + +## Constructors + +### constructor + +• **new ProxyOfflineIndicator**(`props`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Overrides + +React.PureComponent<Props, State\>.constructor + +#### Defined in + +[plugins/plugin-proxy-support/src/view/ProxyOfflineIndicator.tsx:42](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-proxy-support/src/view/ProxyOfflineIndicator.tsx#L42) + +## Properties + +### cleaners + +• `Private` **cleaners**: () => `void`[] = `[]` + +Cleanups for event listener registrations + +#### Defined in + +[plugins/plugin-proxy-support/src/view/ProxyOfflineIndicator.tsx:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-proxy-support/src/view/ProxyOfflineIndicator.tsx#L40) + +--- + +### context + +• **context**: `any` + +If using the new style context, re-declare this in your class to be the +`React.ContextType` of your `static contextType`. +Should be used with type annotation or static contextType. + +```ts +static contextType = MyContext +// For TS pre-3.7: +context!: React.ContextType +// For TS 3.7 and above: +declare context: React.ContextType +``` + +**`see`** https://reactjs.org/docs/context.html + +#### Inherited from + +React.PureComponent.context + +#### Defined in + +node_modules/@types/react/index.d.ts:473 + +--- + +### props + +• `Readonly` **props**: `Readonly`<`Props`\> & `Readonly`<`Object`\> + +#### Inherited from + +React.PureComponent.props + +#### Defined in + +node_modules/@types/react/index.d.ts:498 + +--- + +### refs + +• **refs**: `Object` + +**`deprecated`** +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs + +#### Index signature + +▪ [key: `string`]: `ReactInstance` + +#### Inherited from + +React.PureComponent.refs + +#### Defined in + +node_modules/@types/react/index.d.ts:504 + +--- + +### state + +• **state**: `Readonly`<`State`\> + +#### Inherited from + +React.PureComponent.state + +#### Defined in + +node_modules/@types/react/index.d.ts:499 + +--- + +### contextType + +▪ `Static` `Optional` **contextType**: `Context`<`any`\> + +If set, `this.context` will be set at runtime to the current value of the given Context. + +Usage: + +```ts +type MyContext = number +const Ctx = React.createContext(0) + +class Foo extends React.Component { + static contextType = Ctx + context!: React.ContextType + render() { + return <>My context's value: {this.context} + } +} +``` + +**`see`** https://reactjs.org/docs/context.html#classcontexttype + +#### Inherited from + +React.PureComponent.contextType + +#### Defined in + +node_modules/@types/react/index.d.ts:455 + +--- + +### rememberedOffline + +▪ `Static` `Private` **rememberedOffline**: `boolean` = `true` + +To help maintain state across unmounts + +#### Defined in + +[plugins/plugin-proxy-support/src/view/ProxyOfflineIndicator.tsx:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-proxy-support/src/view/ProxyOfflineIndicator.tsx#L37) + +## Methods + +### UNSAFE_componentWillMount + +▸ `Optional` **UNSAFE_componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:711 + +--- + +### UNSAFE_componentWillReceiveProps + +▸ `Optional` **UNSAFE_componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:743 + +--- + +### UNSAFE_componentWillUpdate + +▸ `Optional` **UNSAFE_componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +This method will not stop working in React 17. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.UNSAFE_componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:771 + +--- + +### componentDidCatch + +▸ `Optional` **componentDidCatch**(`error`, `errorInfo`): `void` + +Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount. + +#### Parameters + +| Name | Type | +| :---------- | :---------- | +| `error` | `Error` | +| `errorInfo` | `ErrorInfo` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidCatch + +#### Defined in + +node_modules/@types/react/index.d.ts:640 + +--- + +### componentDidMount + +▸ `Optional` **componentDidMount**(): `void` + +Called immediately after a component is mounted. Setting state here will trigger re-rendering. + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidMount + +#### Defined in + +node_modules/@types/react/index.d.ts:619 + +--- + +### componentDidUpdate + +▸ `Optional` **componentDidUpdate**(`prevProps`, `prevState`, `snapshot?`): `void` + +Called immediately after updating occurs. Not called for the initial render. + +The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | +| `snapshot?` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentDidUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:682 + +--- + +### componentWillMount + +▸ `Optional` **componentWillMount**(): `void` + +Called immediately before mounting occurs, and before `Component#render`. +Avoid introducing any side-effects or subscriptions in this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use componentDidMount or the constructor instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillMount + +#### Defined in + +node_modules/@types/react/index.d.ts:697 + +--- + +### componentWillReceiveProps + +▸ `Optional` **componentWillReceiveProps**(`nextProps`, `nextContext`): `void` + +Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes. + +Calling `Component#setState` generally does not trigger this method. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillReceiveProps + +#### Defined in + +node_modules/@types/react/index.d.ts:726 + +--- + +### componentWillUnmount + +▸ **componentWillUnmount**(): `void` + +#### Returns + +`void` + +#### Overrides + +React.PureComponent.componentWillUnmount + +#### Defined in + +[plugins/plugin-proxy-support/src/view/ProxyOfflineIndicator.tsx:63](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-proxy-support/src/view/ProxyOfflineIndicator.tsx#L63) + +--- + +### componentWillUpdate + +▸ `Optional` **componentWillUpdate**(`nextProps`, `nextState`, `nextContext`): `void` + +Called immediately before rendering when new props or state is received. Not called for the initial render. + +Note: You cannot call `Component#setState` here. + +Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked. + +**`deprecated`** 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update + +**`see`** https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.componentWillUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:756 + +--- + +### forceUpdate + +▸ **forceUpdate**(`callback?`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------- | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.forceUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:490 + +--- + +### getSnapshotBeforeUpdate + +▸ `Optional` **getSnapshotBeforeUpdate**(`prevProps`, `prevState`): `any` + +Runs before React applies the result of `render` to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before `render` causes changes to it. + +Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running. + +#### Parameters + +| Name | Type | +| :---------- | :------------------- | +| `prevProps` | `Readonly`<`Props`\> | +| `prevState` | `Readonly`<`State`\> | + +#### Returns + +`any` + +#### Inherited from + +React.PureComponent.getSnapshotBeforeUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:676 + +--- + +### render + +▸ **render**(): `Element` + +If the proxy is enabled, and we are offline, then render a widget indicating such. + +#### Returns + +`Element` + +#### Overrides + +React.PureComponent.render + +#### Defined in + +[plugins/plugin-proxy-support/src/view/ProxyOfflineIndicator.tsx:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-proxy-support/src/view/ProxyOfflineIndicator.tsx#L70) + +--- + +### setState + +▸ **setState**<`K`\>(`state`, `callback?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------- | +| `K` | extends keyof `State` | + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `state` | `State` \| (`prevState`: `Readonly`<`State`\>, `props`: `Readonly`<`Props`\>) => `State` \| `Pick`<`State`, `K`\> \| `Pick`<`State`, `K`\> | +| `callback?` | () => `void` | + +#### Returns + +`void` + +#### Inherited from + +React.PureComponent.setState + +#### Defined in + +node_modules/@types/react/index.d.ts:485 + +--- + +### shouldComponentUpdate + +▸ `Optional` **shouldComponentUpdate**(`nextProps`, `nextState`, `nextContext`): `boolean` + +Called to determine whether the change in props and state should trigger a re-render. + +`Component` always returns true. +`PureComponent` implements a shallow comparison on props and state and returns true if any +props or states have changed. + +If false is returned, `Component#render`, `componentWillUpdate` +and `componentDidUpdate` will not be called. + +#### Parameters + +| Name | Type | +| :------------ | :------------------- | +| `nextProps` | `Readonly`<`Props`\> | +| `nextState` | `Readonly`<`State`\> | +| `nextContext` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +React.PureComponent.shouldComponentUpdate + +#### Defined in + +node_modules/@types/react/index.d.ts:630 diff --git a/docs/api/classes/kui_shell_plugin_s3.UnsupportedS3ProviderError.md b/docs/api/classes/kui_shell_plugin_s3.UnsupportedS3ProviderError.md new file mode 100644 index 00000000000..1aaebf947b3 --- /dev/null +++ b/docs/api/classes/kui_shell_plugin_s3.UnsupportedS3ProviderError.md @@ -0,0 +1,161 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-s3](../modules/kui_shell_plugin_s3.md) / UnsupportedS3ProviderError + +# Class: UnsupportedS3ProviderError + +[@kui-shell/plugin-s3](../modules/kui_shell_plugin_s3.md).UnsupportedS3ProviderError + +## Hierarchy + +- `Error` + + ↳ **`UnsupportedS3ProviderError`** + +## Table of contents + +### Constructors + +- [constructor](kui_shell_plugin_s3.UnsupportedS3ProviderError.md#constructor) + +### Properties + +- [message](kui_shell_plugin_s3.UnsupportedS3ProviderError.md#message) +- [name](kui_shell_plugin_s3.UnsupportedS3ProviderError.md#name) +- [stack](kui_shell_plugin_s3.UnsupportedS3ProviderError.md#stack) +- [stackTraceLimit](kui_shell_plugin_s3.UnsupportedS3ProviderError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](kui_shell_plugin_s3.UnsupportedS3ProviderError.md#capturestacktrace) +- [prepareStackTrace](kui_shell_plugin_s3.UnsupportedS3ProviderError.md#preparestacktrace) + +## Constructors + +### constructor + +• **new UnsupportedS3ProviderError**(`message?`) + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `message?` | `string` | + +#### Inherited from + +Error.constructor + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:979 + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:974 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:973 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:975 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:142 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `Object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:133 + +--- + +### prepareStackTrace + +▸ `Static` `Optional` **prepareStackTrace**(`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`see`** https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces + +#### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +#### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:140 diff --git a/docs/api/classes/kui_shell_test.TestMMR.md b/docs/api/classes/kui_shell_test.TestMMR.md new file mode 100644 index 00000000000..59b227c7d4d --- /dev/null +++ b/docs/api/classes/kui_shell_test.TestMMR.md @@ -0,0 +1,293 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](../modules/kui_shell_test.md) / TestMMR + +# Class: TestMMR + +[@kui-shell/test](../modules/kui_shell_test.md).TestMMR + +## Table of contents + +### Constructors + +- [constructor](kui_shell_test.TestMMR.md#constructor) + +### Properties + +- [param](kui_shell_test.TestMMR.md#param) + +### Methods + +- [badges](kui_shell_test.TestMMR.md#badges) +- [diffPlainText](kui_shell_test.TestMMR.md#diffplaintext) +- [kind](kui_shell_test.TestMMR.md#kind) +- [modes](kui_shell_test.TestMMR.md#modes) +- [name](kui_shell_test.TestMMR.md#name) +- [namespace](kui_shell_test.TestMMR.md#namespace) +- [testClickResult](kui_shell_test.TestMMR.md#testclickresult) +- [toolbarButtons](kui_shell_test.TestMMR.md#toolbarbuttons) +- [toolbarNotExist](kui_shell_test.TestMMR.md#toolbarnotexist) +- [toolbarText](kui_shell_test.TestMMR.md#toolbartext) + +## Constructors + +### constructor + +• **new TestMMR**(`param`) + +new TestMMR() instantiates a class of multi-model-response tests + +#### Parameters + +| Name | Type | Description | +| :------ | :---------- | :--------------------------------------- | +| `param` | `TestParam` | includes: command, testName and metadata | + +#### Defined in + +[packages/test/src/api/mmr.ts:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L46) + +## Properties + +### param + +• `Readonly` **param**: `TestParam` + +## Methods + +### badges + +▸ **badges**(`badges`): `void` + +badges() starts a Mocha Test Suite +badges() executes `command` in REPL and expects `badges` are showin in Sidecar + +#### Parameters + +| Name | Type | Description | +| :------- | :------------ | :------------------------------------------ | +| `badges` | `BadgeSpec`[] | is the expected badges shown in the Sidecar | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/mmr.ts:195](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L195) + +--- + +### diffPlainText + +▸ **diffPlainText**(`mode`, `textB`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `mode` | `string` | +| `textB` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/mmr.ts:381](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L381) + +--- + +### kind + +▸ **kind**(`kind`): `void` + +kind() starts a Mocha Test Suite +kind() executes `command` in REPL and expects `kind` is showin in Sidecar + +#### Parameters + +| Name | Type | Description | +| :----- | :------- | :--------------------------------------------- | +| `kind` | `string` | is the expected kind text shown in the Sidecar | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/mmr.ts:173](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L173) + +--- + +### modes + +▸ **modes**(`expectModes`, `defaultMode`): `void` + +modes() starts a Mocha Test Suite +modes() executes `command` in REPL and expects `modes` are showin in Sidecar + +#### Parameters + +| Name | Type | Description | +| :------------ | :-------------------------------------------------------------- | :------------------------------------------ | +| `expectModes` | [`MMRExpectMode`](../modules/kui_shell_test.md#mmrexpectmode)[] | is the expected modes shown as Sidecar Tabs | +| `defaultMode` | [`MMRExpectMode`](../modules/kui_shell_test.md#mmrexpectmode) | is the expected default Sidecar Tab | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/mmr.ts:218](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L218) + +--- + +### name + +▸ **name**(`opt?`): `void` + +name() starts a Mocha Test Suite +name() executes `command` in REPL and expects `prettyName` or `name` is shown in Sidecar + +#### Parameters + +| Name | Type | +| :---------------------- | :------------ | +| `opt?` | `Object` | +| `opt.heroName?` | `boolean` | +| `opt.nameHash?` | `string` | +| `opt.onclick?` | `Object` | +| `opt.onclick.name?` | `ClickExpect` | +| `opt.onclick.nameHash?` | `ClickExpect` | +| `opt.prettyName?` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/mmr.ts:59](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L59) + +--- + +### namespace + +▸ **namespace**(`opt?`): `void` + +namespace() starts a Mocha Test Suite +namespace() executes `command` in REPL and expects `namespace` is shown in Sidecar + +#### Parameters + +| Name | Type | +| :------------ | :------------ | +| `opt?` | `Object` | +| `opt.onclick` | `ClickExpect` | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/mmr.ts:131](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L131) + +--- + +### testClickResult + +▸ `Private` **testClickResult**(`cmdIdx`, `command`, `expect`): (`app`: `Application`) => `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `cmdIdx` | `number` | +| `command` | `string` | +| `expect` | `string` | + +#### Returns + +`fn` + +▸ (`app`): `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :---- | :------------ | +| `app` | `Application` | + +##### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/mmr.ts:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L48) + +--- + +### toolbarButtons + +▸ **toolbarButtons**(`buttons`): `void` + +toolbarButtons() starts a Mocha Test Suite +toolbarButtons() executes `command` and expects the `buttons` shown in Sidecar having correct labels and drildown handlers + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------- | +| `buttons` | { `command`: `string` \| `Function` ; `confirm?`: `boolean` ; `expectError?`: `127` ; `kind`: `"view"` \| `"drilldown"` ; `label?`: `string` ; `mode`: `string` }[] | is the expected array of `button` shown in the Sidecar Toolbar | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/mmr.ts:405](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L405) + +--- + +### toolbarNotExist + +▸ **toolbarNotExist**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/mmr.ts:517](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L517) + +--- + +### toolbarText + +▸ **toolbarText**(`toolbarText`): `void` + +toolbarText() starts a Mocha Test Suite +toolbarText() executes `command` and expects Sidecar Toolbar has correct `text` and `type` + +#### Parameters + +| Name | Type | Description | +| :------------------- | :-------- | :----------------------------------------------------------------- | +| `toolbarText` | `Object` | is the expected text content and type shown in the Sidecar Toolbar | +| `toolbarText.exact?` | `boolean` | - | +| `toolbarText.text` | `string` | - | +| `toolbarText.type` | `string` | - | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/mmr.ts:500](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L500) diff --git a/docs/api/classes/kui_shell_test.TestNavResponse.md b/docs/api/classes/kui_shell_test.TestNavResponse.md new file mode 100644 index 00000000000..074452a22fd --- /dev/null +++ b/docs/api/classes/kui_shell_test.TestNavResponse.md @@ -0,0 +1,55 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](../modules/kui_shell_test.md) / TestNavResponse + +# Class: TestNavResponse + +[@kui-shell/test](../modules/kui_shell_test.md).TestNavResponse + +## Table of contents + +### Constructors + +- [constructor](kui_shell_test.TestNavResponse.md#constructor) + +### Properties + +- [param](kui_shell_test.TestNavResponse.md#param) + +### Methods + +- [run](kui_shell_test.TestNavResponse.md#run) + +## Constructors + +### constructor + +• **new TestNavResponse**(`param`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `param` | `Param` | + +#### Defined in + +[packages/test/src/api/NavResponse.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/NavResponse.ts#L39) + +## Properties + +### param + +• `Readonly` **param**: `Param` + +## Methods + +### run + +▸ **run**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/NavResponse.ts:41](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/NavResponse.ts#L41) diff --git a/docs/api/classes/kui_shell_test.TestStringResponse.md b/docs/api/classes/kui_shell_test.TestStringResponse.md new file mode 100644 index 00000000000..c93f357d1b2 --- /dev/null +++ b/docs/api/classes/kui_shell_test.TestStringResponse.md @@ -0,0 +1,55 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](../modules/kui_shell_test.md) / TestStringResponse + +# Class: TestStringResponse + +[@kui-shell/test](../modules/kui_shell_test.md).TestStringResponse + +## Table of contents + +### Constructors + +- [constructor](kui_shell_test.TestStringResponse.md#constructor) + +### Properties + +- [param](kui_shell_test.TestStringResponse.md#param) + +### Methods + +- [string](kui_shell_test.TestStringResponse.md#string) + +## Constructors + +### constructor + +• **new TestStringResponse**(`param`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `param` | `Param` | + +#### Defined in + +[packages/test/src/api/string-response.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/string-response.ts#L29) + +## Properties + +### param + +• `Readonly` **param**: `Param` + +## Methods + +### string + +▸ **string**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/string-response.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/string-response.ts#L31) diff --git a/docs/api/classes/kui_shell_test.TestTable.md b/docs/api/classes/kui_shell_test.TestTable.md new file mode 100644 index 00000000000..0964d0095bc --- /dev/null +++ b/docs/api/classes/kui_shell_test.TestTable.md @@ -0,0 +1,181 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](../modules/kui_shell_test.md) / TestTable + +# Class: TestTable + +[@kui-shell/test](../modules/kui_shell_test.md).TestTable + +## Table of contents + +### Constructors + +- [constructor](kui_shell_test.TestTable.md#constructor) + +### Properties + +- [cmdIdx](kui_shell_test.TestTable.md#cmdidx) +- [ctx](kui_shell_test.TestTable.md#ctx) +- [outputCount](kui_shell_test.TestTable.md#outputcount) +- [testName](kui_shell_test.TestTable.md#testname) +- [tests](kui_shell_test.TestTable.md#tests) + +### Methods + +- [drilldownFromTable](kui_shell_test.TestTable.md#drilldownfromtable) +- [evalStatus](kui_shell_test.TestTable.md#evalstatus) +- [executeAndValidate](kui_shell_test.TestTable.md#executeandvalidate) +- [run](kui_shell_test.TestTable.md#run) + +## Constructors + +### constructor + +• **new TestTable**(`testName?`, `tests?`) + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `testName?` | `string` | +| `tests?` | `Tests` | + +#### Defined in + +[packages/test/src/api/table.ts:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/table.ts#L56) + +## Properties + +### cmdIdx + +• `Private` **cmdIdx**: `number` + +#### Defined in + +[packages/test/src/api/table.ts:54](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/table.ts#L54) + +--- + +### ctx + +• `Private` **ctx**: [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) + +#### Defined in + +[packages/test/src/api/table.ts:52](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/table.ts#L52) + +--- + +### outputCount + +• `Private` **outputCount**: `number` + +#### Defined in + +[packages/test/src/api/table.ts:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/table.ts#L51) + +--- + +### testName + +• `Private` **testName**: `string` + +#### Defined in + +[packages/test/src/api/table.ts:50](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/table.ts#L50) + +--- + +### tests + +• `Private` **tests**: `Tests` + +#### Defined in + +[packages/test/src/api/table.ts:53](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/table.ts#L53) + +## 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`](../interfaces/kui_shell_test.Common.ISuite.md) | - | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/table.ts:219](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/table.ts#L219) + +--- + +### evalStatus + +▸ **evalStatus**(`_`): `void` + +#### Parameters + +| Name | Type | +| :--------------------- | :-------------------------------------------------------- | +| `_` | `Object` | +| `_.command` | `string` | +| `_.ctx?` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | +| `_.expectRow` | `RowWithBadgeAndMessage`[] | +| `_.statusDescription?` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/table.ts:87](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/table.ts#L87) + +--- + +### 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`](../interfaces/kui_shell_test.Common.ISuite.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/table.ts:124](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/table.ts#L124) + +--- + +### run + +▸ **run**(): `void` + +new TestTable().run() will start a mocha test suite + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/table.ts:62](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/table.ts#L62) diff --git a/docs/api/enums/kui_shell_core.CellShould.md b/docs/api/enums/kui_shell_core.CellShould.md new file mode 100644 index 00000000000..07dbccde5d0 --- /dev/null +++ b/docs/api/enums/kui_shell_core.CellShould.md @@ -0,0 +1,111 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / CellShould + +# Enumeration: CellShould + +[@kui-shell/core](../modules/kui_shell_core.md).CellShould + +Hints to improve visualization of table cells + +## Table of contents + +### Enumeration members + +- [BeGrayish](kui_shell_core.CellShould.md#begrayish) +- [BeHidden](kui_shell_core.CellShould.md#behidden) +- [ElideWhenNarrow](kui_shell_core.CellShould.md#elidewhennarrow) +- [HaveGrayBadge](kui_shell_core.CellShould.md#havegraybadge) +- [HaveGreenBadge](kui_shell_core.CellShould.md#havegreenbadge) +- [HaveRedBadge](kui_shell_core.CellShould.md#haveredbadge) +- [HaveYellowBadge](kui_shell_core.CellShould.md#haveyellowbadge) +- [HideWhenNarrow](kui_shell_core.CellShould.md#hidewhennarrow) +- [HideWithSidecar](kui_shell_core.CellShould.md#hidewithsidecar) + +## Enumeration members + +### BeGrayish + +• **BeGrayish** = `"sub-text"` + +#### Defined in + +[packages/core/src/models/CellShould.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CellShould.ts#L25) + +--- + +### BeHidden + +• **BeHidden** = `"hide"` + +#### Defined in + +[packages/core/src/models/CellShould.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CellShould.ts#L26) + +--- + +### ElideWhenNarrow + +• **ElideWhenNarrow** = `"elide-with-narrow-window"` + +#### Defined in + +[packages/core/src/models/CellShould.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CellShould.ts#L24) + +--- + +### HaveGrayBadge + +• **HaveGrayBadge** = `"gray-background"` + +#### Defined in + +[packages/core/src/models/CellShould.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CellShould.ts#L31) + +--- + +### HaveGreenBadge + +• **HaveGreenBadge** = `"green-background"` + +#### Defined in + +[packages/core/src/models/CellShould.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CellShould.ts#L28) + +--- + +### HaveRedBadge + +• **HaveRedBadge** = `"red-background"` + +#### Defined in + +[packages/core/src/models/CellShould.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CellShould.ts#L30) + +--- + +### HaveYellowBadge + +• **HaveYellowBadge** = `"yellow-background"` + +#### Defined in + +[packages/core/src/models/CellShould.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CellShould.ts#L29) + +--- + +### HideWhenNarrow + +• **HideWhenNarrow** = `"hide-with-narrow-window"` + +#### Defined in + +[packages/core/src/models/CellShould.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CellShould.ts#L23) + +--- + +### HideWithSidecar + +• **HideWithSidecar** = `"hide-with-sidecar"` + +#### Defined in + +[packages/core/src/models/CellShould.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CellShould.ts#L22) diff --git a/docs/api/enums/kui_shell_core.ExecType.md b/docs/api/enums/kui_shell_core.ExecType.md new file mode 100644 index 00000000000..91c4ab9b07c --- /dev/null +++ b/docs/api/enums/kui_shell_core.ExecType.md @@ -0,0 +1,58 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ExecType + +# Enumeration: ExecType + +[@kui-shell/core](../modules/kui_shell_core.md).ExecType + +"top-level", meaning the user hit enter in the CLI, +"click-handler", meaning that the user clicked on a UI element +"nested", meaning that some evaluator uses the repl in its internal implementation + +## Table of contents + +### Enumeration members + +- [ClickHandler](kui_shell_core.ExecType.md#clickhandler) +- [Nested](kui_shell_core.ExecType.md#nested) +- [Rerun](kui_shell_core.ExecType.md#rerun) +- [TopLevel](kui_shell_core.ExecType.md#toplevel) + +## Enumeration members + +### ClickHandler + +• **ClickHandler** = `1` + +#### Defined in + +[packages/core/src/models/command.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L43) + +--- + +### Nested + +• **Nested** = `2` + +#### Defined in + +[packages/core/src/models/command.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L44) + +--- + +### Rerun + +• **Rerun** = `3` + +#### Defined in + +[packages/core/src/models/command.ts:45](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L45) + +--- + +### TopLevel + +• **TopLevel** = `0` + +#### Defined in + +[packages/core/src/models/command.ts:42](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L42) diff --git a/docs/api/enums/kui_shell_core.Presentation.md b/docs/api/enums/kui_shell_core.Presentation.md new file mode 100644 index 00000000000..a3388cfd45a --- /dev/null +++ b/docs/api/enums/kui_shell_core.Presentation.md @@ -0,0 +1,77 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Presentation + +# Enumeration: Presentation + +[@kui-shell/core](../modules/kui_shell_core.md).Presentation + +Presentation modes + +Usage: + +import { Presentation } from '@kui-shell/core' + +{ +type: 'custom', +presentation: Presentation.SidecarFullscreen, +content: ... +} + +## Table of contents + +### Enumeration members + +- [Default](kui_shell_core.Presentation.md#default) +- [FixedSize](kui_shell_core.Presentation.md#fixedsize) +- [SidecarFullscreen](kui_shell_core.Presentation.md#sidecarfullscreen) +- [SidecarFullscreenForPopups](kui_shell_core.Presentation.md#sidecarfullscreenforpopups) +- [SidecarThin](kui_shell_core.Presentation.md#sidecarthin) + +## Enumeration members + +### Default + +• **Default** = `0` + +#### Defined in + +[packages/core/src/webapp/views/presentation.ts:32](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/presentation.ts#L32) + +--- + +### FixedSize + +• **FixedSize** = `1` + +#### Defined in + +[packages/core/src/webapp/views/presentation.ts:33](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/presentation.ts#L33) + +--- + +### SidecarFullscreen + +• **SidecarFullscreen** = `3` + +#### Defined in + +[packages/core/src/webapp/views/presentation.ts:35](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/presentation.ts#L35) + +--- + +### SidecarFullscreenForPopups + +• **SidecarFullscreenForPopups** = `4` + +#### Defined in + +[packages/core/src/webapp/views/presentation.ts:36](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/presentation.ts#L36) + +--- + +### SidecarThin + +• **SidecarThin** = `2` + +#### Defined in + +[packages/core/src/webapp/views/presentation.ts:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/presentation.ts#L34) diff --git a/docs/api/enums/kui_shell_core.TableStyle.md b/docs/api/enums/kui_shell_core.TableStyle.md new file mode 100644 index 00000000000..fdde7c95667 --- /dev/null +++ b/docs/api/enums/kui_shell_core.TableStyle.md @@ -0,0 +1,43 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / TableStyle + +# Enumeration: TableStyle + +[@kui-shell/core](../modules/kui_shell_core.md).TableStyle + +## Table of contents + +### Enumeration members + +- [Heavy](kui_shell_core.TableStyle.md#heavy) +- [Light](kui_shell_core.TableStyle.md#light) +- [Medium](kui_shell_core.TableStyle.md#medium) + +## Enumeration members + +### Heavy + +• **Heavy** = `2` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:136](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L136) + +--- + +### Light + +• **Light** = `0` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:134](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L134) + +--- + +### Medium + +• **Medium** = `1` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:135](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L135) diff --git a/docs/api/enums/kui_shell_plugin_kubectl.TrafficLight.md b/docs/api/enums/kui_shell_plugin_kubectl.TrafficLight.md new file mode 100644 index 00000000000..161819ef413 --- /dev/null +++ b/docs/api/enums/kui_shell_plugin_kubectl.TrafficLight.md @@ -0,0 +1,67 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / TrafficLight + +# Enumeration: TrafficLight + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).TrafficLight + +A rollup of State to "traffic light" model + +## Table of contents + +### Enumeration members + +- [Blue](kui_shell_plugin_kubectl.TrafficLight.md#blue) +- [Gray](kui_shell_plugin_kubectl.TrafficLight.md#gray) +- [Green](kui_shell_plugin_kubectl.TrafficLight.md#green) +- [Red](kui_shell_plugin_kubectl.TrafficLight.md#red) +- [Yellow](kui_shell_plugin_kubectl.TrafficLight.md#yellow) + +## Enumeration members + +### Blue + +• **Blue** = `"blue-background"` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/traffic-light.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/traffic-light.ts#L25) + +--- + +### Gray + +• **Gray** = `"gray-background"` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/traffic-light.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/traffic-light.ts#L22) + +--- + +### Green + +• **Green** = `"green-background"` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/traffic-light.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/traffic-light.ts#L26) + +--- + +### Red + +• **Red** = `"red-background"` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/traffic-light.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/traffic-light.ts#L23) + +--- + +### Yellow + +• **Yellow** = `"yellow-background"` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/traffic-light.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/traffic-light.ts#L24) diff --git a/docs/api/interfaces/kui_shell_core.Abortable.md b/docs/api/interfaces/kui_shell_core.Abortable.md new file mode 100644 index 00000000000..6f05e3e02db --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Abortable.md @@ -0,0 +1,25 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Abortable + +# Interface: Abortable + +[@kui-shell/core](../modules/kui_shell_core.md).Abortable + +## Table of contents + +### Methods + +- [abort](kui_shell_core.Abortable.md#abort) + +## Methods + +### abort + +▸ **abort**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/job.ts:18](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/job.ts#L18) diff --git a/docs/api/interfaces/kui_shell_core.Arguments.md b/docs/api/interfaces/kui_shell_core.Arguments.md new file mode 100644 index 00000000000..3e36017d461 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Arguments.md @@ -0,0 +1,215 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Arguments + +# Interface: Arguments + +[@kui-shell/core](../modules/kui_shell_core.md).Arguments + +The full set of data passed to a command handler + +## Type parameters + +| Name | Type | +| :-------- | :------------------------------------------------- | +| `Options` | [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +## Hierarchy + +- [`CommandLine`](kui_shell_core.CommandLine.md)<`Options`\> + + ↳ **`Arguments`** + +## Table of contents + +### Properties + +- [REPL](kui_shell_core.Arguments.md#repl) +- [argv](kui_shell_core.Arguments.md#argv) +- [argvNoOptions](kui_shell_core.Arguments.md#argvnooptions) +- [block](kui_shell_core.Arguments.md#block) +- [command](kui_shell_core.Arguments.md#command) +- [createErrorStream](kui_shell_core.Arguments.md#createerrorstream) +- [createOutputStream](kui_shell_core.Arguments.md#createoutputstream) +- [execOptions](kui_shell_core.Arguments.md#execoptions) +- [nextBlock](kui_shell_core.Arguments.md#nextblock) +- [parsedOptions](kui_shell_core.Arguments.md#parsedoptions) +- [pipeStages](kui_shell_core.Arguments.md#pipestages) +- [tab](kui_shell_core.Arguments.md#tab) + +## Properties + +### REPL + +• **REPL**: [`REPL`](kui_shell_core.REPL.md) + +#### Defined in + +[packages/core/src/models/command.ts:180](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L180) + +--- + +### argv + +• **argv**: `string`[] + +the result of a whitespace split applied to the `command` string +that pays attention to backslash escaping and quotations + +#### Inherited from + +[CommandLine](kui_shell_core.CommandLine.md).[argv](kui_shell_core.CommandLine.md#argv) + +#### Defined in + +[packages/core/src/models/command.ts:146](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L146) + +--- + +### argvNoOptions + +• **argvNoOptions**: `string`[] + +the residual of `argv` without `parsedOptions` + +#### Inherited from + +[CommandLine](kui_shell_core.CommandLine.md).[argvNoOptions](kui_shell_core.CommandLine.md#argvnooptions) + +#### Defined in + +[packages/core/src/models/command.ts:151](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L151) + +--- + +### block + +• **block**: `boolean` \| [`Block`](kui_shell_core.Block.md) + +EXPERT MODE: The REPL block in which this command was initiated +(rarely used, but useful for more complex UI extensions) + +#### Defined in + +[packages/core/src/models/command.ts:204](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L204) + +--- + +### command + +• **command**: `string` + +the raw command string, as given by the user + +#### Inherited from + +[CommandLine](kui_shell_core.CommandLine.md).[command](kui_shell_core.CommandLine.md#command) + +#### Defined in + +[packages/core/src/models/command.ts:141](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L141) + +--- + +### createErrorStream + +• **createErrorStream**: `StreamableFactory` + +Same as createOutputStream, but for stderr + +#### Defined in + +[packages/core/src/models/command.ts:198](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L198) + +--- + +### createOutputStream + +• **createOutputStream**: `StreamableFactory` + +Commands can use this to stream output to the UI, rather than +using the normal request-response interaction between the REPL +and the command. + +#### Defined in + +[packages/core/src/models/command.ts:193](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L193) + +--- + +### execOptions + +• **execOptions**: [`ExecOptions`](kui_shell_core.ExecOptions.md) + +Optional command channel options that one command can use to +influence the execution of another. + +#### Defined in + +[packages/core/src/models/command.ts:186](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L186) + +--- + +### nextBlock + +• **nextBlock**: `HTMLElement` + +EXPERT MODE: The REPL block that will house the _subsequent_ +command execution (rarely used, but useful for more complex UI +extensions) + +#### Defined in + +[packages/core/src/models/command.ts:211](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L211) + +--- + +### parsedOptions + +• **parsedOptions**: `Options` + +the dash options parsed out in a way that pays attention to n-ary +options such as `--option key value` + +#### Inherited from + +[CommandLine](kui_shell_core.CommandLine.md).[parsedOptions](kui_shell_core.CommandLine.md#parsedoptions) + +#### Defined in + +[packages/core/src/models/command.ts:167](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L167) + +--- + +### pipeStages + +• **pipeStages**: `Object` + +pipeline stages, e.g. if command='a b --foo|c', the pipeStages=[['a','b, '--foo'],'c'] + +#### Type declaration + +| Name | Type | +| :------------ | :----------------------------------------------- | +| `prefix?` | `string` | +| `redirect?` | `string` | +| `redirector?` | `">"` \| `">>"` \| `"2>&1"` \| `">&"` \| `">>&"` | +| `stages` | `string`[][] | + +#### Inherited from + +[CommandLine](kui_shell_core.CommandLine.md).[pipeStages](kui_shell_core.CommandLine.md#pipestages) + +#### Defined in + +[packages/core/src/models/command.ts:156](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L156) + +--- + +### tab + +• **tab**: [`Tab`](kui_shell_core.Tab.md) + +The tab context in which the command was initiated + +#### Defined in + +[packages/core/src/models/command.ts:178](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L178) diff --git a/docs/api/interfaces/kui_shell_core.BadgeRegistration.md b/docs/api/interfaces/kui_shell_core.BadgeRegistration.md new file mode 100644 index 00000000000..bba7779821f --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.BadgeRegistration.md @@ -0,0 +1,41 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / BadgeRegistration + +# Interface: BadgeRegistration + +[@kui-shell/core](../modules/kui_shell_core.md).BadgeRegistration + +Interpretation: if the resource passes the given "when" filter, +then add the given sidecar badge + +## Type parameters + +| Name | Type | +| :--------- | :----------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](kui_shell_core.ResourceWithMetadata.md) | + +## Table of contents + +### Properties + +- [badge](kui_shell_core.BadgeRegistration.md#badge) +- [when](kui_shell_core.BadgeRegistration.md#when) + +## Properties + +### badge + +• **badge**: [`BadgeSpec`](kui_shell_core.BadgeSpec.md) \| (`resource`: `Resource`, `tab`: [`Tab`](kui_shell_core.Tab.md)) => [`BadgeSpec`](kui_shell_core.BadgeSpec.md) + +#### Defined in + +[packages/core/src/webapp/views/registrar/badges.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/badges.ts#L44) + +--- + +### when + +• **when**: [`ModeFilter`](../modules/kui_shell_core.md#modefilter)<`Resource`\> + +#### Defined in + +[packages/core/src/webapp/views/registrar/badges.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/badges.ts#L43) diff --git a/docs/api/interfaces/kui_shell_core.BadgeSpec.md b/docs/api/interfaces/kui_shell_core.BadgeSpec.md new file mode 100644 index 00000000000..b7e911d809a --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.BadgeSpec.md @@ -0,0 +1,76 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / BadgeSpec + +# Interface: BadgeSpec + +[@kui-shell/core](../modules/kui_shell_core.md).BadgeSpec + +This is the most complete form of a badge specification, allowing +the caller to provide a title, an onclick handler, and an optional +fontawesome icon representation. + +## Table of contents + +### Properties + +- [css](kui_shell_core.BadgeSpec.md#css) +- [fontawesome](kui_shell_core.BadgeSpec.md#fontawesome) +- [image](kui_shell_core.BadgeSpec.md#image) +- [title](kui_shell_core.BadgeSpec.md#title) + +### Methods + +- [onclick](kui_shell_core.BadgeSpec.md#onclick) + +## Properties + +### css + +• `Optional` **css**: `string` + +#### Defined in + +[packages/core/src/webapp/views/registrar/badges.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/badges.ts#L31) + +--- + +### fontawesome + +• `Optional` **fontawesome**: `string` + +#### Defined in + +[packages/core/src/webapp/views/registrar/badges.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/badges.ts#L29) + +--- + +### image + +• `Optional` **image**: `HTMLImageElement` \| `SVGElement` + +#### Defined in + +[packages/core/src/webapp/views/registrar/badges.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/badges.ts#L30) + +--- + +### title + +• **title**: `string` + +#### Defined in + +[packages/core/src/webapp/views/registrar/badges.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/badges.ts#L28) + +## Methods + +### onclick + +▸ `Optional` **onclick**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/views/registrar/badges.ts:32](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/badges.ts#L32) diff --git a/docs/api/interfaces/kui_shell_core.Block.md b/docs/api/interfaces/kui_shell_core.Block.md new file mode 100644 index 00000000000..92cb869cf9b --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Block.md @@ -0,0 +1,6215 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Block + +# Interface: Block + +[@kui-shell/core](../modules/kui_shell_core.md).Block + +## Hierarchy + +- `HTMLElement` + + ↳ **`Block`** + +## Table of contents + +### Properties + +- [ATTRIBUTE_NODE](kui_shell_core.Block.md#attribute_node) +- [CDATA_SECTION_NODE](kui_shell_core.Block.md#cdata_section_node) +- [COMMENT_NODE](kui_shell_core.Block.md#comment_node) +- [DOCUMENT_FRAGMENT_NODE](kui_shell_core.Block.md#document_fragment_node) +- [DOCUMENT_NODE](kui_shell_core.Block.md#document_node) +- [DOCUMENT_POSITION_CONTAINED_BY](kui_shell_core.Block.md#document_position_contained_by) +- [DOCUMENT_POSITION_CONTAINS](kui_shell_core.Block.md#document_position_contains) +- [DOCUMENT_POSITION_DISCONNECTED](kui_shell_core.Block.md#document_position_disconnected) +- [DOCUMENT_POSITION_FOLLOWING](kui_shell_core.Block.md#document_position_following) +- [DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC](kui_shell_core.Block.md#document_position_implementation_specific) +- [DOCUMENT_POSITION_PRECEDING](kui_shell_core.Block.md#document_position_preceding) +- [DOCUMENT_TYPE_NODE](kui_shell_core.Block.md#document_type_node) +- [ELEMENT_NODE](kui_shell_core.Block.md#element_node) +- [ENTITY_NODE](kui_shell_core.Block.md#entity_node) +- [ENTITY_REFERENCE_NODE](kui_shell_core.Block.md#entity_reference_node) +- [NOTATION_NODE](kui_shell_core.Block.md#notation_node) +- [PROCESSING_INSTRUCTION_NODE](kui_shell_core.Block.md#processing_instruction_node) +- [TEXT_NODE](kui_shell_core.Block.md#text_node) +- [accessKey](kui_shell_core.Block.md#accesskey) +- [accessKeyLabel](kui_shell_core.Block.md#accesskeylabel) +- [assignedSlot](kui_shell_core.Block.md#assignedslot) +- [attributes](kui_shell_core.Block.md#attributes) +- [autocapitalize](kui_shell_core.Block.md#autocapitalize) +- [autofocus](kui_shell_core.Block.md#autofocus) +- [baseURI](kui_shell_core.Block.md#baseuri) +- [childElementCount](kui_shell_core.Block.md#childelementcount) +- [childNodes](kui_shell_core.Block.md#childnodes) +- [children](kui_shell_core.Block.md#children) +- [classList](kui_shell_core.Block.md#classlist) +- [className](kui_shell_core.Block.md#classname) +- [clientHeight](kui_shell_core.Block.md#clientheight) +- [clientLeft](kui_shell_core.Block.md#clientleft) +- [clientTop](kui_shell_core.Block.md#clienttop) +- [clientWidth](kui_shell_core.Block.md#clientwidth) +- [contentEditable](kui_shell_core.Block.md#contenteditable) +- [dataset](kui_shell_core.Block.md#dataset) +- [dir](kui_shell_core.Block.md#dir) +- [draggable](kui_shell_core.Block.md#draggable) +- [enterKeyHint](kui_shell_core.Block.md#enterkeyhint) +- [firstChild](kui_shell_core.Block.md#firstchild) +- [firstElementChild](kui_shell_core.Block.md#firstelementchild) +- [hidden](kui_shell_core.Block.md#hidden) +- [id](kui_shell_core.Block.md#id) +- [innerHTML](kui_shell_core.Block.md#innerhtml) +- [innerText](kui_shell_core.Block.md#innertext) +- [inputMode](kui_shell_core.Block.md#inputmode) +- [isCancelled](kui_shell_core.Block.md#iscancelled) +- [isConnected](kui_shell_core.Block.md#isconnected) +- [isContentEditable](kui_shell_core.Block.md#iscontenteditable) +- [lang](kui_shell_core.Block.md#lang) +- [lastChild](kui_shell_core.Block.md#lastchild) +- [lastElementChild](kui_shell_core.Block.md#lastelementchild) +- [localName](kui_shell_core.Block.md#localname) +- [namespaceURI](kui_shell_core.Block.md#namespaceuri) +- [nextElementSibling](kui_shell_core.Block.md#nextelementsibling) +- [nextSibling](kui_shell_core.Block.md#nextsibling) +- [nodeName](kui_shell_core.Block.md#nodename) +- [nodeType](kui_shell_core.Block.md#nodetype) +- [nodeValue](kui_shell_core.Block.md#nodevalue) +- [nonce](kui_shell_core.Block.md#nonce) +- [offsetHeight](kui_shell_core.Block.md#offsetheight) +- [offsetLeft](kui_shell_core.Block.md#offsetleft) +- [offsetParent](kui_shell_core.Block.md#offsetparent) +- [offsetTop](kui_shell_core.Block.md#offsettop) +- [offsetWidth](kui_shell_core.Block.md#offsetwidth) +- [onabort](kui_shell_core.Block.md#onabort) +- [onanimationcancel](kui_shell_core.Block.md#onanimationcancel) +- [onanimationend](kui_shell_core.Block.md#onanimationend) +- [onanimationiteration](kui_shell_core.Block.md#onanimationiteration) +- [onanimationstart](kui_shell_core.Block.md#onanimationstart) +- [onauxclick](kui_shell_core.Block.md#onauxclick) +- [onblur](kui_shell_core.Block.md#onblur) +- [oncancel](kui_shell_core.Block.md#oncancel) +- [oncanplay](kui_shell_core.Block.md#oncanplay) +- [oncanplaythrough](kui_shell_core.Block.md#oncanplaythrough) +- [onchange](kui_shell_core.Block.md#onchange) +- [onclick](kui_shell_core.Block.md#onclick) +- [onclose](kui_shell_core.Block.md#onclose) +- [oncontextmenu](kui_shell_core.Block.md#oncontextmenu) +- [oncopy](kui_shell_core.Block.md#oncopy) +- [oncuechange](kui_shell_core.Block.md#oncuechange) +- [oncut](kui_shell_core.Block.md#oncut) +- [ondblclick](kui_shell_core.Block.md#ondblclick) +- [ondrag](kui_shell_core.Block.md#ondrag) +- [ondragend](kui_shell_core.Block.md#ondragend) +- [ondragenter](kui_shell_core.Block.md#ondragenter) +- [ondragexit](kui_shell_core.Block.md#ondragexit) +- [ondragleave](kui_shell_core.Block.md#ondragleave) +- [ondragover](kui_shell_core.Block.md#ondragover) +- [ondragstart](kui_shell_core.Block.md#ondragstart) +- [ondrop](kui_shell_core.Block.md#ondrop) +- [ondurationchange](kui_shell_core.Block.md#ondurationchange) +- [onemptied](kui_shell_core.Block.md#onemptied) +- [onended](kui_shell_core.Block.md#onended) +- [onerror](kui_shell_core.Block.md#onerror) +- [onfocus](kui_shell_core.Block.md#onfocus) +- [onfullscreenchange](kui_shell_core.Block.md#onfullscreenchange) +- [onfullscreenerror](kui_shell_core.Block.md#onfullscreenerror) +- [ongotpointercapture](kui_shell_core.Block.md#ongotpointercapture) +- [oninput](kui_shell_core.Block.md#oninput) +- [oninvalid](kui_shell_core.Block.md#oninvalid) +- [onkeydown](kui_shell_core.Block.md#onkeydown) +- [onkeypress](kui_shell_core.Block.md#onkeypress) +- [onkeyup](kui_shell_core.Block.md#onkeyup) +- [onload](kui_shell_core.Block.md#onload) +- [onloadeddata](kui_shell_core.Block.md#onloadeddata) +- [onloadedmetadata](kui_shell_core.Block.md#onloadedmetadata) +- [onloadstart](kui_shell_core.Block.md#onloadstart) +- [onlostpointercapture](kui_shell_core.Block.md#onlostpointercapture) +- [onmousedown](kui_shell_core.Block.md#onmousedown) +- [onmouseenter](kui_shell_core.Block.md#onmouseenter) +- [onmouseleave](kui_shell_core.Block.md#onmouseleave) +- [onmousemove](kui_shell_core.Block.md#onmousemove) +- [onmouseout](kui_shell_core.Block.md#onmouseout) +- [onmouseover](kui_shell_core.Block.md#onmouseover) +- [onmouseup](kui_shell_core.Block.md#onmouseup) +- [onpaste](kui_shell_core.Block.md#onpaste) +- [onpause](kui_shell_core.Block.md#onpause) +- [onplay](kui_shell_core.Block.md#onplay) +- [onplaying](kui_shell_core.Block.md#onplaying) +- [onpointercancel](kui_shell_core.Block.md#onpointercancel) +- [onpointerdown](kui_shell_core.Block.md#onpointerdown) +- [onpointerenter](kui_shell_core.Block.md#onpointerenter) +- [onpointerleave](kui_shell_core.Block.md#onpointerleave) +- [onpointermove](kui_shell_core.Block.md#onpointermove) +- [onpointerout](kui_shell_core.Block.md#onpointerout) +- [onpointerover](kui_shell_core.Block.md#onpointerover) +- [onpointerup](kui_shell_core.Block.md#onpointerup) +- [onprogress](kui_shell_core.Block.md#onprogress) +- [onratechange](kui_shell_core.Block.md#onratechange) +- [onreset](kui_shell_core.Block.md#onreset) +- [onresize](kui_shell_core.Block.md#onresize) +- [onscroll](kui_shell_core.Block.md#onscroll) +- [onsecuritypolicyviolation](kui_shell_core.Block.md#onsecuritypolicyviolation) +- [onseeked](kui_shell_core.Block.md#onseeked) +- [onseeking](kui_shell_core.Block.md#onseeking) +- [onselect](kui_shell_core.Block.md#onselect) +- [onselectionchange](kui_shell_core.Block.md#onselectionchange) +- [onselectstart](kui_shell_core.Block.md#onselectstart) +- [onstalled](kui_shell_core.Block.md#onstalled) +- [onsubmit](kui_shell_core.Block.md#onsubmit) +- [onsuspend](kui_shell_core.Block.md#onsuspend) +- [ontimeupdate](kui_shell_core.Block.md#ontimeupdate) +- [ontoggle](kui_shell_core.Block.md#ontoggle) +- [ontouchcancel](kui_shell_core.Block.md#ontouchcancel) +- [ontouchend](kui_shell_core.Block.md#ontouchend) +- [ontouchmove](kui_shell_core.Block.md#ontouchmove) +- [ontouchstart](kui_shell_core.Block.md#ontouchstart) +- [ontransitioncancel](kui_shell_core.Block.md#ontransitioncancel) +- [ontransitionend](kui_shell_core.Block.md#ontransitionend) +- [ontransitionrun](kui_shell_core.Block.md#ontransitionrun) +- [ontransitionstart](kui_shell_core.Block.md#ontransitionstart) +- [onvolumechange](kui_shell_core.Block.md#onvolumechange) +- [onwaiting](kui_shell_core.Block.md#onwaiting) +- [onwheel](kui_shell_core.Block.md#onwheel) +- [outerHTML](kui_shell_core.Block.md#outerhtml) +- [ownerDocument](kui_shell_core.Block.md#ownerdocument) +- [parentElement](kui_shell_core.Block.md#parentelement) +- [parentNode](kui_shell_core.Block.md#parentnode) +- [prefix](kui_shell_core.Block.md#prefix) +- [previousElementSibling](kui_shell_core.Block.md#previouselementsibling) +- [previousSibling](kui_shell_core.Block.md#previoussibling) +- [scrollHeight](kui_shell_core.Block.md#scrollheight) +- [scrollLeft](kui_shell_core.Block.md#scrollleft) +- [scrollTop](kui_shell_core.Block.md#scrolltop) +- [scrollWidth](kui_shell_core.Block.md#scrollwidth) +- [shadowRoot](kui_shell_core.Block.md#shadowroot) +- [slot](kui_shell_core.Block.md#slot) +- [spellcheck](kui_shell_core.Block.md#spellcheck) +- [style](kui_shell_core.Block.md#style) +- [tabIndex](kui_shell_core.Block.md#tabindex) +- [tagName](kui_shell_core.Block.md#tagname) +- [textContent](kui_shell_core.Block.md#textcontent) +- [title](kui_shell_core.Block.md#title) +- [translate](kui_shell_core.Block.md#translate) + +### Methods + +- [addEventListener](kui_shell_core.Block.md#addeventlistener) +- [after](kui_shell_core.Block.md#after) +- [animate](kui_shell_core.Block.md#animate) +- [append](kui_shell_core.Block.md#append) +- [appendChild](kui_shell_core.Block.md#appendchild) +- [attachShadow](kui_shell_core.Block.md#attachshadow) +- [before](kui_shell_core.Block.md#before) +- [blur](kui_shell_core.Block.md#blur) +- [click](kui_shell_core.Block.md#click) +- [cloneNode](kui_shell_core.Block.md#clonenode) +- [closest](kui_shell_core.Block.md#closest) +- [compareDocumentPosition](kui_shell_core.Block.md#comparedocumentposition) +- [contains](kui_shell_core.Block.md#contains) +- [dispatchEvent](kui_shell_core.Block.md#dispatchevent) +- [focus](kui_shell_core.Block.md#focus) +- [getAnimations](kui_shell_core.Block.md#getanimations) +- [getAttribute](kui_shell_core.Block.md#getattribute) +- [getAttributeNS](kui_shell_core.Block.md#getattributens) +- [getAttributeNames](kui_shell_core.Block.md#getattributenames) +- [getAttributeNode](kui_shell_core.Block.md#getattributenode) +- [getAttributeNodeNS](kui_shell_core.Block.md#getattributenodens) +- [getBoundingClientRect](kui_shell_core.Block.md#getboundingclientrect) +- [getClientRects](kui_shell_core.Block.md#getclientrects) +- [getElementsByClassName](kui_shell_core.Block.md#getelementsbyclassname) +- [getElementsByTagName](kui_shell_core.Block.md#getelementsbytagname) +- [getElementsByTagNameNS](kui_shell_core.Block.md#getelementsbytagnamens) +- [getRootNode](kui_shell_core.Block.md#getrootnode) +- [hasAttribute](kui_shell_core.Block.md#hasattribute) +- [hasAttributeNS](kui_shell_core.Block.md#hasattributens) +- [hasAttributes](kui_shell_core.Block.md#hasattributes) +- [hasChildNodes](kui_shell_core.Block.md#haschildnodes) +- [hasPointerCapture](kui_shell_core.Block.md#haspointercapture) +- [insertAdjacentElement](kui_shell_core.Block.md#insertadjacentelement) +- [insertAdjacentHTML](kui_shell_core.Block.md#insertadjacenthtml) +- [insertAdjacentText](kui_shell_core.Block.md#insertadjacenttext) +- [insertBefore](kui_shell_core.Block.md#insertbefore) +- [isDefaultNamespace](kui_shell_core.Block.md#isdefaultnamespace) +- [isEqualNode](kui_shell_core.Block.md#isequalnode) +- [isSameNode](kui_shell_core.Block.md#issamenode) +- [lookupNamespaceURI](kui_shell_core.Block.md#lookupnamespaceuri) +- [lookupPrefix](kui_shell_core.Block.md#lookupprefix) +- [matches](kui_shell_core.Block.md#matches) +- [msGetRegionContent](kui_shell_core.Block.md#msgetregioncontent) +- [normalize](kui_shell_core.Block.md#normalize) +- [prepend](kui_shell_core.Block.md#prepend) +- [querySelector](kui_shell_core.Block.md#queryselector) +- [querySelectorAll](kui_shell_core.Block.md#queryselectorall) +- [releasePointerCapture](kui_shell_core.Block.md#releasepointercapture) +- [remove](kui_shell_core.Block.md#remove) +- [removeAttribute](kui_shell_core.Block.md#removeattribute) +- [removeAttributeNS](kui_shell_core.Block.md#removeattributens) +- [removeAttributeNode](kui_shell_core.Block.md#removeattributenode) +- [removeChild](kui_shell_core.Block.md#removechild) +- [removeEventListener](kui_shell_core.Block.md#removeeventlistener) +- [replaceChild](kui_shell_core.Block.md#replacechild) +- [replaceWith](kui_shell_core.Block.md#replacewith) +- [requestFullscreen](kui_shell_core.Block.md#requestfullscreen) +- [requestPointerLock](kui_shell_core.Block.md#requestpointerlock) +- [scroll](kui_shell_core.Block.md#scroll) +- [scrollBy](kui_shell_core.Block.md#scrollby) +- [scrollIntoView](kui_shell_core.Block.md#scrollintoview) +- [scrollTo](kui_shell_core.Block.md#scrollto) +- [setAttribute](kui_shell_core.Block.md#setattribute) +- [setAttributeNS](kui_shell_core.Block.md#setattributens) +- [setAttributeNode](kui_shell_core.Block.md#setattributenode) +- [setAttributeNodeNS](kui_shell_core.Block.md#setattributenodens) +- [setPointerCapture](kui_shell_core.Block.md#setpointercapture) +- [toggleAttribute](kui_shell_core.Block.md#toggleattribute) +- [webkitMatchesSelector](kui_shell_core.Block.md#webkitmatchesselector) + +## Properties + +### ATTRIBUTE_NODE + +• `Readonly` **ATTRIBUTE_NODE**: `number` + +#### Inherited from + +HTMLElement.ATTRIBUTE_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10762 + +--- + +### CDATA_SECTION_NODE + +• `Readonly` **CDATA_SECTION_NODE**: `number` + +node is a CDATASection node. + +#### Inherited from + +HTMLElement.CDATA_SECTION_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10766 + +--- + +### COMMENT_NODE + +• `Readonly` **COMMENT_NODE**: `number` + +node is a Comment node. + +#### Inherited from + +HTMLElement.COMMENT_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10770 + +--- + +### DOCUMENT_FRAGMENT_NODE + +• `Readonly` **DOCUMENT_FRAGMENT_NODE**: `number` + +node is a DocumentFragment node. + +#### Inherited from + +HTMLElement.DOCUMENT_FRAGMENT_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10774 + +--- + +### DOCUMENT_NODE + +• `Readonly` **DOCUMENT_NODE**: `number` + +node is a document. + +#### Inherited from + +HTMLElement.DOCUMENT_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10778 + +--- + +### DOCUMENT_POSITION_CONTAINED_BY + +• `Readonly` **DOCUMENT_POSITION_CONTAINED_BY**: `number` + +Set when other is a descendant of node. + +#### Inherited from + +HTMLElement.DOCUMENT_POSITION_CONTAINED_BY + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10782 + +--- + +### DOCUMENT_POSITION_CONTAINS + +• `Readonly` **DOCUMENT_POSITION_CONTAINS**: `number` + +Set when other is an ancestor of node. + +#### Inherited from + +HTMLElement.DOCUMENT_POSITION_CONTAINS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10786 + +--- + +### DOCUMENT_POSITION_DISCONNECTED + +• `Readonly` **DOCUMENT_POSITION_DISCONNECTED**: `number` + +Set when node and other are not in the same tree. + +#### Inherited from + +HTMLElement.DOCUMENT_POSITION_DISCONNECTED + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10790 + +--- + +### DOCUMENT_POSITION_FOLLOWING + +• `Readonly` **DOCUMENT_POSITION_FOLLOWING**: `number` + +Set when other is following node. + +#### Inherited from + +HTMLElement.DOCUMENT_POSITION_FOLLOWING + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10794 + +--- + +### DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC + +• `Readonly` **DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC**: `number` + +#### Inherited from + +HTMLElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10795 + +--- + +### DOCUMENT_POSITION_PRECEDING + +• `Readonly` **DOCUMENT_POSITION_PRECEDING**: `number` + +Set when other is preceding node. + +#### Inherited from + +HTMLElement.DOCUMENT_POSITION_PRECEDING + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10799 + +--- + +### DOCUMENT_TYPE_NODE + +• `Readonly` **DOCUMENT_TYPE_NODE**: `number` + +node is a doctype. + +#### Inherited from + +HTMLElement.DOCUMENT_TYPE_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10803 + +--- + +### ELEMENT_NODE + +• `Readonly` **ELEMENT_NODE**: `number` + +node is an element. + +#### Inherited from + +HTMLElement.ELEMENT_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10807 + +--- + +### ENTITY_NODE + +• `Readonly` **ENTITY_NODE**: `number` + +#### Inherited from + +HTMLElement.ENTITY_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10808 + +--- + +### ENTITY_REFERENCE_NODE + +• `Readonly` **ENTITY_REFERENCE_NODE**: `number` + +#### Inherited from + +HTMLElement.ENTITY_REFERENCE_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10809 + +--- + +### NOTATION_NODE + +• `Readonly` **NOTATION_NODE**: `number` + +#### Inherited from + +HTMLElement.NOTATION_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10810 + +--- + +### PROCESSING_INSTRUCTION_NODE + +• `Readonly` **PROCESSING_INSTRUCTION_NODE**: `number` + +node is a ProcessingInstruction node. + +#### Inherited from + +HTMLElement.PROCESSING_INSTRUCTION_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10814 + +--- + +### TEXT_NODE + +• `Readonly` **TEXT_NODE**: `number` + +node is a Text node. + +#### Inherited from + +HTMLElement.TEXT_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10818 + +--- + +### accessKey + +• **accessKey**: `string` + +#### Inherited from + +HTMLElement.accessKey + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6592 + +--- + +### accessKeyLabel + +• `Readonly` **accessKeyLabel**: `string` + +#### Inherited from + +HTMLElement.accessKeyLabel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6593 + +--- + +### assignedSlot + +• `Readonly` **assignedSlot**: `HTMLSlotElement` + +#### Inherited from + +HTMLElement.assignedSlot + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:14832 + +--- + +### attributes + +• `Readonly` **attributes**: `NamedNodeMap` + +#### Inherited from + +HTMLElement.attributes + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5095 + +--- + +### autocapitalize + +• **autocapitalize**: `string` + +#### Inherited from + +HTMLElement.autocapitalize + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6594 + +--- + +### autofocus + +• **autofocus**: `boolean` + +#### Inherited from + +HTMLElement.autofocus + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8006 + +--- + +### baseURI + +• `Readonly` **baseURI**: `string` + +Returns node's node document's document base URL. + +#### Inherited from + +HTMLElement.baseURI + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10677 + +--- + +### childElementCount + +• `Readonly` **childElementCount**: `number` + +#### Inherited from + +HTMLElement.childElementCount + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11233 + +--- + +### childNodes + +• `Readonly` **childNodes**: `NodeListOf`<`ChildNode`\> + +Returns the children. + +#### Inherited from + +HTMLElement.childNodes + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10681 + +--- + +### children + +• `Readonly` **children**: `HTMLCollection` + +Returns the child elements. + +#### Inherited from + +HTMLElement.children + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11237 + +--- + +### classList + +• `Readonly` **classList**: `DOMTokenList` + +Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object. + +#### Inherited from + +HTMLElement.classList + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5099 + +--- + +### className + +• **className**: `string` + +Returns the value of element's class content attribute. Can be set to change it. + +#### Inherited from + +HTMLElement.className + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5103 + +--- + +### clientHeight + +• `Readonly` **clientHeight**: `number` + +#### Inherited from + +HTMLElement.clientHeight + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5104 + +--- + +### clientLeft + +• `Readonly` **clientLeft**: `number` + +#### Inherited from + +HTMLElement.clientLeft + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5105 + +--- + +### clientTop + +• `Readonly` **clientTop**: `number` + +#### Inherited from + +HTMLElement.clientTop + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5106 + +--- + +### clientWidth + +• `Readonly` **clientWidth**: `number` + +#### Inherited from + +HTMLElement.clientWidth + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5107 + +--- + +### contentEditable + +• **contentEditable**: `string` + +#### Inherited from + +HTMLElement.contentEditable + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5259 + +--- + +### dataset + +• `Readonly` **dataset**: `DOMStringMap` + +#### Inherited from + +HTMLElement.dataset + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8007 + +--- + +### dir + +• **dir**: `string` + +#### Inherited from + +HTMLElement.dir + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6595 + +--- + +### draggable + +• **draggable**: `boolean` + +#### Inherited from + +HTMLElement.draggable + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6596 + +--- + +### enterKeyHint + +• **enterKeyHint**: `string` + +#### Inherited from + +HTMLElement.enterKeyHint + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5260 + +--- + +### firstChild + +• `Readonly` **firstChild**: `ChildNode` + +Returns the first child. + +#### Inherited from + +HTMLElement.firstChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10685 + +--- + +### firstElementChild + +• `Readonly` **firstElementChild**: `Element` + +Returns the first child that is an element, and null otherwise. + +#### Inherited from + +HTMLElement.firstElementChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11241 + +--- + +### hidden + +• **hidden**: `boolean` + +#### Inherited from + +HTMLElement.hidden + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6597 + +--- + +### id + +• **id**: `string` + +Returns the value of element's id content attribute. Can be set to change it. + +#### Inherited from + +HTMLElement.id + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5111 + +--- + +### innerHTML + +• **innerHTML**: `string` + +#### Inherited from + +HTMLElement.innerHTML + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:9588 + +--- + +### innerText + +• **innerText**: `string` + +#### Inherited from + +HTMLElement.innerText + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6598 + +--- + +### inputMode + +• **inputMode**: `string` + +#### Inherited from + +HTMLElement.inputMode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5261 + +--- + +### isCancelled + +• `Optional` **isCancelled**: `boolean` + +#### Defined in + +[packages/core/src/webapp/models/block.ts:18](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/block.ts#L18) + +--- + +### isConnected + +• `Readonly` **isConnected**: `boolean` + +Returns true if node is connected and false otherwise. + +#### Inherited from + +HTMLElement.isConnected + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10689 + +--- + +### isContentEditable + +• `Readonly` **isContentEditable**: `boolean` + +#### Inherited from + +HTMLElement.isContentEditable + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5262 + +--- + +### lang + +• **lang**: `string` + +#### Inherited from + +HTMLElement.lang + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6599 + +--- + +### lastChild + +• `Readonly` **lastChild**: `ChildNode` + +Returns the last child. + +#### Inherited from + +HTMLElement.lastChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10693 + +--- + +### lastElementChild + +• `Readonly` **lastElementChild**: `Element` + +Returns the last child that is an element, and null otherwise. + +#### Inherited from + +HTMLElement.lastElementChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11245 + +--- + +### localName + +• `Readonly` **localName**: `string` + +Returns the local name. + +#### Inherited from + +HTMLElement.localName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5115 + +--- + +### namespaceURI + +• `Readonly` **namespaceURI**: `string` + +Returns the namespace. + +#### Inherited from + +HTMLElement.namespaceURI + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5119 + +--- + +### nextElementSibling + +• `Readonly` **nextElementSibling**: `Element` + +Returns the first following sibling that is an element, and null otherwise. + +#### Inherited from + +HTMLElement.nextElementSibling + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10963 + +--- + +### nextSibling + +• `Readonly` **nextSibling**: `ChildNode` + +Returns the next sibling. + +#### Inherited from + +HTMLElement.nextSibling + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10699 + +--- + +### nodeName + +• `Readonly` **nodeName**: `string` + +Returns a string appropriate for the type of node. + +#### Inherited from + +HTMLElement.nodeName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10703 + +--- + +### nodeType + +• `Readonly` **nodeType**: `number` + +Returns the type of node. + +#### Inherited from + +HTMLElement.nodeType + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10707 + +--- + +### nodeValue + +• **nodeValue**: `string` + +#### Inherited from + +HTMLElement.nodeValue + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10708 + +--- + +### nonce + +• `Optional` **nonce**: `string` + +#### Inherited from + +HTMLElement.nonce + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8008 + +--- + +### offsetHeight + +• `Readonly` **offsetHeight**: `number` + +#### Inherited from + +HTMLElement.offsetHeight + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6600 + +--- + +### offsetLeft + +• `Readonly` **offsetLeft**: `number` + +#### Inherited from + +HTMLElement.offsetLeft + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6601 + +--- + +### offsetParent + +• `Readonly` **offsetParent**: `Element` + +#### Inherited from + +HTMLElement.offsetParent + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6602 + +--- + +### offsetTop + +• `Readonly` **offsetTop**: `number` + +#### Inherited from + +HTMLElement.offsetTop + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6603 + +--- + +### offsetWidth + +• `Readonly` **offsetWidth**: `number` + +#### Inherited from + +HTMLElement.offsetWidth + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6604 + +--- + +### onabort + +• **onabort**: (`ev`: `UIEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user aborts the download. + +##### Parameters + +| Name | Type | Description | +| :--- | :-------- | :---------- | +| `ev` | `UIEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onabort + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5805 + +--- + +### onanimationcancel + +• **onanimationcancel**: (`ev`: `AnimationEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `AnimationEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onanimationcancel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5806 + +--- + +### onanimationend + +• **onanimationend**: (`ev`: `AnimationEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `AnimationEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onanimationend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5807 + +--- + +### onanimationiteration + +• **onanimationiteration**: (`ev`: `AnimationEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `AnimationEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onanimationiteration + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5808 + +--- + +### onanimationstart + +• **onanimationstart**: (`ev`: `AnimationEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `AnimationEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onanimationstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5809 + +--- + +### onauxclick + +• **onauxclick**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `MouseEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onauxclick + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5810 + +--- + +### onblur + +• **onblur**: (`ev`: `FocusEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the object loses the input focus. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `FocusEvent` | The focus event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onblur + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5815 + +--- + +### oncancel + +• **oncancel**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.oncancel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5816 + +--- + +### oncanplay + +• **oncanplay**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when playback is possible, but would require further buffering. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.oncanplay + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5821 + +--- + +### oncanplaythrough + +• **oncanplaythrough**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.oncanplaythrough + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5822 + +--- + +### onchange + +• **onchange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the contents of the object or selection have changed. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onchange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5827 + +--- + +### onclick + +• **onclick**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user clicks the left mouse button on the object + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onclick + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5832 + +--- + +### onclose + +• **onclose**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onclose + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5833 + +--- + +### oncontextmenu + +• **oncontextmenu**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user clicks the right mouse button in the client area, opening the context menu. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.oncontextmenu + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5838 + +--- + +### oncopy + +• **oncopy**: (`ev`: `ClipboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `ClipboardEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.oncopy + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:4899 + +--- + +### oncuechange + +• **oncuechange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.oncuechange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5839 + +--- + +### oncut + +• **oncut**: (`ev`: `ClipboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `ClipboardEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.oncut + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:4900 + +--- + +### ondblclick + +• **ondblclick**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user double-clicks the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ondblclick + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5844 + +--- + +### ondrag + +• **ondrag**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the source object continuously during a drag operation. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :---------- | +| `ev` | `DragEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ondrag + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5849 + +--- + +### ondragend + +• **ondragend**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the source object when the user releases the mouse at the close of a drag operation. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :---------- | +| `ev` | `DragEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ondragend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5854 + +--- + +### ondragenter + +• **ondragenter**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the target element when the user drags the object to a valid drop target. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :-------------- | +| `ev` | `DragEvent` | The drag event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ondragenter + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5859 + +--- + +### ondragexit + +• **ondragexit**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ondragexit + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5860 + +--- + +### ondragleave + +• **ondragleave**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :-------------- | +| `ev` | `DragEvent` | The drag event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ondragleave + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5865 + +--- + +### ondragover + +• **ondragover**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the target element continuously while the user drags the object over a valid drop target. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :---------- | +| `ev` | `DragEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ondragover + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5870 + +--- + +### ondragstart + +• **ondragstart**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the source object when the user starts to drag a text selection or selected object. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :---------- | +| `ev` | `DragEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ondragstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5875 + +--- + +### ondrop + +• **ondrop**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :---------- | +| `ev` | `DragEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ondrop + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5876 + +--- + +### ondurationchange + +• **ondurationchange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the duration attribute is updated. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ondurationchange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5881 + +--- + +### onemptied + +• **onemptied**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the media element is reset to its initial state. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onemptied + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5886 + +--- + +### onended + +• **onended**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the end of playback is reached. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onended + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5891 + +--- + +### onerror + +• **onerror**: `OnErrorEventHandlerNonNull` + +Fires when an error occurs during object loading. + +**`param`** The event. + +#### Inherited from + +HTMLElement.onerror + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5896 + +--- + +### onfocus + +• **onfocus**: (`ev`: `FocusEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the object receives focus. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :---------- | +| `ev` | `FocusEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onfocus + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5901 + +--- + +### onfullscreenchange + +• **onfullscreenchange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onfullscreenchange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5120 + +--- + +### onfullscreenerror + +• **onfullscreenerror**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onfullscreenerror + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5121 + +--- + +### ongotpointercapture + +• **ongotpointercapture**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ongotpointercapture + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5902 + +--- + +### oninput + +• **oninput**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.oninput + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5903 + +--- + +### oninvalid + +• **oninvalid**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.oninvalid + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5904 + +--- + +### onkeydown + +• **onkeydown**: (`ev`: `KeyboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user presses a key. + +##### Parameters + +| Name | Type | Description | +| :--- | :-------------- | :----------------- | +| `ev` | `KeyboardEvent` | The keyboard event | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onkeydown + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5909 + +--- + +### onkeypress + +• **onkeypress**: (`ev`: `KeyboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user presses an alphanumeric key. + +##### Parameters + +| Name | Type | Description | +| :--- | :-------------- | :---------- | +| `ev` | `KeyboardEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onkeypress + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5914 + +--- + +### onkeyup + +• **onkeyup**: (`ev`: `KeyboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user releases a key. + +##### Parameters + +| Name | Type | Description | +| :--- | :-------------- | :----------------- | +| `ev` | `KeyboardEvent` | The keyboard event | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onkeyup + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5919 + +--- + +### onload + +• **onload**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires immediately after the browser loads the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onload + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5924 + +--- + +### onloadeddata + +• **onloadeddata**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when media data is loaded at the current playback position. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onloadeddata + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5929 + +--- + +### onloadedmetadata + +• **onloadedmetadata**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the duration and dimensions of the media have been determined. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onloadedmetadata + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5934 + +--- + +### onloadstart + +• **onloadstart**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when Internet Explorer begins looking for media data. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onloadstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5939 + +--- + +### onlostpointercapture + +• **onlostpointercapture**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onlostpointercapture + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5940 + +--- + +### onmousedown + +• **onmousedown**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user clicks the object with either mouse button. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onmousedown + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5945 + +--- + +### onmouseenter + +• **onmouseenter**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `MouseEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onmouseenter + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5946 + +--- + +### onmouseleave + +• **onmouseleave**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `MouseEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onmouseleave + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5947 + +--- + +### onmousemove + +• **onmousemove**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user moves the mouse over the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onmousemove + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5952 + +--- + +### onmouseout + +• **onmouseout**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user moves the mouse pointer outside the boundaries of the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onmouseout + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5957 + +--- + +### onmouseover + +• **onmouseover**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user moves the mouse pointer into the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onmouseover + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5962 + +--- + +### onmouseup + +• **onmouseup**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user releases a mouse button while the mouse is over the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onmouseup + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5967 + +--- + +### onpaste + +• **onpaste**: (`ev`: `ClipboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `ClipboardEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onpaste + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:4901 + +--- + +### onpause + +• **onpause**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when playback is paused. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onpause + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5972 + +--- + +### onplay + +• **onplay**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the play method is requested. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onplay + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5977 + +--- + +### onplaying + +• **onplaying**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the audio or video has started playing. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onplaying + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5982 + +--- + +### onpointercancel + +• **onpointercancel**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onpointercancel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5983 + +--- + +### onpointerdown + +• **onpointerdown**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onpointerdown + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5984 + +--- + +### onpointerenter + +• **onpointerenter**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onpointerenter + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5985 + +--- + +### onpointerleave + +• **onpointerleave**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onpointerleave + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5986 + +--- + +### onpointermove + +• **onpointermove**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onpointermove + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5987 + +--- + +### onpointerout + +• **onpointerout**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onpointerout + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5988 + +--- + +### onpointerover + +• **onpointerover**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onpointerover + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5989 + +--- + +### onpointerup + +• **onpointerup**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onpointerup + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5990 + +--- + +### onprogress + +• **onprogress**: (`ev`: `ProgressEvent`<`EventTarget`\>) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs to indicate progress while downloading media data. + +##### Parameters + +| Name | Type | Description | +| :--- | :------------------------------ | :---------- | +| `ev` | `ProgressEvent`<`EventTarget`\> | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onprogress + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5995 + +--- + +### onratechange + +• **onratechange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the playback rate is increased or decreased. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onratechange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6000 + +--- + +### onreset + +• **onreset**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user resets a form. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onreset + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6005 + +--- + +### onresize + +• **onresize**: (`ev`: `UIEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :-------- | +| `ev` | `UIEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onresize + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6006 + +--- + +### onscroll + +• **onscroll**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user repositions the scroll box in the scroll bar on the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onscroll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6011 + +--- + +### onsecuritypolicyviolation + +• **onsecuritypolicyviolation**: (`ev`: `SecurityPolicyViolationEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------------------------- | +| `ev` | `SecurityPolicyViolationEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onsecuritypolicyviolation + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6012 + +--- + +### onseeked + +• **onseeked**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the seek operation ends. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onseeked + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6017 + +--- + +### onseeking + +• **onseeking**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the current playback position is moved. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onseeking + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6022 + +--- + +### onselect + +• **onselect**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the current selection changes. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onselect + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6027 + +--- + +### onselectionchange + +• **onselectionchange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onselectionchange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6028 + +--- + +### onselectstart + +• **onselectstart**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onselectstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6029 + +--- + +### onstalled + +• **onstalled**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the download has stopped. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onstalled + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6034 + +--- + +### onsubmit + +• **onsubmit**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onsubmit + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6035 + +--- + +### onsuspend + +• **onsuspend**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs if the load operation has been intentionally halted. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onsuspend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6040 + +--- + +### ontimeupdate + +• **ontimeupdate**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs to indicate the current playback position. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ontimeupdate + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6045 + +--- + +### ontoggle + +• **ontoggle**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ontoggle + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6046 + +--- + +### ontouchcancel + +• `Optional` **ontouchcancel**: (`ev`: `TouchEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `TouchEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ontouchcancel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6047 + +--- + +### ontouchend + +• `Optional` **ontouchend**: (`ev`: `TouchEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `TouchEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ontouchend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6048 + +--- + +### ontouchmove + +• `Optional` **ontouchmove**: (`ev`: `TouchEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `TouchEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ontouchmove + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6049 + +--- + +### ontouchstart + +• `Optional` **ontouchstart**: (`ev`: `TouchEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `TouchEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ontouchstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6050 + +--- + +### ontransitioncancel + +• **ontransitioncancel**: (`ev`: `TransitionEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :---------------- | +| `ev` | `TransitionEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ontransitioncancel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6051 + +--- + +### ontransitionend + +• **ontransitionend**: (`ev`: `TransitionEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :---------------- | +| `ev` | `TransitionEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ontransitionend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6052 + +--- + +### ontransitionrun + +• **ontransitionrun**: (`ev`: `TransitionEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :---------------- | +| `ev` | `TransitionEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ontransitionrun + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6053 + +--- + +### ontransitionstart + +• **ontransitionstart**: (`ev`: `TransitionEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :---------------- | +| `ev` | `TransitionEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.ontransitionstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6054 + +--- + +### onvolumechange + +• **onvolumechange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the volume is changed, or playback is muted or unmuted. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onvolumechange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6059 + +--- + +### onwaiting + +• **onwaiting**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when playback stops because the next frame of a video resource is not available. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onwaiting + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6064 + +--- + +### onwheel + +• **onwheel**: (`ev`: `WheelEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `WheelEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLElement.onwheel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6065 + +--- + +### outerHTML + +• **outerHTML**: `string` + +#### Inherited from + +HTMLElement.outerHTML + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5122 + +--- + +### ownerDocument + +• `Readonly` **ownerDocument**: `Document` + +#### Inherited from + +HTMLElement.ownerDocument + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5123 + +--- + +### parentElement + +• `Readonly` **parentElement**: `HTMLElement` + +Returns the parent element. + +#### Inherited from + +HTMLElement.parentElement + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10716 + +--- + +### parentNode + +• `Readonly` **parentNode**: `Node` & `ParentNode` + +Returns the parent. + +#### Inherited from + +HTMLElement.parentNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10720 + +--- + +### prefix + +• `Readonly` **prefix**: `string` + +Returns the namespace prefix. + +#### Inherited from + +HTMLElement.prefix + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5127 + +--- + +### previousElementSibling + +• `Readonly` **previousElementSibling**: `Element` + +Returns the first preceding sibling that is an element, and null otherwise. + +#### Inherited from + +HTMLElement.previousElementSibling + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10967 + +--- + +### previousSibling + +• `Readonly` **previousSibling**: `ChildNode` + +Returns the previous sibling. + +#### Inherited from + +HTMLElement.previousSibling + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10724 + +--- + +### scrollHeight + +• `Readonly` **scrollHeight**: `number` + +#### Inherited from + +HTMLElement.scrollHeight + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5128 + +--- + +### scrollLeft + +• **scrollLeft**: `number` + +#### Inherited from + +HTMLElement.scrollLeft + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5129 + +--- + +### scrollTop + +• **scrollTop**: `number` + +#### Inherited from + +HTMLElement.scrollTop + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5130 + +--- + +### scrollWidth + +• `Readonly` **scrollWidth**: `number` + +#### Inherited from + +HTMLElement.scrollWidth + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5131 + +--- + +### shadowRoot + +• `Readonly` **shadowRoot**: `ShadowRoot` + +Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise. + +#### Inherited from + +HTMLElement.shadowRoot + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5135 + +--- + +### slot + +• **slot**: `string` + +Returns the value of element's slot content attribute. Can be set to change it. + +#### Inherited from + +HTMLElement.slot + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5139 + +--- + +### spellcheck + +• **spellcheck**: `boolean` + +#### Inherited from + +HTMLElement.spellcheck + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6605 + +--- + +### style + +• `Readonly` **style**: `CSSStyleDeclaration` + +#### Inherited from + +HTMLElement.style + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5255 + +--- + +### tabIndex + +• **tabIndex**: `number` + +#### Inherited from + +HTMLElement.tabIndex + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8009 + +--- + +### tagName + +• `Readonly` **tagName**: `string` + +Returns the HTML-uppercased qualified name. + +#### Inherited from + +HTMLElement.tagName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5143 + +--- + +### textContent + +• **textContent**: `string` + +#### Inherited from + +HTMLElement.textContent + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10725 + +--- + +### title + +• **title**: `string` + +#### Inherited from + +HTMLElement.title + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6606 + +--- + +### translate + +• **translate**: `boolean` + +#### Inherited from + +HTMLElement.translate + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6607 + +## Methods + +### addEventListener + +▸ **addEventListener**<`K`\>(`type`, `listener`, `options?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------- | +| `K` | extends keyof `HTMLElementEventMap` | + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------ | +| `type` | `K` | +| `listener` | (`ev`: `HTMLElementEventMap`[`K`]) => `any` | +| `options?` | `boolean` \| `AddEventListenerOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.addEventListener + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6609 + +▸ **addEventListener**(`type`, `listener`, `options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------- | +| `type` | `string` | +| `listener` | `EventListenerOrEventListenerObject` | +| `options?` | `boolean` \| `AddEventListenerOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.addEventListener + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6610 + +--- + +### after + +▸ **after**(...`nodes`): `void` + +Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------- | +| `...nodes` | (`string` \| `Node`)[] | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.after + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:3537 + +--- + +### animate + +▸ **animate**(`keyframes`, `options?`): `Animation` + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------- | +| `keyframes` | `Keyframe`[] \| `PropertyIndexedKeyframes` | +| `options?` | `number` \| `KeyframeAnimationOptions` | + +#### Returns + +`Animation` + +#### Inherited from + +HTMLElement.animate + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:2073 + +--- + +### append + +▸ **append**(...`nodes`): `void` + +Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------- | +| `...nodes` | (`string` \| `Node`)[] | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.append + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11251 + +--- + +### appendChild + +▸ **appendChild**<`T`\>(`newChild`): `T` + +#### Type parameters + +| Name | Type | +| :--- | :------------- | +| `T` | extends `Node` | + +#### Parameters + +| Name | Type | +| :--------- | :--- | +| `newChild` | `T` | + +#### Returns + +`T` + +#### Inherited from + +HTMLElement.appendChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10726 + +--- + +### attachShadow + +▸ **attachShadow**(`init`): `ShadowRoot` + +Creates a shadow root for element and returns it. + +#### Parameters + +| Name | Type | +| :----- | :--------------- | +| `init` | `ShadowRootInit` | + +#### Returns + +`ShadowRoot` + +#### Inherited from + +HTMLElement.attachShadow + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5147 + +--- + +### before + +▸ **before**(...`nodes`): `void` + +Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------- | +| `...nodes` | (`string` \| `Node`)[] | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.before + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:3543 + +--- + +### blur + +▸ **blur**(): `void` + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.blur + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8010 + +--- + +### click + +▸ **click**(): `void` + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.click + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6608 + +--- + +### cloneNode + +▸ **cloneNode**(`deep?`): `Node` + +Returns a copy of node. If deep is true, the copy also includes the node's descendants. + +#### Parameters + +| Name | Type | +| :------ | :-------- | +| `deep?` | `boolean` | + +#### Returns + +`Node` + +#### Inherited from + +HTMLElement.cloneNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10730 + +--- + +### closest + +▸ **closest**<`K`\>(`selector`): `HTMLElementTagNameMap`[`K`] + +Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise. + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------ | +| `K` | extends keyof `HTMLElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :--------- | :--- | +| `selector` | `K` | + +#### Returns + +`HTMLElementTagNameMap`[`K`] + +#### Inherited from + +HTMLElement.closest + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5151 + +▸ **closest**<`K`\>(`selector`): `SVGElementTagNameMap`[`K`] + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------- | +| `K` | extends keyof `SVGElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :--------- | :--- | +| `selector` | `K` | + +#### Returns + +`SVGElementTagNameMap`[`K`] + +#### Inherited from + +HTMLElement.closest + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5152 + +▸ **closest**<`E`\>(`selector`): `E` + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------- | +| `E` | extends ` Element``Element ` | + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `selector` | `string` | + +#### Returns + +`E` + +#### Inherited from + +HTMLElement.closest + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5153 + +--- + +### compareDocumentPosition + +▸ **compareDocumentPosition**(`other`): `number` + +Returns a bitmask indicating the position of other relative to node. + +#### Parameters + +| Name | Type | +| :------ | :----- | +| `other` | `Node` | + +#### Returns + +`number` + +#### Inherited from + +HTMLElement.compareDocumentPosition + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10734 + +--- + +### contains + +▸ **contains**(`other`): `boolean` + +Returns true if other is an inclusive descendant of node, and false otherwise. + +#### Parameters + +| Name | Type | +| :------ | :----- | +| `other` | `Node` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.contains + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10738 + +--- + +### dispatchEvent + +▸ **dispatchEvent**(`event`): `boolean` + +Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `Event` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.dispatchEvent + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5423 + +--- + +### focus + +▸ **focus**(`options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :------------- | +| `options?` | `FocusOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.focus + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8011 + +--- + +### getAnimations + +▸ **getAnimations**(): `Animation`[] + +#### Returns + +`Animation`[] + +#### Inherited from + +HTMLElement.getAnimations + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:2074 + +--- + +### getAttribute + +▸ **getAttribute**(`qualifiedName`): `string` + +Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise. + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | + +#### Returns + +`string` + +#### Inherited from + +HTMLElement.getAttribute + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5157 + +--- + +### getAttributeNS + +▸ **getAttributeNS**(`namespace`, `localName`): `string` + +Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise. + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | +| `localName` | `string` | + +#### Returns + +`string` + +#### Inherited from + +HTMLElement.getAttributeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5161 + +--- + +### getAttributeNames + +▸ **getAttributeNames**(): `string`[] + +Returns the qualified names of all element's attributes. Can contain duplicates. + +#### Returns + +`string`[] + +#### Inherited from + +HTMLElement.getAttributeNames + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5165 + +--- + +### getAttributeNode + +▸ **getAttributeNode**(`qualifiedName`): `Attr` + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | + +#### Returns + +`Attr` + +#### Inherited from + +HTMLElement.getAttributeNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5166 + +--- + +### getAttributeNodeNS + +▸ **getAttributeNodeNS**(`namespace`, `localName`): `Attr` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | +| `localName` | `string` | + +#### Returns + +`Attr` + +#### Inherited from + +HTMLElement.getAttributeNodeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5167 + +--- + +### getBoundingClientRect + +▸ **getBoundingClientRect**(): `DOMRect` + +#### Returns + +`DOMRect` + +#### Inherited from + +HTMLElement.getBoundingClientRect + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5168 + +--- + +### getClientRects + +▸ **getClientRects**(): `DOMRectList` + +#### Returns + +`DOMRectList` + +#### Inherited from + +HTMLElement.getClientRects + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5169 + +--- + +### getElementsByClassName + +▸ **getElementsByClassName**(`classNames`): `HTMLCollectionOf`<`Element`\> + +Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes. + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `classNames` | `string` | + +#### Returns + +`HTMLCollectionOf`<`Element`\> + +#### Inherited from + +HTMLElement.getElementsByClassName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5173 + +--- + +### getElementsByTagName + +▸ **getElementsByTagName**<`K`\>(`qualifiedName`): `HTMLCollectionOf`<`HTMLElementTagNameMap`[`K`]\> + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------ | +| `K` | extends keyof `HTMLElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :-------------- | :--- | +| `qualifiedName` | `K` | + +#### Returns + +`HTMLCollectionOf`<`HTMLElementTagNameMap`[`K`]\> + +#### Inherited from + +HTMLElement.getElementsByTagName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5174 + +▸ **getElementsByTagName**<`K`\>(`qualifiedName`): `HTMLCollectionOf`<`SVGElementTagNameMap`[`K`]\> + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------- | +| `K` | extends keyof `SVGElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :-------------- | :--- | +| `qualifiedName` | `K` | + +#### Returns + +`HTMLCollectionOf`<`SVGElementTagNameMap`[`K`]\> + +#### Inherited from + +HTMLElement.getElementsByTagName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5175 + +▸ **getElementsByTagName**(`qualifiedName`): `HTMLCollectionOf`<`Element`\> + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | + +#### Returns + +`HTMLCollectionOf`<`Element`\> + +#### Inherited from + +HTMLElement.getElementsByTagName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5176 + +--- + +### getElementsByTagNameNS + +▸ **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`<`HTMLElement`\> + +#### Parameters + +| Name | Type | +| :------------- | :------------------------------- | +| `namespaceURI` | `"http://www.w3.org/1999/xhtml"` | +| `localName` | `string` | + +#### Returns + +`HTMLCollectionOf`<`HTMLElement`\> + +#### Inherited from + +HTMLElement.getElementsByTagNameNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5177 + +▸ **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`<`SVGElement`\> + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------- | +| `namespaceURI` | `"http://www.w3.org/2000/svg"` | +| `localName` | `string` | + +#### Returns + +`HTMLCollectionOf`<`SVGElement`\> + +#### Inherited from + +HTMLElement.getElementsByTagNameNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5178 + +▸ **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`<`Element`\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `namespaceURI` | `string` | +| `localName` | `string` | + +#### Returns + +`HTMLCollectionOf`<`Element`\> + +#### Inherited from + +HTMLElement.getElementsByTagNameNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5179 + +--- + +### getRootNode + +▸ **getRootNode**(`options?`): `Node` + +Returns node's root. + +#### Parameters + +| Name | Type | +| :--------- | :------------------- | +| `options?` | `GetRootNodeOptions` | + +#### Returns + +`Node` + +#### Inherited from + +HTMLElement.getRootNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10742 + +--- + +### hasAttribute + +▸ **hasAttribute**(`qualifiedName`): `boolean` + +Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise. + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.hasAttribute + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5183 + +--- + +### hasAttributeNS + +▸ **hasAttributeNS**(`namespace`, `localName`): `boolean` + +Returns true if element has an attribute whose namespace is namespace and local name is localName. + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | +| `localName` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.hasAttributeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5187 + +--- + +### hasAttributes + +▸ **hasAttributes**(): `boolean` + +Returns true if element has attributes, and false otherwise. + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.hasAttributes + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5191 + +--- + +### hasChildNodes + +▸ **hasChildNodes**(): `boolean` + +Returns whether node has children. + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.hasChildNodes + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10746 + +--- + +### hasPointerCapture + +▸ **hasPointerCapture**(`pointerId`): `boolean` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `pointerId` | `number` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.hasPointerCapture + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5192 + +--- + +### insertAdjacentElement + +▸ **insertAdjacentElement**(`position`, `insertedElement`): `Element` + +#### Parameters + +| Name | Type | +| :---------------- | :--------------- | +| `position` | `InsertPosition` | +| `insertedElement` | `Element` | + +#### Returns + +`Element` + +#### Inherited from + +HTMLElement.insertAdjacentElement + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5193 + +--- + +### insertAdjacentHTML + +▸ **insertAdjacentHTML**(`where`, `html`): `void` + +#### Parameters + +| Name | Type | +| :------ | :--------------- | +| `where` | `InsertPosition` | +| `html` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.insertAdjacentHTML + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5194 + +--- + +### insertAdjacentText + +▸ **insertAdjacentText**(`where`, `text`): `void` + +#### Parameters + +| Name | Type | +| :------ | :--------------- | +| `where` | `InsertPosition` | +| `text` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.insertAdjacentText + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5195 + +--- + +### insertBefore + +▸ **insertBefore**<`T`\>(`newChild`, `refChild`): `T` + +#### Type parameters + +| Name | Type | +| :--- | :------------- | +| `T` | extends `Node` | + +#### Parameters + +| Name | Type | +| :--------- | :----- | +| `newChild` | `T` | +| `refChild` | `Node` | + +#### Returns + +`T` + +#### Inherited from + +HTMLElement.insertBefore + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10747 + +--- + +### isDefaultNamespace + +▸ **isDefaultNamespace**(`namespace`): `boolean` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.isDefaultNamespace + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10748 + +--- + +### isEqualNode + +▸ **isEqualNode**(`otherNode`): `boolean` + +Returns whether node and otherNode have the same properties. + +#### Parameters + +| Name | Type | +| :---------- | :----- | +| `otherNode` | `Node` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.isEqualNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10752 + +--- + +### isSameNode + +▸ **isSameNode**(`otherNode`): `boolean` + +#### Parameters + +| Name | Type | +| :---------- | :----- | +| `otherNode` | `Node` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.isSameNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10753 + +--- + +### lookupNamespaceURI + +▸ **lookupNamespaceURI**(`prefix`): `string` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `prefix` | `string` | + +#### Returns + +`string` + +#### Inherited from + +HTMLElement.lookupNamespaceURI + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10754 + +--- + +### lookupPrefix + +▸ **lookupPrefix**(`namespace`): `string` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | + +#### Returns + +`string` + +#### Inherited from + +HTMLElement.lookupPrefix + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10755 + +--- + +### matches + +▸ **matches**(`selectors`): `boolean` + +Returns true if matching selectors against element's root yields element, and false otherwise. + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `selectors` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.matches + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5199 + +--- + +### msGetRegionContent + +▸ **msGetRegionContent**(): `any` + +#### Returns + +`any` + +#### Inherited from + +HTMLElement.msGetRegionContent + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5200 + +--- + +### normalize + +▸ **normalize**(): `void` + +Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes. + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.normalize + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10759 + +--- + +### prepend + +▸ **prepend**(...`nodes`): `void` + +Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------- | +| `...nodes` | (`string` \| `Node`)[] | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.prepend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11257 + +--- + +### querySelector + +▸ **querySelector**<`K`\>(`selectors`): `HTMLElementTagNameMap`[`K`] + +Returns the first element that is a descendant of node that matches selectors. + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------ | +| `K` | extends keyof `HTMLElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :---------- | :--- | +| `selectors` | `K` | + +#### Returns + +`HTMLElementTagNameMap`[`K`] + +#### Inherited from + +HTMLElement.querySelector + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11261 + +▸ **querySelector**<`K`\>(`selectors`): `SVGElementTagNameMap`[`K`] + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------- | +| `K` | extends keyof `SVGElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :---------- | :--- | +| `selectors` | `K` | + +#### Returns + +`SVGElementTagNameMap`[`K`] + +#### Inherited from + +HTMLElement.querySelector + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11262 + +▸ **querySelector**<`E`\>(`selectors`): `E` + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------- | +| `E` | extends ` Element``Element ` | + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `selectors` | `string` | + +#### Returns + +`E` + +#### Inherited from + +HTMLElement.querySelector + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11263 + +--- + +### querySelectorAll + +▸ **querySelectorAll**<`K`\>(`selectors`): `NodeListOf`<`HTMLElementTagNameMap`[`K`]\> + +Returns all element descendants of node that match selectors. + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------ | +| `K` | extends keyof `HTMLElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :---------- | :--- | +| `selectors` | `K` | + +#### Returns + +`NodeListOf`<`HTMLElementTagNameMap`[`K`]\> + +#### Inherited from + +HTMLElement.querySelectorAll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11267 + +▸ **querySelectorAll**<`K`\>(`selectors`): `NodeListOf`<`SVGElementTagNameMap`[`K`]\> + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------- | +| `K` | extends keyof `SVGElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :---------- | :--- | +| `selectors` | `K` | + +#### Returns + +`NodeListOf`<`SVGElementTagNameMap`[`K`]\> + +#### Inherited from + +HTMLElement.querySelectorAll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11268 + +▸ **querySelectorAll**<`E`\>(`selectors`): `NodeListOf`<`E`\> + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------- | +| `E` | extends ` Element``Element ` | + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `selectors` | `string` | + +#### Returns + +`NodeListOf`<`E`\> + +#### Inherited from + +HTMLElement.querySelectorAll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11269 + +--- + +### releasePointerCapture + +▸ **releasePointerCapture**(`pointerId`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `pointerId` | `number` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.releasePointerCapture + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5201 + +--- + +### remove + +▸ **remove**(): `void` + +Removes node. + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.remove + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:3547 + +--- + +### removeAttribute + +▸ **removeAttribute**(`qualifiedName`): `void` + +Removes element's first attribute whose qualified name is qualifiedName. + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.removeAttribute + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5205 + +--- + +### removeAttributeNS + +▸ **removeAttributeNS**(`namespace`, `localName`): `void` + +Removes element's attribute whose namespace is namespace and local name is localName. + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | +| `localName` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.removeAttributeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5209 + +--- + +### removeAttributeNode + +▸ **removeAttributeNode**(`attr`): `Attr` + +#### Parameters + +| Name | Type | +| :----- | :----- | +| `attr` | `Attr` | + +#### Returns + +`Attr` + +#### Inherited from + +HTMLElement.removeAttributeNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5210 + +--- + +### removeChild + +▸ **removeChild**<`T`\>(`oldChild`): `T` + +#### Type parameters + +| Name | Type | +| :--- | :------------- | +| `T` | extends `Node` | + +#### Parameters + +| Name | Type | +| :--------- | :--- | +| `oldChild` | `T` | + +#### Returns + +`T` + +#### Inherited from + +HTMLElement.removeChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10760 + +--- + +### removeEventListener + +▸ **removeEventListener**<`K`\>(`type`, `listener`, `options?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------- | +| `K` | extends keyof `HTMLElementEventMap` | + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------ | +| `type` | `K` | +| `listener` | (`ev`: `HTMLElementEventMap`[`K`]) => `any` | +| `options?` | `boolean` \| `EventListenerOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.removeEventListener + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6611 + +▸ **removeEventListener**(`type`, `listener`, `options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------- | +| `type` | `string` | +| `listener` | `EventListenerOrEventListenerObject` | +| `options?` | `boolean` \| `EventListenerOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.removeEventListener + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6612 + +--- + +### replaceChild + +▸ **replaceChild**<`T`\>(`newChild`, `oldChild`): `T` + +#### Type parameters + +| Name | Type | +| :--- | :------------- | +| `T` | extends `Node` | + +#### Parameters + +| Name | Type | +| :--------- | :----- | +| `newChild` | `Node` | +| `oldChild` | `T` | + +#### Returns + +`T` + +#### Inherited from + +HTMLElement.replaceChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10761 + +--- + +### replaceWith + +▸ **replaceWith**(...`nodes`): `void` + +Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------- | +| `...nodes` | (`string` \| `Node`)[] | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.replaceWith + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:3553 + +--- + +### requestFullscreen + +▸ **requestFullscreen**(`options?`): `Promise`<`void`\> + +Displays element fullscreen and resolves promise when done. + +When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference. + +#### Parameters + +| Name | Type | +| :--------- | :------------------ | +| `options?` | `FullscreenOptions` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +HTMLElement.requestFullscreen + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5216 + +--- + +### requestPointerLock + +▸ **requestPointerLock**(): `void` + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.requestPointerLock + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5217 + +--- + +### scroll + +▸ **scroll**(`options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :---------------- | +| `options?` | `ScrollToOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.scroll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5218 + +▸ **scroll**(`x`, `y`): `void` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `x` | `number` | +| `y` | `number` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.scroll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5219 + +--- + +### scrollBy + +▸ **scrollBy**(`options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :---------------- | +| `options?` | `ScrollToOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.scrollBy + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5220 + +▸ **scrollBy**(`x`, `y`): `void` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `x` | `number` | +| `y` | `number` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.scrollBy + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5221 + +--- + +### scrollIntoView + +▸ **scrollIntoView**(`arg?`): `void` + +#### Parameters + +| Name | Type | +| :----- | :----------------------------------- | +| `arg?` | `boolean` \| `ScrollIntoViewOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.scrollIntoView + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5222 + +--- + +### scrollTo + +▸ **scrollTo**(`options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :---------------- | +| `options?` | `ScrollToOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.scrollTo + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5223 + +▸ **scrollTo**(`x`, `y`): `void` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `x` | `number` | +| `y` | `number` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.scrollTo + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5224 + +--- + +### setAttribute + +▸ **setAttribute**(`qualifiedName`, `value`): `void` + +Sets the value of element's first attribute whose qualified name is qualifiedName to value. + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.setAttribute + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5228 + +--- + +### setAttributeNS + +▸ **setAttributeNS**(`namespace`, `qualifiedName`, `value`): `void` + +Sets the value of element's attribute whose namespace is namespace and local name is localName to value. + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `namespace` | `string` | +| `qualifiedName` | `string` | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.setAttributeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5232 + +--- + +### setAttributeNode + +▸ **setAttributeNode**(`attr`): `Attr` + +#### Parameters + +| Name | Type | +| :----- | :----- | +| `attr` | `Attr` | + +#### Returns + +`Attr` + +#### Inherited from + +HTMLElement.setAttributeNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5233 + +--- + +### setAttributeNodeNS + +▸ **setAttributeNodeNS**(`attr`): `Attr` + +#### Parameters + +| Name | Type | +| :----- | :----- | +| `attr` | `Attr` | + +#### Returns + +`Attr` + +#### Inherited from + +HTMLElement.setAttributeNodeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5234 + +--- + +### setPointerCapture + +▸ **setPointerCapture**(`pointerId`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `pointerId` | `number` | + +#### Returns + +`void` + +#### Inherited from + +HTMLElement.setPointerCapture + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5235 + +--- + +### toggleAttribute + +▸ **toggleAttribute**(`qualifiedName`, `force?`): `boolean` + +If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. + +Returns true if qualifiedName is now present, and false otherwise. + +#### Parameters + +| Name | Type | +| :-------------- | :-------- | +| `qualifiedName` | `string` | +| `force?` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.toggleAttribute + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5241 + +--- + +### webkitMatchesSelector + +▸ **webkitMatchesSelector**(`selectors`): `boolean` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `selectors` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLElement.webkitMatchesSelector + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5242 diff --git a/docs/api/interfaces/kui_shell_core.Breadcrumb.md b/docs/api/interfaces/kui_shell_core.Breadcrumb.md new file mode 100644 index 00000000000..dcc46b355ea --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Breadcrumb.md @@ -0,0 +1,32 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Breadcrumb + +# Interface: Breadcrumb + +[@kui-shell/core](../modules/kui_shell_core.md).Breadcrumb + +## Table of contents + +### Properties + +- [command](kui_shell_core.Breadcrumb.md#command) +- [label](kui_shell_core.Breadcrumb.md#label) + +## Properties + +### command + +• `Optional` **command**: `string` + +#### Defined in + +[packages/core/src/models/NavResponse.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/NavResponse.ts#L22) + +--- + +### label + +• **label**: `string` + +#### Defined in + +[packages/core/src/models/NavResponse.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/NavResponse.ts#L21) diff --git a/docs/api/interfaces/kui_shell_core.CodedError.md b/docs/api/interfaces/kui_shell_core.CodedError.md new file mode 100644 index 00000000000..7afa7bc56c3 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.CodedError.md @@ -0,0 +1,126 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / CodedError + +# Interface: CodedError + +[@kui-shell/core](../modules/kui_shell_core.md).CodedError + +## Type parameters + +| Name | Type | +| :----- | :------- | +| `Code` | `number` | + +## Hierarchy + +- `Error` + + ↳ **`CodedError`** + +## Implemented by + +- [`UsageError`](../classes/kui_shell_core.UsageError.md) + +## Table of contents + +### Properties + +- [body](kui_shell_core.CodedError.md#body) +- [code](kui_shell_core.CodedError.md#code) +- [hide](kui_shell_core.CodedError.md#hide) +- [message](kui_shell_core.CodedError.md#message) +- [name](kui_shell_core.CodedError.md#name) +- [partialMatches](kui_shell_core.CodedError.md#partialmatches) +- [stack](kui_shell_core.CodedError.md#stack) +- [statusCode](kui_shell_core.CodedError.md#statuscode) + +## Properties + +### body + +• `Optional` **body**: `string` \| `Record`<`string`, `any`\> + +#### Defined in + +[packages/core/src/models/errors.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/errors.ts#L25) + +--- + +### code + +• `Optional` **code**: `Code` + +#### Defined in + +[packages/core/src/models/errors.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/errors.ts#L21) + +--- + +### hide + +• `Optional` **hide**: `boolean` + +#### Defined in + +[packages/core/src/models/errors.ts:20](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/errors.ts#L20) + +--- + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:974 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:973 + +--- + +### partialMatches + +• `Optional` **partialMatches**: [`UsageRow`](kui_shell_core.UsageRow.md)[] + +#### Defined in + +[packages/core/src/models/errors.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/errors.ts#L23) + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:975 + +--- + +### statusCode + +• `Optional` **statusCode**: `number` + +#### Defined in + +[packages/core/src/models/errors.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/errors.ts#L22) diff --git a/docs/api/interfaces/kui_shell_core.CommandCompleteEvent.md b/docs/api/interfaces/kui_shell_core.CommandCompleteEvent.md new file mode 100644 index 00000000000..218b77c1bdf --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.CommandCompleteEvent.md @@ -0,0 +1,191 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / CommandCompleteEvent + +# Interface: CommandCompleteEvent + +[@kui-shell/core](../modules/kui_shell_core.md).CommandCompleteEvent + +## Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------------------------------------------- | +| `R` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)[`KResponse`](../modules/kui_shell_core.md#kresponse) | +| `T` | extends ` ResponseType``ResponseType ` | + +## Table of contents + +### Properties + +- [argvNoOptions](kui_shell_core.CommandCompleteEvent.md#argvnooptions) +- [cancelled](kui_shell_core.CommandCompleteEvent.md#cancelled) +- [command](kui_shell_core.CommandCompleteEvent.md#command) +- [completeTime](kui_shell_core.CommandCompleteEvent.md#completetime) +- [echo](kui_shell_core.CommandCompleteEvent.md#echo) +- [evaluatorOptions](kui_shell_core.CommandCompleteEvent.md#evaluatoroptions) +- [execOptions](kui_shell_core.CommandCompleteEvent.md#execoptions) +- [execType](kui_shell_core.CommandCompleteEvent.md#exectype) +- [execUUID](kui_shell_core.CommandCompleteEvent.md#execuuid) +- [historyIdx](kui_shell_core.CommandCompleteEvent.md#historyidx) +- [parsedOptions](kui_shell_core.CommandCompleteEvent.md#parsedoptions) +- [pipeStages](kui_shell_core.CommandCompleteEvent.md#pipestages) +- [response](kui_shell_core.CommandCompleteEvent.md#response) +- [responseType](kui_shell_core.CommandCompleteEvent.md#responsetype) +- [tab](kui_shell_core.CommandCompleteEvent.md#tab) + +## Properties + +### argvNoOptions + +• **argvNoOptions**: `string`[] + +#### Defined in + +[packages/core/src/repl/events.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L44) + +--- + +### cancelled + +• **cancelled**: `boolean` + +#### Defined in + +[packages/core/src/repl/events.ts:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L51) + +--- + +### command + +• **command**: `string` + +#### Defined in + +[packages/core/src/repl/events.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L43) + +--- + +### completeTime + +• **completeTime**: `number` + +#### Defined in + +[packages/core/src/repl/events.ts:42](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L42) + +--- + +### echo + +• **echo**: `boolean` + +#### Defined in + +[packages/core/src/repl/events.ts:52](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L52) + +--- + +### evaluatorOptions + +• **evaluatorOptions**: [`CommandOptions`](kui_shell_core.CommandOptions.md) + +#### Defined in + +[packages/core/src/repl/events.ts:53](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L53) + +--- + +### execOptions + +• **execOptions**: [`ExecOptions`](kui_shell_core.ExecOptions.md) + +#### Defined in + +[packages/core/src/repl/events.ts:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L46) + +--- + +### execType + +• **execType**: [`ExecType`](../enums/kui_shell_core.ExecType.md) + +#### Defined in + +[packages/core/src/repl/events.ts:50](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L50) + +--- + +### execUUID + +• **execUUID**: `string` + +#### Defined in + +[packages/core/src/repl/events.ts:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L49) + +--- + +### historyIdx + +• **historyIdx**: `number` + +#### Defined in + +[packages/core/src/repl/events.ts:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L58) + +--- + +### parsedOptions + +• **parsedOptions**: [`ParsedOptions`](kui_shell_core.ParsedOptions.md) + +#### Defined in + +[packages/core/src/repl/events.ts:45](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L45) + +--- + +### pipeStages + +• **pipeStages**: `Object` + +#### Type declaration + +| Name | Type | +| :------------ | :----------------------------------------------- | +| `prefix?` | `string` | +| `redirect?` | `string` | +| `redirector?` | `">"` \| `">>"` \| `"2>&1"` \| `">&"` \| `">>&"` | +| `stages` | `string`[][] | + +#### Defined in + +[packages/core/src/repl/events.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L47) + +--- + +### response + +• **response**: `R` + +#### Defined in + +[packages/core/src/repl/events.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L55) + +--- + +### responseType + +• **responseType**: `T` + +#### Defined in + +[packages/core/src/repl/events.ts:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L56) + +--- + +### tab + +• **tab**: [`Tab`](kui_shell_core.Tab.md) + +#### Defined in + +[packages/core/src/repl/events.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L40) diff --git a/docs/api/interfaces/kui_shell_core.CommandLine.md b/docs/api/interfaces/kui_shell_core.CommandLine.md new file mode 100644 index 00000000000..694674c94f0 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.CommandLine.md @@ -0,0 +1,101 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / CommandLine + +# Interface: CommandLine + +[@kui-shell/core](../modules/kui_shell_core.md).CommandLine + +This information represents a command line, but split out in +various useful ways. + +## Type parameters + +| Name | Type | +| :-------- | :------------------------------------------------- | +| `Options` | [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +## Hierarchy + +- **`CommandLine`** + + ↳ [`Arguments`](kui_shell_core.Arguments.md) + +## Table of contents + +### Properties + +- [argv](kui_shell_core.CommandLine.md#argv) +- [argvNoOptions](kui_shell_core.CommandLine.md#argvnooptions) +- [command](kui_shell_core.CommandLine.md#command) +- [parsedOptions](kui_shell_core.CommandLine.md#parsedoptions) +- [pipeStages](kui_shell_core.CommandLine.md#pipestages) + +## Properties + +### argv + +• **argv**: `string`[] + +the result of a whitespace split applied to the `command` string +that pays attention to backslash escaping and quotations + +#### Defined in + +[packages/core/src/models/command.ts:146](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L146) + +--- + +### argvNoOptions + +• **argvNoOptions**: `string`[] + +the residual of `argv` without `parsedOptions` + +#### Defined in + +[packages/core/src/models/command.ts:151](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L151) + +--- + +### command + +• **command**: `string` + +the raw command string, as given by the user + +#### Defined in + +[packages/core/src/models/command.ts:141](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L141) + +--- + +### parsedOptions + +• **parsedOptions**: `Options` + +the dash options parsed out in a way that pays attention to n-ary +options such as `--option key value` + +#### Defined in + +[packages/core/src/models/command.ts:167](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L167) + +--- + +### pipeStages + +• **pipeStages**: `Object` + +pipeline stages, e.g. if command='a b --foo|c', the pipeStages=[['a','b, '--foo'],'c'] + +#### Type declaration + +| Name | Type | +| :------------ | :----------------------------------------------- | +| `prefix?` | `string` | +| `redirect?` | `string` | +| `redirector?` | `">"` \| `">>"` \| `"2>&1"` \| `">&"` \| `">>&"` | +| `stages` | `string`[][] | + +#### Defined in + +[packages/core/src/models/command.ts:156](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L156) diff --git a/docs/api/interfaces/kui_shell_core.CommandOptions.md b/docs/api/interfaces/kui_shell_core.CommandOptions.md new file mode 100644 index 00000000000..463239c5528 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.CommandOptions.md @@ -0,0 +1,334 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / CommandOptions + +# Interface: CommandOptions + +[@kui-shell/core](../modules/kui_shell_core.md).CommandOptions + +## Hierarchy + +- `CapabilityRequirements` + + ↳ **`CommandOptions`** + +## Table of contents + +### Properties + +- [docs](kui_shell_core.CommandOptions.md#docs) +- [flags](kui_shell_core.CommandOptions.md#flags) +- [fullscreen](kui_shell_core.CommandOptions.md#fullscreen) +- [height](kui_shell_core.CommandOptions.md#height) +- [hidden](kui_shell_core.CommandOptions.md#hidden) +- [hide](kui_shell_core.CommandOptions.md#hide) +- [incognito](kui_shell_core.CommandOptions.md#incognito) +- [isDirectory](kui_shell_core.CommandOptions.md#isdirectory) +- [isExperimental](kui_shell_core.CommandOptions.md#isexperimental) +- [listen](kui_shell_core.CommandOptions.md#listen) +- [needsUI](kui_shell_core.CommandOptions.md#needsui) +- [noArgs](kui_shell_core.CommandOptions.md#noargs) +- [noAuthOk](kui_shell_core.CommandOptions.md#noauthok) +- [noCoreRedirect](kui_shell_core.CommandOptions.md#nocoreredirect) +- [okOptions](kui_shell_core.CommandOptions.md#okoptions) +- [outputOnly](kui_shell_core.CommandOptions.md#outputonly) +- [override](kui_shell_core.CommandOptions.md#override) +- [plugin](kui_shell_core.CommandOptions.md#plugin) +- [preferReExecute](kui_shell_core.CommandOptions.md#preferreexecute) +- [requiresLocal](kui_shell_core.CommandOptions.md#requireslocal) +- [semiExpand](kui_shell_core.CommandOptions.md#semiexpand) +- [synonymFor](kui_shell_core.CommandOptions.md#synonymfor) +- [usage](kui_shell_core.CommandOptions.md#usage) +- [viewName](kui_shell_core.CommandOptions.md#viewname) +- [viewTransformer](kui_shell_core.CommandOptions.md#viewtransformer) +- [width](kui_shell_core.CommandOptions.md#width) + +## Properties + +### docs + +• `Optional` **docs**: `string` + +#### Defined in + +[packages/core/src/models/command.ts:85](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L85) + +--- + +### flags + +• `Optional` **flags**: `YargsParserFlags` + +#### Defined in + +[packages/core/src/models/command.ts:64](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L64) + +--- + +### fullscreen + +• `Optional` **fullscreen**: `boolean` + +#### Inherited from + +CapabilityRequirements.fullscreen + +#### Defined in + +[packages/core/src/models/command.ts:262](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L262) + +--- + +### height + +• `Optional` **height**: `number` + +#### Defined in + +[packages/core/src/models/command.ts:79](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L79) + +--- + +### hidden + +• `Optional` **hidden**: `boolean` + +#### Defined in + +[packages/core/src/models/command.ts:67](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L67) + +--- + +### hide + +• `Optional` **hide**: `boolean` + +#### Defined in + +[packages/core/src/models/command.ts:87](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L87) + +--- + +### incognito + +• `Optional` **incognito**: `"popup"`[] + +#### Defined in + +[packages/core/src/models/command.ts:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L70) + +--- + +### isDirectory + +• `Optional` **isDirectory**: `boolean` + +is this an interior node ("directory", versus a leaf-node with a command handler + +#### Defined in + +[packages/core/src/models/command.ts:82](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L82) + +--- + +### isExperimental + +• `Optional` **isExperimental**: `boolean` + +Is the command experimental? e.g. initial release, lack of test coverage + +#### Defined in + +[packages/core/src/models/command.ts:102](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L102) + +--- + +### listen + +• `Optional` **listen**: `CommandListener` + +#### Defined in + +[packages/core/src/models/command.ts:84](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L84) + +--- + +### needsUI + +• `Optional` **needsUI**: `boolean` + +#### Inherited from + +CapabilityRequirements.needsUI + +#### Defined in + +[packages/core/src/models/command.ts:259](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L259) + +--- + +### noArgs + +• `Optional` **noArgs**: `boolean` + +does this command accept no arguments of any sort (neither positional nor optional)? + +#### Defined in + +[packages/core/src/models/command.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L55) + +--- + +### noAuthOk + +• `Optional` **noAuthOk**: `boolean` \| `string`[] + +#### Inherited from + +CapabilityRequirements.noAuthOk + +#### Defined in + +[packages/core/src/models/command.ts:261](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L261) + +--- + +### noCoreRedirect + +• `Optional` **noCoreRedirect**: `boolean` + +controller wants to handle redirect + +#### Defined in + +[packages/core/src/models/command.ts:93](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L93) + +--- + +### okOptions + +• `Optional` **okOptions**: `string`[] + +#### Defined in + +[packages/core/src/models/command.ts:90](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L90) + +--- + +### outputOnly + +• `Optional` **outputOnly**: `boolean` + +Is the command only want to show output and hide input? + +#### Defined in + +[packages/core/src/models/command.ts:108](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L108) + +--- + +### override + +• `Optional` **override**: [`CommandHandler`](../modules/kui_shell_core.md#commandhandler)<[`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\>, [`ParsedOptions`](kui_shell_core.ParsedOptions.md)\> + +#### Defined in + +[packages/core/src/models/command.ts:88](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L88) + +--- + +### plugin + +• `Optional` **plugin**: `string` + +#### Defined in + +[packages/core/src/models/command.ts:89](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L89) + +--- + +### preferReExecute + +• `Optional` **preferReExecute**: `boolean` + +When this command is being replayed, prefer to re-execute if possible + +#### Defined in + +[packages/core/src/models/command.ts:111](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L111) + +--- + +### requiresLocal + +• `Optional` **requiresLocal**: `boolean` + +#### Inherited from + +CapabilityRequirements.requiresLocal + +#### Defined in + +[packages/core/src/models/command.ts:260](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L260) + +--- + +### semiExpand + +• `Optional` **semiExpand**: `boolean` + +Semicolon-expand the command line? Default: true + +#### Defined in + +[packages/core/src/models/command.ts:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L58) + +--- + +### synonymFor + +• `Optional` **synonymFor**: `Command`<[`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\>, [`ParsedOptions`](kui_shell_core.ParsedOptions.md)\> + +#### Defined in + +[packages/core/src/models/command.ts:86](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L86) + +--- + +### usage + +• `Optional` **usage**: [`UsageModel`](kui_shell_core.UsageModel.md) + +#### Defined in + +[packages/core/src/models/command.ts:61](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L61) + +--- + +### viewName + +• `Optional` **viewName**: `string` + +#### Defined in + +[packages/core/src/models/command.ts:73](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L73) + +--- + +### viewTransformer + +• `Optional` **viewTransformer**: [`ViewTransformer`](../modules/kui_shell_core.md#viewtransformer)<[`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\>, [`ParsedOptions`](kui_shell_core.ParsedOptions.md)\> + +model to view transformer + +#### Defined in + +[packages/core/src/models/command.ts:96](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L96) + +--- + +### width + +• `Optional` **width**: `number` + +#### Defined in + +[packages/core/src/models/command.ts:76](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L76) diff --git a/docs/api/interfaces/kui_shell_core.CommandStartEvent.md b/docs/api/interfaces/kui_shell_core.CommandStartEvent.md new file mode 100644 index 00000000000..3c0da32ef90 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.CommandStartEvent.md @@ -0,0 +1,142 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / CommandStartEvent + +# Interface: CommandStartEvent + +[@kui-shell/core](../modules/kui_shell_core.md).CommandStartEvent + +## Table of contents + +### Properties + +- [command](kui_shell_core.CommandStartEvent.md#command) +- [echo](kui_shell_core.CommandStartEvent.md#echo) +- [evaluatorOptions](kui_shell_core.CommandStartEvent.md#evaluatoroptions) +- [execOptions](kui_shell_core.CommandStartEvent.md#execoptions) +- [execType](kui_shell_core.CommandStartEvent.md#exectype) +- [execUUID](kui_shell_core.CommandStartEvent.md#execuuid) +- [pipeStages](kui_shell_core.CommandStartEvent.md#pipestages) +- [redirectDesired](kui_shell_core.CommandStartEvent.md#redirectdesired) +- [route](kui_shell_core.CommandStartEvent.md#route) +- [startTime](kui_shell_core.CommandStartEvent.md#starttime) +- [tab](kui_shell_core.CommandStartEvent.md#tab) + +## Properties + +### command + +• **command**: `string` + +#### Defined in + +[packages/core/src/repl/events.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L25) + +--- + +### echo + +• **echo**: `boolean` + +#### Defined in + +[packages/core/src/repl/events.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L29) + +--- + +### evaluatorOptions + +• **evaluatorOptions**: [`CommandOptions`](kui_shell_core.CommandOptions.md) + +#### Defined in + +[packages/core/src/repl/events.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L30) + +--- + +### execOptions + +• **execOptions**: [`ExecOptions`](kui_shell_core.ExecOptions.md) + +#### Defined in + +[packages/core/src/repl/events.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L28) + +--- + +### execType + +• **execType**: [`ExecType`](../enums/kui_shell_core.ExecType.md) + +#### Defined in + +[packages/core/src/repl/events.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L27) + +--- + +### execUUID + +• **execUUID**: `string` + +#### Defined in + +[packages/core/src/repl/events.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L26) + +--- + +### pipeStages + +• **pipeStages**: `Object` + +#### Type declaration + +| Name | Type | +| :------------ | :----------------------------------------------- | +| `prefix?` | `string` | +| `redirect?` | `string` | +| `redirector?` | `">"` \| `">>"` \| `"2>&1"` \| `">&"` \| `">>&"` | +| `stages` | `string`[][] | + +#### Defined in + +[packages/core/src/repl/events.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L31) + +--- + +### redirectDesired + +• **redirectDesired**: `boolean` + +The output will be redirected to a file; do not display any live output + +#### Defined in + +[packages/core/src/repl/events.ts:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L34) + +--- + +### route + +• **route**: `string` + +#### Defined in + +[packages/core/src/repl/events.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L24) + +--- + +### startTime + +• **startTime**: `number` + +#### Defined in + +[packages/core/src/repl/events.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L23) + +--- + +### tab + +• **tab**: [`Tab`](kui_shell_core.Tab.md) + +#### Defined in + +[packages/core/src/repl/events.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L22) diff --git a/docs/api/interfaces/kui_shell_core.DescriptionList.md b/docs/api/interfaces/kui_shell_core.DescriptionList.md new file mode 100644 index 00000000000..f1741634b5a --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.DescriptionList.md @@ -0,0 +1,50 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / DescriptionList + +# Interface: DescriptionList + +[@kui-shell/core](../modules/kui_shell_core.md).DescriptionList + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_core.DescriptionList.md#apiversion) +- [kind](kui_shell_core.DescriptionList.md#kind) +- [spec](kui_shell_core.DescriptionList.md#spec) + +## Properties + +### apiVersion + +• **apiVersion**: `"kui-shell/v1"` + +#### Defined in + +[packages/core/src/models/DescriptionList.ts:20](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/DescriptionList.ts#L20) + +--- + +### kind + +• **kind**: `"DescriptionList"` + +#### Defined in + +[packages/core/src/models/DescriptionList.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/DescriptionList.ts#L21) + +--- + +### spec + +• **spec**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------- | +| `as?` | `"default"` \| `"labels"` | Display as a list of key-value pairs (default), or as a list of labels | +| `groups` | { `description`: `string` \| `number` \| `boolean` ; `term`: `string` ; `termHelp?`: { `description`: `string` \| `number` \| `boolean` ; `title`: `string` } }[] | - | + +#### Defined in + +[packages/core/src/models/DescriptionList.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/DescriptionList.ts#L23) diff --git a/docs/api/interfaces/kui_shell_core.EditableSpec.md b/docs/api/interfaces/kui_shell_core.EditableSpec.md new file mode 100644 index 00000000000..a97f27c8a24 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.EditableSpec.md @@ -0,0 +1,76 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / EditableSpec + +# Interface: EditableSpec + +[@kui-shell/core](../modules/kui_shell_core.md).EditableSpec + +## Table of contents + +### Properties + +- [clearable](kui_shell_core.EditableSpec.md#clearable) +- [readOnly](kui_shell_core.EditableSpec.md#readonly) +- [revert](kui_shell_core.EditableSpec.md#revert) +- [save](kui_shell_core.EditableSpec.md#save) + +## Properties + +### clearable + +• **clearable**: `boolean` + +Should we offer a Clear button? Default: false + +#### Defined in + +[packages/core/src/models/editable.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/editable.ts#L30) + +--- + +### readOnly + +• **readOnly**: `boolean` + +Should the editor be opened in read-only mode? Default: false + +#### Defined in + +[packages/core/src/models/editable.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/editable.ts#L27) + +--- + +### revert + +• **revert**: `Object` + +Button and Controller to handle reverts + +#### Type declaration + +| Name | Type | +| :--------- | :------------------------------------- | +| `label?` | `string` | +| `onRevert` | () => `string` \| `Promise`<`string`\> | + +#### Defined in + +[packages/core/src/models/editable.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/editable.ts#L39) + +--- + +### save + +• **save**: `Object` + +Button and Controller to handle saves + +#### Type declaration + +| Name | Type | +| :------- | :------------------------------------------------- | +| `label` | `string` | +| `onSave` | (`data`: `string`) => `Save` \| `Promise`<`Save`\> | + +#### Defined in + +[packages/core/src/models/editable.ts:33](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/editable.ts#L33) diff --git a/docs/api/interfaces/kui_shell_core.Evaluator.md b/docs/api/interfaces/kui_shell_core.Evaluator.md new file mode 100644 index 00000000000..8d094522d89 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Evaluator.md @@ -0,0 +1,30 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Evaluator + +# Interface: Evaluator + +[@kui-shell/core](../modules/kui_shell_core.md).Evaluator + +Evaluator + +## Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------ | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse) | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +## Table of contents + +### Properties + +- [eval](kui_shell_core.Evaluator.md#eval) + +## Properties + +### eval + +• **eval**: [`CommandHandler`](../modules/kui_shell_core.md#commandhandler)<`T`, `O`\> + +#### Defined in + +[packages/core/src/models/command.ts:228](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L228) diff --git a/docs/api/interfaces/kui_shell_core.Event.md b/docs/api/interfaces/kui_shell_core.Event.md new file mode 100644 index 00000000000..67cce4a9648 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Event.md @@ -0,0 +1,109 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Event + +# Interface: Event + +[@kui-shell/core](../modules/kui_shell_core.md).Event + +## Table of contents + +### Properties + +- [command](kui_shell_core.Event.md#command) +- [error](kui_shell_core.Event.md#error) +- [execType](kui_shell_core.Event.md#exectype) +- [isDrilldown](kui_shell_core.Event.md#isdrilldown) +- [isIntention](kui_shell_core.Event.md#isintention) +- [options](kui_shell_core.Event.md#options) +- [plugin](kui_shell_core.Event.md#plugin) +- [route](kui_shell_core.Event.md#route) +- [tab](kui_shell_core.Event.md#tab) + +## Properties + +### command + +• `Optional` **command**: `string` + +#### Defined in + +[packages/core/src/models/command.ts:117](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L117) + +--- + +### error + +• `Optional` **error**: `string` + +#### Defined in + +[packages/core/src/models/command.ts:121](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L121) + +--- + +### execType + +• `Optional` **execType**: [`ExecType`](../enums/kui_shell_core.ExecType.md) + +#### Defined in + +[packages/core/src/models/command.ts:123](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L123) + +--- + +### isDrilldown + +• `Optional` **isDrilldown**: `boolean` + +#### Defined in + +[packages/core/src/models/command.ts:124](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L124) + +--- + +### isIntention + +• `Optional` **isIntention**: `boolean` + +#### Defined in + +[packages/core/src/models/command.ts:120](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L120) + +--- + +### options + +• `Optional` **options**: `string`[] + +#### Defined in + +[packages/core/src/models/command.ts:122](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L122) + +--- + +### plugin + +• `Optional` **plugin**: `string` + +#### Defined in + +[packages/core/src/models/command.ts:119](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L119) + +--- + +### route + +• `Optional` **route**: `string` + +#### Defined in + +[packages/core/src/models/command.ts:118](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L118) + +--- + +### tab + +• `Optional` **tab**: [`Tab`](kui_shell_core.Tab.md) + +#### Defined in + +[packages/core/src/models/command.ts:116](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L116) diff --git a/docs/api/interfaces/kui_shell_core.Events.NewTabRequestEvent.md b/docs/api/interfaces/kui_shell_core.Events.NewTabRequestEvent.md new file mode 100644 index 00000000000..4f6984dcc73 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Events.NewTabRequestEvent.md @@ -0,0 +1,34 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / [Events](../modules/kui_shell_core.Events.md) / NewTabRequestEvent + +# Interface: NewTabRequestEvent + +[@kui-shell/core](../modules/kui_shell_core.md).[Events](../modules/kui_shell_core.Events.md).NewTabRequestEvent + +## Table of contents + +### Properties + +- [background](kui_shell_core.Events.NewTabRequestEvent.md#background) +- [tabs](kui_shell_core.Events.NewTabRequestEvent.md#tabs) + +## Properties + +### background + +• `Optional` **background**: `boolean` + +Optionally specify to create the new tab without switching to it + +#### Defined in + +[packages/core/src/core/events.ts:65](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/events.ts#L65) + +--- + +### tabs + +• **tabs**: { `cmdline?`: `string` ; `exec?`: `"pexec"` \| `"qexec"` ; `onClose?`: `string` ; `replaceCurrentTab?`: `boolean` ; `snapshot?`: `Buffer` ; `statusStripeDecoration?`: [`StatusStripeChangeEvent`](../modules/kui_shell_core.Events.md#statusstripechangeevent) ; `title?`: `string` }[] + +#### Defined in + +[packages/core/src/core/events.ts:67](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/events.ts#L67) diff --git a/docs/api/interfaces/kui_shell_core.ExecOptions.md b/docs/api/interfaces/kui_shell_core.ExecOptions.md new file mode 100644 index 00000000000..a75e9187ac9 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.ExecOptions.md @@ -0,0 +1,689 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ExecOptions + +# Interface: ExecOptions + +[@kui-shell/core](../modules/kui_shell_core.md).ExecOptions + +## Table of contents + +### Properties + +- [alreadyWatching](kui_shell_core.ExecOptions.md#alreadywatching) +- [block](kui_shell_core.ExecOptions.md#block) +- [container](kui_shell_core.ExecOptions.md#container) +- [contextChangeOK](kui_shell_core.ExecOptions.md#contextchangeok) +- [createErrorStream](kui_shell_core.ExecOptions.md#createerrorstream) +- [createOnly](kui_shell_core.ExecOptions.md#createonly) +- [createOutputStream](kui_shell_core.ExecOptions.md#createoutputstream) +- [credentials](kui_shell_core.ExecOptions.md#credentials) +- [custom](kui_shell_core.ExecOptions.md#custom) +- [data](kui_shell_core.ExecOptions.md#data) +- [delegationOk](kui_shell_core.ExecOptions.md#delegationok) +- [echo](kui_shell_core.ExecOptions.md#echo) +- [entity](kui_shell_core.ExecOptions.md#entity) +- [env](kui_shell_core.ExecOptions.md#env) +- [exec](kui_shell_core.ExecOptions.md#exec) +- [execUUID](kui_shell_core.ExecOptions.md#execuuid) +- [failWithUsage](kui_shell_core.ExecOptions.md#failwithusage) +- [filter](kui_shell_core.ExecOptions.md#filter) +- [history](kui_shell_core.ExecOptions.md#history) +- [insertIdx](kui_shell_core.ExecOptions.md#insertidx) +- [intentional](kui_shell_core.ExecOptions.md#intentional) +- [isDrilldown](kui_shell_core.ExecOptions.md#isdrilldown) +- [isProxied](kui_shell_core.ExecOptions.md#isproxied) +- [leaveBottomStripeAlone](kui_shell_core.ExecOptions.md#leavebottomstripealone) +- [nested](kui_shell_core.ExecOptions.md#nested) +- [nextBlock](kui_shell_core.ExecOptions.md#nextblock) +- [noCoreRedirect](kui_shell_core.ExecOptions.md#nocoreredirect) +- [noDelegation](kui_shell_core.ExecOptions.md#nodelegation) +- [noHeader](kui_shell_core.ExecOptions.md#noheader) +- [noHistory](kui_shell_core.ExecOptions.md#nohistory) +- [noRetry](kui_shell_core.ExecOptions.md#noretry) +- [noSidecarHeader](kui_shell_core.ExecOptions.md#nosidecarheader) +- [noStatus](kui_shell_core.ExecOptions.md#nostatus) +- [parameters](kui_shell_core.ExecOptions.md#parameters) +- [pip](kui_shell_core.ExecOptions.md#pip) +- [pipeStdin](kui_shell_core.ExecOptions.md#pipestdin) +- [placeholder](kui_shell_core.ExecOptions.md#placeholder) +- [preserveBackButton](kui_shell_core.ExecOptions.md#preservebackbutton) +- [quiet](kui_shell_core.ExecOptions.md#quiet) +- [raw](kui_shell_core.ExecOptions.md#raw) +- [rawResponse](kui_shell_core.ExecOptions.md#rawresponse) +- [render](kui_shell_core.ExecOptions.md#render) +- [replSilence](kui_shell_core.ExecOptions.md#replsilence) +- [reportErrors](kui_shell_core.ExecOptions.md#reporterrors) +- [rethrowErrors](kui_shell_core.ExecOptions.md#rethrowerrors) +- [showHeader](kui_shell_core.ExecOptions.md#showheader) +- [tab](kui_shell_core.ExecOptions.md#tab) +- [type](kui_shell_core.ExecOptions.md#type) +- [watch](kui_shell_core.ExecOptions.md#watch) + +### Methods + +- [onExit](kui_shell_core.ExecOptions.md#onexit) +- [onInit](kui_shell_core.ExecOptions.md#oninit) +- [onReady](kui_shell_core.ExecOptions.md#onready) +- [stderr](kui_shell_core.ExecOptions.md#stderr) +- [stdout](kui_shell_core.ExecOptions.md#stdout) + +## Properties + +### alreadyWatching + +• `Optional` **alreadyWatching**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:86](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L86) + +--- + +### block + +• `Optional` **block**: [`Block`](kui_shell_core.Block.md) + +#### Defined in + +[packages/core/src/models/execOptions.ts:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L58) + +--- + +### container + +• `Optional` **container**: `Element` + +#### Defined in + +[packages/core/src/models/execOptions.ts:78](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L78) + +--- + +### contextChangeOK + +• `Optional` **contextChangeOK**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:52](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L52) + +--- + +### createErrorStream + +• `Optional` **createErrorStream**: `StreamableFactory` + +#### Defined in + +[packages/core/src/models/execOptions.ts:89](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L89) + +--- + +### createOnly + +• `Optional` **createOnly**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:80](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L80) + +--- + +### createOutputStream + +• `Optional` **createOutputStream**: `StreamableFactory` + +#### Defined in + +[packages/core/src/models/execOptions.ts:90](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L90) + +--- + +### credentials + +• `Optional` **credentials**: `Record`<`string`, `any`\> + +#### Defined in + +[packages/core/src/models/execOptions.ts:53](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L53) + +--- + +### custom + +• `Optional` **custom**: `any` + +#### Defined in + +[packages/core/src/models/execOptions.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L55) + +--- + +### data + +• `Optional` **data**: `string` \| `number` \| `Buffer` \| `Record`<`string`, `any`\> + +pass through uninterpreted data + +#### Defined in + +[packages/core/src/models/execOptions.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L31) + +--- + +### delegationOk + +• `Optional` **delegationOk**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L47) + +--- + +### echo + +• `Optional` **echo**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:68](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L68) + +--- + +### entity + +• `Optional` **entity**: `any` + +#### Defined in + +[packages/core/src/models/execOptions.ts:105](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L105) + +--- + +### env + +• `Optional` **env**: `Record`<`string`, `string`\> + +environment variable map + +#### Defined in + +[packages/core/src/models/execOptions.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L40) + +--- + +### exec + +• `Optional` **exec**: `"pexec"` \| `"qexec"` \| `"rexec"` + +#### Defined in + +[packages/core/src/models/execOptions.ts:76](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L76) + +--- + +### execUUID + +• `Optional` **execUUID**: `string` + +execution UUID + +#### Defined in + +[packages/core/src/models/execOptions.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L28) + +--- + +### failWithUsage + +• `Optional` **failWithUsage**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L70) + +--- + +### filter + +• `Optional` **filter**: `any` + +#### Defined in + +[packages/core/src/models/execOptions.ts:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L51) + +--- + +### history + +• `Optional` **history**: `number` + +#### Defined in + +[packages/core/src/models/execOptions.ts:67](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L67) + +--- + +### insertIdx + +• `Optional` **insertIdx**: `number` + +#### Defined in + +[packages/core/src/models/execOptions.ts:87](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L87) + +--- + +### intentional + +• `Optional` **intentional**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:63](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L63) + +--- + +### isDrilldown + +• `Optional` **isDrilldown**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:57](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L57) + +--- + +### isProxied + +• `Optional` **isProxied**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:45](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L45) + +--- + +### leaveBottomStripeAlone + +• `Optional` **leaveBottomStripeAlone**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L49) + +--- + +### nested + +• `Optional` **nested**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:69](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L69) + +--- + +### nextBlock + +• `Optional` **nextBlock**: `HTMLElement` + +#### Defined in + +[packages/core/src/models/execOptions.ts:59](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L59) + +--- + +### noCoreRedirect + +• `Optional` **noCoreRedirect**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:65](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L65) + +--- + +### noDelegation + +• `Optional` **noDelegation**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L46) + +--- + +### noHeader + +• `Optional` **noHeader**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:81](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L81) + +--- + +### noHistory + +• `Optional` **noHistory**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:64](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L64) + +--- + +### noRetry + +• `Optional` **noRetry**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:84](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L84) + +--- + +### noSidecarHeader + +• `Optional` **noSidecarHeader**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:83](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L83) + +--- + +### noStatus + +• `Optional` **noStatus**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:82](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L82) + +--- + +### parameters + +• `Optional` **parameters**: `any` + +#### Defined in + +[packages/core/src/models/execOptions.ts:104](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L104) + +--- + +### pip + +• `Optional` **pip**: `Object` + +#### Type declaration + +| Name | Type | +| :---------- | :------- | +| `container` | `string` | +| `returnTo` | `string` | + +#### Defined in + +[packages/core/src/models/execOptions.ts:66](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L66) + +--- + +### pipeStdin + +• `Optional` **pipeStdin**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:93](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L93) + +--- + +### placeholder + +• `Optional` **placeholder**: `string` + +#### Defined in + +[packages/core/src/models/execOptions.ts:60](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L60) + +--- + +### preserveBackButton + +• `Optional` **preserveBackButton**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:73](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L73) + +--- + +### quiet + +• `Optional` **quiet**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:62](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L62) + +--- + +### raw + +• `Optional` **raw**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:79](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L79) + +--- + +### rawResponse + +• `Optional` **rawResponse**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L56) + +--- + +### render + +• `Optional` **render**: `boolean` + +true, if you wish a qexec to return rendered HTML; default is false, meaning you get the model back on qexec + +#### Defined in + +[packages/core/src/models/execOptions.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L43) + +--- + +### replSilence + +• `Optional` **replSilence**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:61](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L61) + +--- + +### reportErrors + +• `Optional` **reportErrors**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:72](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L72) + +--- + +### rethrowErrors + +• `Optional` **rethrowErrors**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:71](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L71) + +--- + +### showHeader + +• `Optional` **showHeader**: `boolean` + +#### Defined in + +[packages/core/src/models/execOptions.ts:85](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L85) + +--- + +### tab + +• `Optional` **tab**: [`Tab`](kui_shell_core.Tab.md) + +force execution in a given tab? + +#### Defined in + +[packages/core/src/models/execOptions.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L25) + +--- + +### type + +• `Optional` **type**: [`ExecType`](../enums/kui_shell_core.ExecType.md) + +#### Defined in + +[packages/core/src/models/execOptions.ts:74](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L74) + +--- + +### watch + +• `Optional` **watch**: `Object` + +pass watch state variables to subcommands being watched + +#### Type declaration + +| Name | Type | +| :------------ | :------------------------- | +| `accumulator` | `Record`<`string`, `any`\> | +| `iteration` | `number` | + +#### Defined in + +[packages/core/src/models/execOptions.ts:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L34) + +## Methods + +### onExit + +▸ `Optional` **onExit**(`exitCode`): `void` + +on job exit, pass the exitCode + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `exitCode` | `number` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/execOptions.ts:102](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L102) + +--- + +### onInit + +▸ `Optional` **onInit**(`job`): [`Stream`](../modules/kui_shell_core.md#stream) \| `Promise`<[`Stream`](../modules/kui_shell_core.md#stream)\> + +on job init, pass the job, and get back a stdout; i.e. just before the PTY is brought up + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------- | +| `job` | [`Job`](../modules/kui_shell_core.md#job) | + +#### Returns + +[`Stream`](../modules/kui_shell_core.md#stream) \| `Promise`<[`Stream`](../modules/kui_shell_core.md#stream)\> + +#### Defined in + +[packages/core/src/models/execOptions.ts:96](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L96) + +--- + +### onReady + +▸ `Optional` **onReady**(`job`): `void` \| `Promise`<`void`\> + +on job ready, i.e. after the PTY is up, but before any data has been processed + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------- | +| `job` | [`Job`](../modules/kui_shell_core.md#job) | + +#### Returns + +`void` \| `Promise`<`void`\> + +#### Defined in + +[packages/core/src/models/execOptions.ts:99](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L99) + +--- + +### stderr + +▸ `Optional` **stderr**(`str`): `any` + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `str` | `string` | + +#### Returns + +`any` + +#### Defined in + +[packages/core/src/models/execOptions.ts:92](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L92) + +--- + +### stdout + +▸ `Optional` **stdout**(`str`): `any` + +#### Parameters + +| Name | Type | +| :---- | :------------------------------------------------------ | +| `str` | [`Streamable`](../modules/kui_shell_core.md#streamable) | + +#### Returns + +`any` + +#### Defined in + +[packages/core/src/models/execOptions.ts:91](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L91) diff --git a/docs/api/interfaces/kui_shell_core.FlowControllable.md b/docs/api/interfaces/kui_shell_core.FlowControllable.md new file mode 100644 index 00000000000..47544873cdf --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.FlowControllable.md @@ -0,0 +1,61 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / FlowControllable + +# Interface: FlowControllable + +[@kui-shell/core](../modules/kui_shell_core.md).FlowControllable + +## Table of contents + +### Methods + +- [write](kui_shell_core.FlowControllable.md#write) +- [xoff](kui_shell_core.FlowControllable.md#xoff) +- [xon](kui_shell_core.FlowControllable.md#xon) + +## Methods + +### write + +▸ **write**(`data`): `void` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `data` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/job.ts:32](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/job.ts#L32) + +--- + +### xoff + +▸ **xoff**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/job.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/job.ts#L31) + +--- + +### xon + +▸ **xon**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/job.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/job.ts#L30) diff --git a/docs/api/interfaces/kui_shell_core.HistoryLine.md b/docs/api/interfaces/kui_shell_core.HistoryLine.md new file mode 100644 index 00000000000..66c268b54fb --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.HistoryLine.md @@ -0,0 +1,25 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / HistoryLine + +# Interface: HistoryLine + +[@kui-shell/core](../modules/kui_shell_core.md).HistoryLine + +One History entry + +## Table of contents + +### Properties + +- [raw](kui_shell_core.HistoryLine.md#raw) + +## Properties + +### raw + +• **raw**: `string` + +The raw command line + +#### Defined in + +[packages/core/src/models/history.ts:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/history.ts#L37) diff --git a/docs/api/interfaces/kui_shell_core.MetadataNamedResource.md b/docs/api/interfaces/kui_shell_core.MetadataNamedResource.md new file mode 100644 index 00000000000..cb3758e15da --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.MetadataNamedResource.md @@ -0,0 +1,50 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / MetadataNamedResource + +# Interface: MetadataNamedResource + +[@kui-shell/core](../modules/kui_shell_core.md).MetadataNamedResource + +The name part of a metadata bearing resource. + +## Hierarchy + +- **`MetadataNamedResource`** + + ↳ [`ResourceWithMetadata`](kui_shell_core.ResourceWithMetadata.md) + +## Table of contents + +### Properties + +- [kind](kui_shell_core.MetadataNamedResource.md#kind) +- [metadata](kui_shell_core.MetadataNamedResource.md#metadata) + +## Properties + +### kind + +• `Optional` **kind**: `string` + +#### Defined in + +[packages/core/src/models/entity.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L47) + +--- + +### metadata + +• `Optional` **metadata**: `Object` + +#### Type declaration + +| Name | Type | +| :------------------- | :---------------------------- | +| `creationTimestamp?` | `string` | +| `generation?` | `string` | +| `labels?` | `Record`<`string`, `string`\> | +| `name` | `string` | +| `namespace?` | `string` | + +#### Defined in + +[packages/core/src/models/entity.ts:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L49) diff --git a/docs/api/interfaces/kui_shell_core.ModeRegistration.md b/docs/api/interfaces/kui_shell_core.ModeRegistration.md new file mode 100644 index 00000000000..14d7928e523 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.ModeRegistration.md @@ -0,0 +1,41 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ModeRegistration + +# Interface: ModeRegistration + +[@kui-shell/core](../modules/kui_shell_core.md).ModeRegistration + +Interpretation: if the resource passes the given "when" filter, +then add the given sidecar mode + +## Type parameters + +| Name | Type | +| :--------- | :----------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](kui_shell_core.ResourceWithMetadata.md) | + +## Table of contents + +### Properties + +- [mode](kui_shell_core.ModeRegistration.md#mode) +- [when](kui_shell_core.ModeRegistration.md#when) + +## Properties + +### mode + +• **mode**: [`ModeDeclaration`](../modules/kui_shell_core.md#modedeclaration)<`Resource`\> + +#### Defined in + +[packages/core/src/webapp/views/registrar/modes.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/modes.ts#L40) + +--- + +### when + +• **when**: [`ModeFilter`](../modules/kui_shell_core.md#modefilter)<`Resource`\> + +#### Defined in + +[packages/core/src/webapp/views/registrar/modes.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/modes.ts#L39) diff --git a/docs/api/interfaces/kui_shell_core.Notebook.md b/docs/api/interfaces/kui_shell_core.Notebook.md new file mode 100644 index 00000000000..187c414f73f --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Notebook.md @@ -0,0 +1,51 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Notebook + +# Interface: Notebook + +[@kui-shell/core](../modules/kui_shell_core.md).Notebook + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_core.Notebook.md#apiversion) +- [kind](kui_shell_core.Notebook.md#kind) +- [metadata](kui_shell_core.Notebook.md#metadata) + +## Properties + +### apiVersion + +• **apiVersion**: `"kui-shell/v1"` + +#### Defined in + +[packages/core/src/repl/events.ts:73](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L73) + +--- + +### kind + +• **kind**: `"Notebook"` + +#### Defined in + +[packages/core/src/repl/events.ts:74](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L74) + +--- + +### metadata + +• `Optional` **metadata**: `Object` + +#### Type declaration + +| Name | Type | +| :----------------- | :-------- | +| `description?` | `string` | +| `name?` | `string` | +| `preferReExecute?` | `boolean` | + +#### Defined in + +[packages/core/src/repl/events.ts:75](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L75) diff --git a/docs/api/interfaces/kui_shell_core.ParsedOptions.md b/docs/api/interfaces/kui_shell_core.ParsedOptions.md new file mode 100644 index 00000000000..de3559b3e97 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.ParsedOptions.md @@ -0,0 +1,25 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ParsedOptions + +# Interface: ParsedOptions + +[@kui-shell/core](../modules/kui_shell_core.md).ParsedOptions + +## Indexable + +▪ [key: `string`]: `string` \| `boolean` \| `number` \| `string`[] + +## Table of contents + +### Properties + +- [\_](kui_shell_core.ParsedOptions.md#_) + +## Properties + +### \_ + +• `Optional` **\_**: `string`[] + +#### Defined in + +[packages/core/src/models/command.ts:128](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L128) diff --git a/docs/api/interfaces/kui_shell_core.PreloadRegistrar.md b/docs/api/interfaces/kui_shell_core.PreloadRegistrar.md new file mode 100644 index 00000000000..866a311313e --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.PreloadRegistrar.md @@ -0,0 +1,375 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / PreloadRegistrar + +# Interface: PreloadRegistrar + +[@kui-shell/core](../modules/kui_shell_core.md).PreloadRegistrar + +## Hierarchy + +- [`Registrar`](kui_shell_core.Registrar.md) + + ↳ **`PreloadRegistrar`** + +## Table of contents + +### Properties + +- [listen](kui_shell_core.PreloadRegistrar.md#listen) + +### Methods + +- [catchall](kui_shell_core.PreloadRegistrar.md#catchall) +- [find](kui_shell_core.PreloadRegistrar.md#find) +- [override](kui_shell_core.PreloadRegistrar.md#override) +- [registerBadge](kui_shell_core.PreloadRegistrar.md#registerbadge) +- [registerBadges](kui_shell_core.PreloadRegistrar.md#registerbadges) +- [registerMode](kui_shell_core.PreloadRegistrar.md#registermode) +- [registerModes](kui_shell_core.PreloadRegistrar.md#registermodes) +- [registerSessionInitializer](kui_shell_core.PreloadRegistrar.md#registersessioninitializer) +- [subtree](kui_shell_core.PreloadRegistrar.md#subtree) +- [subtreeSynonym](kui_shell_core.PreloadRegistrar.md#subtreesynonym) +- [synonym](kui_shell_core.PreloadRegistrar.md#synonym) + +## Properties + +### listen + +• **listen**: `CommandListener` + +#### Inherited from + +[Registrar](kui_shell_core.Registrar.md).[listen](kui_shell_core.Registrar.md#listen) + +#### Defined in + +[packages/core/src/models/command.ts:329](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L329) + +## Methods + +### catchall + +▸ **catchall**<`T`, `O`\>(`offer`, `handler`, `prio`, `options?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------- | +| `offer` | `CatchAllOffer` | +| `handler` | [`CommandHandler`](../modules/kui_shell_core.md#commandhandler)<`T`, `O`\> | +| `prio` | `number` | +| `options?` | [`CommandOptions`](kui_shell_core.CommandOptions.md) | + +#### Returns + +`void` + +#### Inherited from + +[Registrar](kui_shell_core.Registrar.md).[catchall](kui_shell_core.Registrar.md#catchall) + +#### Defined in + +[packages/core/src/models/command.ts:348](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L348) + +--- + +### find + +▸ **find**<`T`, `O`\>(`route`, `fromPlugin?`, `noOverride?`): `Promise`<`Command`<`T`, `O`\>\> + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :------------ | :-------- | +| `route` | `string` | +| `fromPlugin?` | `string` | +| `noOverride?` | `boolean` | + +#### Returns + +`Promise`<`Command`<`T`, `O`\>\> + +#### Inherited from + +[Registrar](kui_shell_core.Registrar.md).[find](kui_shell_core.Registrar.md#find) + +#### Defined in + +[packages/core/src/models/command.ts:324](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L324) + +--- + +### override + +▸ **override**<`T`, `O`\>(`route`, `fromPlugin`, `handler`, `options?`): `Promise`<`Command`<`T`, `O`\>\> + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :----------- | :--------------------------------------------------- | +| `route` | `string` | +| `fromPlugin` | `string` | +| `handler` | `CommandOverrideHandler`<`T`, `O`\> | +| `options?` | [`CommandOptions`](kui_shell_core.CommandOptions.md) | + +#### Returns + +`Promise`<`Command`<`T`, `O`\>\> + +#### Inherited from + +[Registrar](kui_shell_core.Registrar.md).[override](kui_shell_core.Registrar.md#override) + +#### Defined in + +[packages/core/src/models/command.ts:330](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L330) + +--- + +### registerBadge + +▸ **registerBadge**<`Resource`\>(`registration`): `void` + +sidecar badges + +#### Type parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](kui_shell_core.ResourceWithMetadata.md)<`void`, `Resource`\> | + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------------------------------- | +| `registration` | [`BadgeRegistration`](kui_shell_core.BadgeRegistration.md)<`Resource`\> | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/plugin.ts:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/plugin.ts#L34) + +--- + +### registerBadges + +▸ **registerBadges**<`Resource`\>(...`registrations`): `void` + +#### Type parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](kui_shell_core.ResourceWithMetadata.md)<`void`, `Resource`\> | + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------------ | +| `...registrations` | [`BadgeRegistration`](kui_shell_core.BadgeRegistration.md)<`Resource`\>[] | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/plugin.ts:35](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/plugin.ts#L35) + +--- + +### registerMode + +▸ **registerMode**<`Resource`\>(`registration`): `void` + +sidecar modes + +#### Type parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](kui_shell_core.ResourceWithMetadata.md)<`void`, `Resource`\> | + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------------------------------------------- | +| `registration` | [`ModeRegistration`](kui_shell_core.ModeRegistration.md)<`Resource`\> | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/plugin.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/plugin.ts#L30) + +--- + +### registerModes + +▸ **registerModes**<`Resource`\>(...`registrations`): `void` + +#### Type parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](kui_shell_core.ResourceWithMetadata.md)<`void`, `Resource`\> | + +#### Parameters + +| Name | Type | +| :----------------- | :---------------------------------------------------------------------- | +| `...registrations` | [`ModeRegistration`](kui_shell_core.ModeRegistration.md)<`Resource`\>[] | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/plugin.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/plugin.ts#L31) + +--- + +### registerSessionInitializer + +▸ **registerSessionInitializer**(`init`): `void` + +session initializers + +#### Parameters + +| Name | Type | +| :----- | :------------------- | +| `init` | `SessionInitializer` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/plugin.ts:38](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/plugin.ts#L38) + +--- + +### subtree + +▸ **subtree**<`T`, `O`\>(`route`, `options`): `Command`<`T`, `O`\> + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :-------- | :--------------------------------------------------- | +| `route` | `string` | +| `options` | [`CommandOptions`](kui_shell_core.CommandOptions.md) | + +#### Returns + +`Command`<`T`, `O`\> + +#### Inherited from + +[Registrar](kui_shell_core.Registrar.md).[subtree](kui_shell_core.Registrar.md#subtree) + +#### Defined in + +[packages/core/src/models/command.ts:342](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L342) + +--- + +### subtreeSynonym + +▸ **subtreeSynonym**<`T`, `O`\>(`route`, `masterTree`, `options?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :----------- | :--------------------------------------------------- | +| `route` | `string` | +| `masterTree` | `Command`<`T`, `O`\> | +| `options?` | [`CommandOptions`](kui_shell_core.CommandOptions.md) | + +#### Returns + +`void` + +#### Inherited from + +[Registrar](kui_shell_core.Registrar.md).[subtreeSynonym](kui_shell_core.Registrar.md#subtreesynonym) + +#### Defined in + +[packages/core/src/models/command.ts:343](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L343) + +--- + +### synonym + +▸ **synonym**<`T`, `O`\>(`route`, `handler`, `master`, `options?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------- | +| `route` | `string` | +| `handler` | [`CommandHandler`](../modules/kui_shell_core.md#commandhandler)<`T`, `O`\> | +| `master` | `Command`<`T`, `O`\> | +| `options?` | [`CommandOptions`](kui_shell_core.CommandOptions.md) | + +#### Returns + +`void` + +#### Inherited from + +[Registrar](kui_shell_core.Registrar.md).[synonym](kui_shell_core.Registrar.md#synonym) + +#### Defined in + +[packages/core/src/models/command.ts:336](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L336) diff --git a/docs/api/interfaces/kui_shell_core.REPL.md b/docs/api/interfaces/kui_shell_core.REPL.md new file mode 100644 index 00000000000..84a57befa10 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.REPL.md @@ -0,0 +1,215 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / REPL + +# Interface: REPL + +[@kui-shell/core](../modules/kui_shell_core.md).REPL + +## Table of contents + +### Methods + +- [click](kui_shell_core.REPL.md#click) +- [encodeComponent](kui_shell_core.REPL.md#encodecomponent) +- [pexec](kui_shell_core.REPL.md#pexec) +- [qexec](kui_shell_core.REPL.md#qexec) +- [reexec](kui_shell_core.REPL.md#reexec) +- [rexec](kui_shell_core.REPL.md#rexec) +- [split](kui_shell_core.REPL.md#split) + +## Methods + +### click + +▸ **click**(`command`, `evt`): `Promise`<`void`\> + +Execute a command in response to an in-view click in a sidecar +view. This is helpful if you wish to participate in the view +nesting logic, e.g. where clicking on a link in a sidecar allows +the user to return to the previous view. In contrast, `pexec` +calls will _not_ participate in view stacking. + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------- | +| `command` | `string` \| () => `Promise`<`string`\> | +| `evt` | `MouseEvent` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/models/repl.ts:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/repl.ts#L58) + +--- + +### encodeComponent + +▸ **encodeComponent**(`component`, `quote?`): `string` + +Prepare a string to be part of a `command` argument to the \*exec +functions, quoting and escaping as necessary. + +#### Parameters + +| Name | Type | +| :---------- | :-------------------------------- | +| `component` | `string` \| `number` \| `boolean` | +| `quote?` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/models/repl.ts:71](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/repl.ts#L71) + +--- + +### pexec + +▸ **pexec**<`T`\>(`command`, `execOptions?`): `Promise`<`T`\> + +Programmatic eval. Useful to execute one command from another, +e.g. as the result of a click handler --- where you would like +the REPL interaction to appear on the console. + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | + +#### Parameters + +| Name | Type | +| :------------- | :--------------------------------------------- | +| `command` | `string` | +| `execOptions?` | [`ExecOptions`](kui_shell_core.ExecOptions.md) | + +#### Returns + +`Promise`<`T`\> + +#### Defined in + +[packages/core/src/models/repl.ts:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/repl.ts#L48) + +--- + +### qexec + +▸ **qexec**<`T`\>(`command`, `block?`, `contextChangeOK?`, `execOptions?`, `nextBlock?`): `Promise`<`T`\> + +Quiet eval. Useful to execute one command from another, without +emitting output to the console. + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | + +#### Parameters + +| Name | Type | +| :----------------- | :--------------------------------------------- | +| `command` | `string` | +| `block?` | `boolean` \| `HTMLElement` | +| `contextChangeOK?` | `boolean` | +| `execOptions?` | [`ExecOptions`](kui_shell_core.ExecOptions.md) | +| `nextBlock?` | `HTMLElement` | + +#### Returns + +`Promise`<`T`\> + +#### Defined in + +[packages/core/src/models/repl.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/repl.ts#L27) + +--- + +### reexec + +▸ **reexec**<`T`\>(`command`, `execOptions`): `Promise`<`T`\> + +Evaluate a command and place the result in the current active view for the given tab + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------------------------------ | +| `command` | `string` | +| `execOptions` | [`ExecOptionsWithUUID`](../modules/kui_shell_core.md#execoptionswithuuid) | + +#### Returns + +`Promise`<`T`\> + +#### Defined in + +[packages/core/src/models/repl.ts:64](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/repl.ts#L64) + +--- + +### rexec + +▸ **rexec**<`Raw`\>(`command`, `execOptions?`): `Promise`<[`RawResponse`](kui_shell_core.RawResponse.md)<`Raw`\>\> + +Raw eval. Useful to execute one command from another, where you +want the original model back, not the view-oriented model. + +#### Type parameters + +| Name | Type | +| :---- | :---------------- | +| `Raw` | extends `unknown` | + +#### Parameters + +| Name | Type | +| :------------- | :--------------------------------------------- | +| `command` | `string` | +| `execOptions?` | [`ExecOptions`](kui_shell_core.ExecOptions.md) | + +#### Returns + +`Promise`<[`RawResponse`](kui_shell_core.RawResponse.md)<`Raw`\>\> + +#### Defined in + +[packages/core/src/models/repl.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/repl.ts#L40) + +--- + +### split + +▸ **split**(`str`, `removeOuterQuotes?`, `removeInlineOuterQuotes?`): `string`[] + +Split the given string into an argv + +#### Parameters + +| Name | Type | +| :------------------------- | :-------- | +| `str` | `string` | +| `removeOuterQuotes?` | `boolean` | +| `removeInlineOuterQuotes?` | `boolean` | + +#### Returns + +`string`[] + +#### Defined in + +[packages/core/src/models/repl.ts:80](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/repl.ts#L80) diff --git a/docs/api/interfaces/kui_shell_core.RadioTable.md b/docs/api/interfaces/kui_shell_core.RadioTable.md new file mode 100644 index 00000000000..83736ad3160 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.RadioTable.md @@ -0,0 +1,76 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / RadioTable + +# Interface: RadioTable + +[@kui-shell/core](../modules/kui_shell_core.md).RadioTable + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_core.RadioTable.md#apiversion) +- [body](kui_shell_core.RadioTable.md#body) +- [defaultSelectedIdx](kui_shell_core.RadioTable.md#defaultselectedidx) +- [header](kui_shell_core.RadioTable.md#header) +- [kind](kui_shell_core.RadioTable.md#kind) +- [title](kui_shell_core.RadioTable.md#title) + +## Properties + +### apiVersion + +• **apiVersion**: `"kui-shell/v1"` + +#### Defined in + +[packages/core/src/models/RadioTable.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L21) + +--- + +### body + +• **body**: [`RadioTableRow`](kui_shell_core.RadioTableRow.md) & [`Selectable`](kui_shell_core.Selectable.md)[] + +#### Defined in + +[packages/core/src/models/RadioTable.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L26) + +--- + +### defaultSelectedIdx + +• **defaultSelectedIdx**: `number` + +#### Defined in + +[packages/core/src/models/RadioTable.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L28) + +--- + +### header + +• **header**: [`RadioTableRow`](kui_shell_core.RadioTableRow.md) + +#### Defined in + +[packages/core/src/models/RadioTable.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L25) + +--- + +### kind + +• **kind**: `"RadioTable"` + +#### Defined in + +[packages/core/src/models/RadioTable.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L22) + +--- + +### title + +• **title**: `string` + +#### Defined in + +[packages/core/src/models/RadioTable.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L24) diff --git a/docs/api/interfaces/kui_shell_core.RadioTableRow.md b/docs/api/interfaces/kui_shell_core.RadioTableRow.md new file mode 100644 index 00000000000..cd04a2871a8 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.RadioTableRow.md @@ -0,0 +1,32 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / RadioTableRow + +# Interface: RadioTableRow + +[@kui-shell/core](../modules/kui_shell_core.md).RadioTableRow + +## Table of contents + +### Properties + +- [cells](kui_shell_core.RadioTableRow.md#cells) +- [nameIdx](kui_shell_core.RadioTableRow.md#nameidx) + +## Properties + +### cells + +• **cells**: [`RadioTableCell`](../modules/kui_shell_core.md#radiotablecell)[] + +#### Defined in + +[packages/core/src/models/RadioTable.ts:33](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L33) + +--- + +### nameIdx + +• `Optional` **nameIdx**: `number` + +#### Defined in + +[packages/core/src/models/RadioTable.ts:32](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L32) diff --git a/docs/api/interfaces/kui_shell_core.RawResponse.md b/docs/api/interfaces/kui_shell_core.RawResponse.md new file mode 100644 index 00000000000..c452c89aba7 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.RawResponse.md @@ -0,0 +1,38 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / RawResponse + +# Interface: RawResponse + +[@kui-shell/core](../modules/kui_shell_core.md).RawResponse + +## Type parameters + +| Name | Type | +| :-------- | :------------------- | +| `Content` | extends `RawContent` | + +## Table of contents + +### Properties + +- [content](kui_shell_core.RawResponse.md#content) +- [mode](kui_shell_core.RawResponse.md#mode) + +## Properties + +### content + +• **content**: `Content` + +#### Defined in + +[packages/core/src/models/entity.ts:184](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L184) + +--- + +### mode + +• **mode**: `"raw"` + +#### Defined in + +[packages/core/src/models/entity.ts:183](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L183) diff --git a/docs/api/interfaces/kui_shell_core.Registrar.md b/docs/api/interfaces/kui_shell_core.Registrar.md new file mode 100644 index 00000000000..ee137482381 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Registrar.md @@ -0,0 +1,212 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Registrar + +# Interface: Registrar + +[@kui-shell/core](../modules/kui_shell_core.md).Registrar + +## Hierarchy + +- **`Registrar`** + + ↳ [`PreloadRegistrar`](kui_shell_core.PreloadRegistrar.md) + +## Table of contents + +### Properties + +- [listen](kui_shell_core.Registrar.md#listen) + +### Methods + +- [catchall](kui_shell_core.Registrar.md#catchall) +- [find](kui_shell_core.Registrar.md#find) +- [override](kui_shell_core.Registrar.md#override) +- [subtree](kui_shell_core.Registrar.md#subtree) +- [subtreeSynonym](kui_shell_core.Registrar.md#subtreesynonym) +- [synonym](kui_shell_core.Registrar.md#synonym) + +## Properties + +### listen + +• **listen**: `CommandListener` + +#### Defined in + +[packages/core/src/models/command.ts:329](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L329) + +## Methods + +### catchall + +▸ **catchall**<`T`, `O`\>(`offer`, `handler`, `prio`, `options?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------- | +| `offer` | `CatchAllOffer` | +| `handler` | [`CommandHandler`](../modules/kui_shell_core.md#commandhandler)<`T`, `O`\> | +| `prio` | `number` | +| `options?` | [`CommandOptions`](kui_shell_core.CommandOptions.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/command.ts:348](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L348) + +--- + +### find + +▸ **find**<`T`, `O`\>(`route`, `fromPlugin?`, `noOverride?`): `Promise`<`Command`<`T`, `O`\>\> + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :------------ | :-------- | +| `route` | `string` | +| `fromPlugin?` | `string` | +| `noOverride?` | `boolean` | + +#### Returns + +`Promise`<`Command`<`T`, `O`\>\> + +#### Defined in + +[packages/core/src/models/command.ts:324](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L324) + +--- + +### override + +▸ **override**<`T`, `O`\>(`route`, `fromPlugin`, `handler`, `options?`): `Promise`<`Command`<`T`, `O`\>\> + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :----------- | :--------------------------------------------------- | +| `route` | `string` | +| `fromPlugin` | `string` | +| `handler` | `CommandOverrideHandler`<`T`, `O`\> | +| `options?` | [`CommandOptions`](kui_shell_core.CommandOptions.md) | + +#### Returns + +`Promise`<`Command`<`T`, `O`\>\> + +#### Defined in + +[packages/core/src/models/command.ts:330](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L330) + +--- + +### subtree + +▸ **subtree**<`T`, `O`\>(`route`, `options`): `Command`<`T`, `O`\> + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :-------- | :--------------------------------------------------- | +| `route` | `string` | +| `options` | [`CommandOptions`](kui_shell_core.CommandOptions.md) | + +#### Returns + +`Command`<`T`, `O`\> + +#### Defined in + +[packages/core/src/models/command.ts:342](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L342) + +--- + +### subtreeSynonym + +▸ **subtreeSynonym**<`T`, `O`\>(`route`, `masterTree`, `options?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :----------- | :--------------------------------------------------- | +| `route` | `string` | +| `masterTree` | `Command`<`T`, `O`\> | +| `options?` | [`CommandOptions`](kui_shell_core.CommandOptions.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/command.ts:343](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L343) + +--- + +### synonym + +▸ **synonym**<`T`, `O`\>(`route`, `handler`, `master`, `options?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------- | +| `route` | `string` | +| `handler` | [`CommandHandler`](../modules/kui_shell_core.md#commandhandler)<`T`, `O`\> | +| `master` | `Command`<`T`, `O`\> | +| `options?` | [`CommandOptions`](kui_shell_core.CommandOptions.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/command.ts:336](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L336) diff --git a/docs/api/interfaces/kui_shell_core.ReplEval.md b/docs/api/interfaces/kui_shell_core.ReplEval.md new file mode 100644 index 00000000000..806b10c9fea --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.ReplEval.md @@ -0,0 +1,61 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ReplEval + +# Interface: ReplEval + +[@kui-shell/core](../modules/kui_shell_core.md).ReplEval + +Apply the given evaluator to the given arguments + +## Implemented by + +- [`DirectReplEval`](../classes/kui_shell_core.DirectReplEval.md) + +## Table of contents + +### Properties + +- [name](kui_shell_core.ReplEval.md#name) + +### Methods + +- [apply](kui_shell_core.ReplEval.md#apply) + +## Properties + +### name + +• **name**: `string` + +#### Defined in + +[packages/core/src/repl/types.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/types.ts#L40) + +## Methods + +### apply + +▸ **apply**<`T`, `O`\>(`commandUntrimmed`, `execOptions`, `evaluator`, `args`): `T` \| `Promise`<`T`\> + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | extends [`KResponse`](../modules/kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :----------------- | :---------------------------------------------------- | +| `commandUntrimmed` | `string` | +| `execOptions` | [`ExecOptions`](kui_shell_core.ExecOptions.md) | +| `evaluator` | [`Evaluator`](kui_shell_core.Evaluator.md)<`T`, `O`\> | +| `args` | [`Arguments`](kui_shell_core.Arguments.md)<`O`\> | + +#### Returns + +`T` \| `Promise`<`T`\> + +#### Defined in + +[packages/core/src/repl/types.ts:41](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/types.ts#L41) diff --git a/docs/api/interfaces/kui_shell_core.Resizable.md b/docs/api/interfaces/kui_shell_core.Resizable.md new file mode 100644 index 00000000000..d0de974d888 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Resizable.md @@ -0,0 +1,32 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Resizable + +# Interface: Resizable + +[@kui-shell/core](../modules/kui_shell_core.md).Resizable + +## Table of contents + +### Methods + +- [resize](kui_shell_core.Resizable.md#resize) + +## Methods + +### resize + +▸ **resize**(`rows`, `cols`): `void` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `rows` | `number` | +| `cols` | `number` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/job.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/job.ts#L22) diff --git a/docs/api/interfaces/kui_shell_core.ResourceByReference.md b/docs/api/interfaces/kui_shell_core.ResourceByReference.md new file mode 100644 index 00000000000..3a6f1726ad8 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.ResourceByReference.md @@ -0,0 +1,225 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ResourceByReference + +# Interface: ResourceByReference + +[@kui-shell/core](../modules/kui_shell_core.md).ResourceByReference + +Entity with a "resource" field that is MetadataBearing + +## Type parameters + +| Name | Type | +| :-------- | :----- | +| `Content` | `void` | + +## Hierarchy + +- [`ResourceWithMetadata`](kui_shell_core.ResourceWithMetadata.md)<`Content`\> + + ↳ **`ResourceByReference`** + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_core.ResourceByReference.md#apiversion) +- [content](kui_shell_core.ResourceByReference.md#content) +- [contentType](kui_shell_core.ResourceByReference.md#contenttype) +- [kind](kui_shell_core.ResourceByReference.md#kind) +- [metadata](kui_shell_core.ResourceByReference.md#metadata) +- [nameHash](kui_shell_core.ResourceByReference.md#namehash) +- [onclick](kui_shell_core.ResourceByReference.md#onclick) +- [presentation](kui_shell_core.ResourceByReference.md#presentation) +- [prettyName](kui_shell_core.ResourceByReference.md#prettyname) +- [resource](kui_shell_core.ResourceByReference.md#resource) +- [toolbarText](kui_shell_core.ResourceByReference.md#toolbartext) +- [version](kui_shell_core.ResourceByReference.md#version) + +## Properties + +### apiVersion + +• `Optional` **apiVersion**: `string` + +#### Inherited from + +[ResourceWithMetadata](kui_shell_core.ResourceWithMetadata.md).[apiVersion](kui_shell_core.ResourceWithMetadata.md#apiversion) + +#### Defined in + +[packages/core/src/models/entity.ts:64](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L64) + +--- + +### content + +• `Optional` **content**: `Content` + +#### Inherited from + +[ResourceWithMetadata](kui_shell_core.ResourceWithMetadata.md).[content](kui_shell_core.ResourceWithMetadata.md#content) + +#### Defined in + +[packages/core/src/models/entity.ts:81](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L81) + +--- + +### contentType + +• `Optional` **contentType**: `string` + +#### Inherited from + +[ResourceWithMetadata](kui_shell_core.ResourceWithMetadata.md).[contentType](kui_shell_core.ResourceWithMetadata.md#contenttype) + +#### Defined in + +[packages/core/src/models/entity.ts:82](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L82) + +--- + +### kind + +• `Optional` **kind**: `string` + +#### Inherited from + +[ResourceWithMetadata](kui_shell_core.ResourceWithMetadata.md).[kind](kui_shell_core.ResourceWithMetadata.md#kind) + +#### Defined in + +[packages/core/src/models/entity.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L47) + +--- + +### metadata + +• `Optional` **metadata**: `Object` + +#### Type declaration + +| Name | Type | +| :------------------- | :---------------------------- | +| `creationTimestamp?` | `string` | +| `generation?` | `string` | +| `labels?` | `Record`<`string`, `string`\> | +| `name` | `string` | +| `namespace?` | `string` | + +#### Inherited from + +[ResourceWithMetadata](kui_shell_core.ResourceWithMetadata.md).[metadata](kui_shell_core.ResourceWithMetadata.md#metadata) + +#### Defined in + +[packages/core/src/models/entity.ts:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L49) + +--- + +### nameHash + +• `Optional` **nameHash**: `string` + +#### Inherited from + +[ResourceWithMetadata](kui_shell_core.ResourceWithMetadata.md).[nameHash](kui_shell_core.ResourceWithMetadata.md#namehash) + +#### Defined in + +[packages/core/src/models/entity.ts:71](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L71) + +--- + +### onclick + +• `Optional` **onclick**: `Object` + +family of onclick handlers + +#### Type declaration + +| Name | Type | +| :----------- | :------- | +| `kind?` | `string` | +| `name?` | `string` | +| `nameHash?` | `string` | +| `namespace?` | `string` | + +#### Inherited from + +[ResourceWithMetadata](kui_shell_core.ResourceWithMetadata.md).[onclick](kui_shell_core.ResourceWithMetadata.md#onclick) + +#### Defined in + +[packages/core/src/models/entity.ts:74](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L74) + +--- + +### presentation + +• `Optional` **presentation**: [`Presentation`](../enums/kui_shell_core.Presentation.md) + +#### Inherited from + +[ResourceWithMetadata](kui_shell_core.ResourceWithMetadata.md).[presentation](kui_shell_core.ResourceWithMetadata.md#presentation) + +#### Defined in + +[packages/core/src/models/entity.ts:84](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L84) + +--- + +### prettyName + +• `Optional` **prettyName**: `string` + +name hash, e.g. the hash part of auto-generated names, or an openwhisk activation id + +#### Inherited from + +[ResourceWithMetadata](kui_shell_core.ResourceWithMetadata.md).[prettyName](kui_shell_core.ResourceWithMetadata.md#prettyname) + +#### Defined in + +[packages/core/src/models/entity.ts:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L70) + +--- + +### resource + +• **resource**: [`ResourceWithMetadata`](kui_shell_core.ResourceWithMetadata.md)<`Content`\> + +#### Defined in + +[packages/core/src/models/entity.ts:110](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L110) + +--- + +### toolbarText + +• `Optional` **toolbarText**: [`ToolbarText`](kui_shell_core.ToolbarText.md) + +#### Inherited from + +[ResourceWithMetadata](kui_shell_core.ResourceWithMetadata.md).[toolbarText](kui_shell_core.ResourceWithMetadata.md#toolbartext) + +#### Defined in + +[packages/core/src/models/entity.ts:83](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L83) + +--- + +### version + +• `Optional` **version**: `string` + +optional designation of resource version + +#### Inherited from + +[ResourceWithMetadata](kui_shell_core.ResourceWithMetadata.md).[version](kui_shell_core.ResourceWithMetadata.md#version) + +#### Defined in + +[packages/core/src/models/entity.ts:67](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L67) diff --git a/docs/api/interfaces/kui_shell_core.ResourceWithMetadata.md b/docs/api/interfaces/kui_shell_core.ResourceWithMetadata.md new file mode 100644 index 00000000000..8f9b81ab299 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.ResourceWithMetadata.md @@ -0,0 +1,181 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ResourceWithMetadata + +# Interface: ResourceWithMetadata + +[@kui-shell/core](../modules/kui_shell_core.md).ResourceWithMetadata + +A minimal subset of a kubernetes-like resource specification that +identifies a resource + +## Type parameters + +| Name | Type | +| :-------- | :----- | +| `Content` | `void` | + +## Hierarchy + +- [`MetadataNamedResource`](kui_shell_core.MetadataNamedResource.md) + + ↳ **`ResourceWithMetadata`** + + ↳↳ [`ResourceByReference`](kui_shell_core.ResourceByReference.md) + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_core.ResourceWithMetadata.md#apiversion) +- [content](kui_shell_core.ResourceWithMetadata.md#content) +- [contentType](kui_shell_core.ResourceWithMetadata.md#contenttype) +- [kind](kui_shell_core.ResourceWithMetadata.md#kind) +- [metadata](kui_shell_core.ResourceWithMetadata.md#metadata) +- [nameHash](kui_shell_core.ResourceWithMetadata.md#namehash) +- [onclick](kui_shell_core.ResourceWithMetadata.md#onclick) +- [presentation](kui_shell_core.ResourceWithMetadata.md#presentation) +- [prettyName](kui_shell_core.ResourceWithMetadata.md#prettyname) +- [toolbarText](kui_shell_core.ResourceWithMetadata.md#toolbartext) +- [version](kui_shell_core.ResourceWithMetadata.md#version) + +## Properties + +### apiVersion + +• `Optional` **apiVersion**: `string` + +#### Defined in + +[packages/core/src/models/entity.ts:64](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L64) + +--- + +### content + +• `Optional` **content**: `Content` + +#### Defined in + +[packages/core/src/models/entity.ts:81](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L81) + +--- + +### contentType + +• `Optional` **contentType**: `string` + +#### Defined in + +[packages/core/src/models/entity.ts:82](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L82) + +--- + +### kind + +• `Optional` **kind**: `string` + +#### Inherited from + +[MetadataNamedResource](kui_shell_core.MetadataNamedResource.md).[kind](kui_shell_core.MetadataNamedResource.md#kind) + +#### Defined in + +[packages/core/src/models/entity.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L47) + +--- + +### metadata + +• `Optional` **metadata**: `Object` + +#### Type declaration + +| Name | Type | +| :------------------- | :---------------------------- | +| `creationTimestamp?` | `string` | +| `generation?` | `string` | +| `labels?` | `Record`<`string`, `string`\> | +| `name` | `string` | +| `namespace?` | `string` | + +#### Inherited from + +[MetadataNamedResource](kui_shell_core.MetadataNamedResource.md).[metadata](kui_shell_core.MetadataNamedResource.md#metadata) + +#### Defined in + +[packages/core/src/models/entity.ts:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L49) + +--- + +### nameHash + +• `Optional` **nameHash**: `string` + +#### Defined in + +[packages/core/src/models/entity.ts:71](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L71) + +--- + +### onclick + +• `Optional` **onclick**: `Object` + +family of onclick handlers + +#### Type declaration + +| Name | Type | +| :----------- | :------- | +| `kind?` | `string` | +| `name?` | `string` | +| `nameHash?` | `string` | +| `namespace?` | `string` | + +#### Defined in + +[packages/core/src/models/entity.ts:74](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L74) + +--- + +### presentation + +• `Optional` **presentation**: [`Presentation`](../enums/kui_shell_core.Presentation.md) + +#### Defined in + +[packages/core/src/models/entity.ts:84](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L84) + +--- + +### prettyName + +• `Optional` **prettyName**: `string` + +name hash, e.g. the hash part of auto-generated names, or an openwhisk activation id + +#### Defined in + +[packages/core/src/models/entity.ts:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L70) + +--- + +### toolbarText + +• `Optional` **toolbarText**: [`ToolbarText`](kui_shell_core.ToolbarText.md) + +#### Defined in + +[packages/core/src/models/entity.ts:83](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L83) + +--- + +### version + +• `Optional` **version**: `string` + +optional designation of resource version + +#### Defined in + +[packages/core/src/models/entity.ts:67](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L67) diff --git a/docs/api/interfaces/kui_shell_core.SaveError.md b/docs/api/interfaces/kui_shell_core.SaveError.md new file mode 100644 index 00000000000..7019fe945d0 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.SaveError.md @@ -0,0 +1,72 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / SaveError + +# Interface: SaveError + +[@kui-shell/core](../modules/kui_shell_core.md).SaveError + +## Hierarchy + +- `Error` + + ↳ **`SaveError`** + +## Table of contents + +### Properties + +- [message](kui_shell_core.SaveError.md#message) +- [name](kui_shell_core.SaveError.md#name) +- [revealLine](kui_shell_core.SaveError.md#revealline) +- [stack](kui_shell_core.SaveError.md#stack) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:974 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:973 + +--- + +### revealLine + +• `Optional` **revealLine**: `number` + +#### Defined in + +[packages/core/src/models/editable.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/editable.ts#L22) + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:975 diff --git a/docs/api/interfaces/kui_shell_core.ScalarContent.md b/docs/api/interfaces/kui_shell_core.ScalarContent.md new file mode 100644 index 00000000000..f2d4ecca005 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.ScalarContent.md @@ -0,0 +1,27 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ScalarContent + +# Interface: ScalarContent + +[@kui-shell/core](../modules/kui_shell_core.md).ScalarContent + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | [`ScalarResource`](../modules/kui_shell_core.md#scalarresource) | + +## Table of contents + +### Properties + +- [content](kui_shell_core.ScalarContent.md#content) + +## Properties + +### content + +• **content**: `T` + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:36](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L36) diff --git a/docs/api/interfaces/kui_shell_core.Selectable.md b/docs/api/interfaces/kui_shell_core.Selectable.md new file mode 100644 index 00000000000..66cd4f88d17 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Selectable.md @@ -0,0 +1,36 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Selectable + +# Interface: Selectable + +[@kui-shell/core](../modules/kui_shell_core.md).Selectable + +## Table of contents + +### Properties + +- [onSelect](kui_shell_core.Selectable.md#onselect) +- [onSelectExec](kui_shell_core.Selectable.md#onselectexec) + +## Properties + +### onSelect + +• **onSelect**: `string` + +Handler for change of selection. This will be interpreted as a +Kui command line to be executed when the user clicks on the +corresponding row in the UI. + +#### Defined in + +[packages/core/src/models/RadioTable.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L43) + +--- + +### onSelectExec + +• `Optional` **onSelectExec**: `"pexec"` \| `"qexec"` + +#### Defined in + +[packages/core/src/models/RadioTable.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L44) diff --git a/docs/api/interfaces/kui_shell_core.SourceRef.md b/docs/api/interfaces/kui_shell_core.SourceRef.md new file mode 100644 index 00000000000..443472902f3 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.SourceRef.md @@ -0,0 +1,40 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / SourceRef + +# Interface: SourceRef + +[@kui-shell/core](../modules/kui_shell_core.md).SourceRef + +## Table of contents + +### Properties + +- [customization](kui_shell_core.SourceRef.md#customization) +- [templates](kui_shell_core.SourceRef.md#templates) + +## Properties + +### customization + +• `Optional` **customization**: `Object` + +#### Type declaration + +| Name | Type | +| :--------- | :------- | +| `data` | `string` | +| `filepath` | `string` | +| `isFor` | `string` | + +#### Defined in + +[packages/core/src/models/entity.ts:232](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L232) + +--- + +### templates + +• **templates**: { `contentType?`: `string` ; `data`: `string` ; `filepath`: `string` ; `isFor`: `string` ; `kind?`: `"source"` \| `"template"` }[] + +#### Defined in + +[packages/core/src/models/entity.ts:231](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L231) diff --git a/docs/api/interfaces/kui_shell_core.Split.md b/docs/api/interfaces/kui_shell_core.Split.md new file mode 100644 index 00000000000..a2f935dc465 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Split.md @@ -0,0 +1,34 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Split + +# Interface: Split + +[@kui-shell/core](../modules/kui_shell_core.md).Split + +Split the given string into an argv + +## Table of contents + +### Properties + +- [A](kui_shell_core.Split.md#a) +- [endIndices](kui_shell_core.Split.md#endindices) + +## Properties + +### A + +• **A**: `string`[] + +#### Defined in + +[packages/core/src/repl/split.ts:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/split.ts#L46) + +--- + +### endIndices + +• **endIndices**: `number`[] + +#### Defined in + +[packages/core/src/repl/split.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/split.ts#L47) diff --git a/docs/api/interfaces/kui_shell_core.StatusModel.md b/docs/api/interfaces/kui_shell_core.StatusModel.md new file mode 100644 index 00000000000..c96ae9c579e --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.StatusModel.md @@ -0,0 +1,66 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / StatusModel + +# Interface: StatusModel + +[@kui-shell/core](../modules/kui_shell_core.md).StatusModel + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_core.StatusModel.md#apiversion) +- [kind](kui_shell_core.StatusModel.md#kind) +- [metadata](kui_shell_core.StatusModel.md#metadata) +- [spec](kui_shell_core.StatusModel.md#spec) + +## Properties + +### apiVersion + +• **apiVersion**: `"kui-shell/v1"` + +#### Defined in + +[packages/core/src/models/StatusModel.ts:57](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L57) + +--- + +### kind + +• **kind**: `"StatusModel"` + +#### Defined in + +[packages/core/src/models/StatusModel.ts:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L58) + +--- + +### metadata + +• **metadata**: `Object` + +#### Type declaration + +| Name | Type | +| :----- | :------- | +| `name` | `string` | + +#### Defined in + +[packages/core/src/models/StatusModel.ts:59](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L59) + +--- + +### spec + +• **spec**: `Object` + +#### Type declaration + +| Name | Type | +| :--------- | :------------------------------------------------------------- | +| `sections` | [`StatusModelSection`](kui_shell_core.StatusModelSection.md)[] | + +#### Defined in + +[packages/core/src/models/StatusModel.ts:62](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L62) diff --git a/docs/api/interfaces/kui_shell_core.StatusModelItem.md b/docs/api/interfaces/kui_shell_core.StatusModelItem.md new file mode 100644 index 00000000000..abf03f387e1 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.StatusModelItem.md @@ -0,0 +1,43 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / StatusModelItem + +# Interface: StatusModelItem + +[@kui-shell/core](../modules/kui_shell_core.md).StatusModelItem + +## Table of contents + +### Properties + +- [description](kui_shell_core.StatusModelItem.md#description) +- [status](kui_shell_core.StatusModelItem.md#status) +- [title](kui_shell_core.StatusModelItem.md#title) + +## Properties + +### description + +• **description**: `string` + +#### Defined in + +[packages/core/src/models/StatusModel.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L23) + +--- + +### status + +• **status**: [`StatusModelStatus`](../modules/kui_shell_core.md#statusmodelstatus) \| { `cached?`: [`StatusModelStatus`](../modules/kui_shell_core.md#statusmodelstatus) ; `statusFn`: () => `Promise`<[`StatusModelStatus`](../modules/kui_shell_core.md#statusmodelstatus)\> } + +#### Defined in + +[packages/core/src/models/StatusModel.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L24) + +--- + +### title + +• **title**: `string` + +#### Defined in + +[packages/core/src/models/StatusModel.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L22) diff --git a/docs/api/interfaces/kui_shell_core.StatusModelSection.md b/docs/api/interfaces/kui_shell_core.StatusModelSection.md new file mode 100644 index 00000000000..03592b79269 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.StatusModelSection.md @@ -0,0 +1,32 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / StatusModelSection + +# Interface: StatusModelSection + +[@kui-shell/core](../modules/kui_shell_core.md).StatusModelSection + +## Table of contents + +### Properties + +- [tiles](kui_shell_core.StatusModelSection.md#tiles) +- [title](kui_shell_core.StatusModelSection.md#title) + +## Properties + +### tiles + +• **tiles**: [`StatusModelTile`](kui_shell_core.StatusModelTile.md)[] + +#### Defined in + +[packages/core/src/models/StatusModel.ts:53](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L53) + +--- + +### title + +• **title**: `string` + +#### Defined in + +[packages/core/src/models/StatusModel.ts:52](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L52) diff --git a/docs/api/interfaces/kui_shell_core.StatusModelTile.md b/docs/api/interfaces/kui_shell_core.StatusModelTile.md new file mode 100644 index 00000000000..c27c3bf2ec5 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.StatusModelTile.md @@ -0,0 +1,54 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / StatusModelTile + +# Interface: StatusModelTile + +[@kui-shell/core](../modules/kui_shell_core.md).StatusModelTile + +## Table of contents + +### Properties + +- [actions](kui_shell_core.StatusModelTile.md#actions) +- [description](kui_shell_core.StatusModelTile.md#description) +- [items](kui_shell_core.StatusModelTile.md#items) +- [title](kui_shell_core.StatusModelTile.md#title) + +## Properties + +### actions + +• **actions**: [`StatusModelTileAction`](kui_shell_core.StatusModelTileAction.md)[] + +#### Defined in + +[packages/core/src/models/StatusModel.ts:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L48) + +--- + +### description + +• **description**: `string` + +#### Defined in + +[packages/core/src/models/StatusModel.ts:45](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L45) + +--- + +### items + +• **items**: [`StatusModelItem`](kui_shell_core.StatusModelItem.md)[] + +#### Defined in + +[packages/core/src/models/StatusModel.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L47) + +--- + +### title + +• **title**: `string` + +#### Defined in + +[packages/core/src/models/StatusModel.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L44) diff --git a/docs/api/interfaces/kui_shell_core.StatusModelTileAction.md b/docs/api/interfaces/kui_shell_core.StatusModelTileAction.md new file mode 100644 index 00000000000..f9f429a3fcb --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.StatusModelTileAction.md @@ -0,0 +1,72 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / StatusModelTileAction + +# Interface: StatusModelTileAction + +[@kui-shell/core](../modules/kui_shell_core.md).StatusModelTileAction + +## Table of contents + +### Properties + +- [label](kui_shell_core.StatusModelTileAction.md#label) + +### Methods + +- [isVisible](kui_shell_core.StatusModelTileAction.md#isvisible) +- [onClick](kui_shell_core.StatusModelTileAction.md#onclick) + +## Properties + +### label + +• **label**: `string` + +Label for e.g. Button UI + +#### Defined in + +[packages/core/src/models/StatusModel.ts:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L34) + +## Methods + +### isVisible + +▸ **isVisible**(`items`): `boolean` \| `Promise`<`boolean`\> + +Should the button be shown? + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `items` | [`StatusModelItem`](kui_shell_core.StatusModelItem.md)[] | + +#### Returns + +`boolean` \| `Promise`<`boolean`\> + +#### Defined in + +[packages/core/src/models/StatusModel.ts:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L37) + +--- + +### onClick + +▸ **onClick**(`items`): `Promise`<[`StatusModelItem`](kui_shell_core.StatusModelItem.md)[]\> + +What happens when the button is clicked? @return updated items + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `items` | [`StatusModelItem`](kui_shell_core.StatusModelItem.md)[] | + +#### Returns + +`Promise`<[`StatusModelItem`](kui_shell_core.StatusModelItem.md)[]\> + +#### Defined in + +[packages/core/src/models/StatusModel.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L40) diff --git a/docs/api/interfaces/kui_shell_core.Tab.md b/docs/api/interfaces/kui_shell_core.Tab.md new file mode 100644 index 00000000000..4effe31ac2a --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Tab.md @@ -0,0 +1,6440 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Tab + +# Interface: Tab + +[@kui-shell/core](../modules/kui_shell_core.md).Tab + +## Hierarchy + +- `HTMLDivElement` + + ↳ **`Tab`** + +## Table of contents + +### Properties + +- [ATTRIBUTE_NODE](kui_shell_core.Tab.md#attribute_node) +- [CDATA_SECTION_NODE](kui_shell_core.Tab.md#cdata_section_node) +- [COMMENT_NODE](kui_shell_core.Tab.md#comment_node) +- [DOCUMENT_FRAGMENT_NODE](kui_shell_core.Tab.md#document_fragment_node) +- [DOCUMENT_NODE](kui_shell_core.Tab.md#document_node) +- [DOCUMENT_POSITION_CONTAINED_BY](kui_shell_core.Tab.md#document_position_contained_by) +- [DOCUMENT_POSITION_CONTAINS](kui_shell_core.Tab.md#document_position_contains) +- [DOCUMENT_POSITION_DISCONNECTED](kui_shell_core.Tab.md#document_position_disconnected) +- [DOCUMENT_POSITION_FOLLOWING](kui_shell_core.Tab.md#document_position_following) +- [DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC](kui_shell_core.Tab.md#document_position_implementation_specific) +- [DOCUMENT_POSITION_PRECEDING](kui_shell_core.Tab.md#document_position_preceding) +- [DOCUMENT_TYPE_NODE](kui_shell_core.Tab.md#document_type_node) +- [ELEMENT_NODE](kui_shell_core.Tab.md#element_node) +- [ENTITY_NODE](kui_shell_core.Tab.md#entity_node) +- [ENTITY_REFERENCE_NODE](kui_shell_core.Tab.md#entity_reference_node) +- [NOTATION_NODE](kui_shell_core.Tab.md#notation_node) +- [PROCESSING_INSTRUCTION_NODE](kui_shell_core.Tab.md#processing_instruction_node) +- [REPL](kui_shell_core.Tab.md#repl) +- [TEXT_NODE](kui_shell_core.Tab.md#text_node) +- [\_kui_session](kui_shell_core.Tab.md#_kui_session) +- [accessKey](kui_shell_core.Tab.md#accesskey) +- [accessKeyLabel](kui_shell_core.Tab.md#accesskeylabel) +- [align](kui_shell_core.Tab.md#align) +- [assignedSlot](kui_shell_core.Tab.md#assignedslot) +- [attributes](kui_shell_core.Tab.md#attributes) +- [autocapitalize](kui_shell_core.Tab.md#autocapitalize) +- [autofocus](kui_shell_core.Tab.md#autofocus) +- [baseURI](kui_shell_core.Tab.md#baseuri) +- [childElementCount](kui_shell_core.Tab.md#childelementcount) +- [childNodes](kui_shell_core.Tab.md#childnodes) +- [children](kui_shell_core.Tab.md#children) +- [classList](kui_shell_core.Tab.md#classlist) +- [className](kui_shell_core.Tab.md#classname) +- [clientHeight](kui_shell_core.Tab.md#clientheight) +- [clientLeft](kui_shell_core.Tab.md#clientleft) +- [clientTop](kui_shell_core.Tab.md#clienttop) +- [clientWidth](kui_shell_core.Tab.md#clientwidth) +- [contentEditable](kui_shell_core.Tab.md#contenteditable) +- [dataset](kui_shell_core.Tab.md#dataset) +- [dir](kui_shell_core.Tab.md#dir) +- [draggable](kui_shell_core.Tab.md#draggable) +- [enterKeyHint](kui_shell_core.Tab.md#enterkeyhint) +- [firstChild](kui_shell_core.Tab.md#firstchild) +- [firstElementChild](kui_shell_core.Tab.md#firstelementchild) +- [hidden](kui_shell_core.Tab.md#hidden) +- [id](kui_shell_core.Tab.md#id) +- [innerHTML](kui_shell_core.Tab.md#innerhtml) +- [innerText](kui_shell_core.Tab.md#innertext) +- [inputMode](kui_shell_core.Tab.md#inputmode) +- [isConnected](kui_shell_core.Tab.md#isconnected) +- [isContentEditable](kui_shell_core.Tab.md#iscontenteditable) +- [lang](kui_shell_core.Tab.md#lang) +- [lastChild](kui_shell_core.Tab.md#lastchild) +- [lastElementChild](kui_shell_core.Tab.md#lastelementchild) +- [localName](kui_shell_core.Tab.md#localname) +- [namespaceURI](kui_shell_core.Tab.md#namespaceuri) +- [nextElementSibling](kui_shell_core.Tab.md#nextelementsibling) +- [nextSibling](kui_shell_core.Tab.md#nextsibling) +- [nodeName](kui_shell_core.Tab.md#nodename) +- [nodeType](kui_shell_core.Tab.md#nodetype) +- [nodeValue](kui_shell_core.Tab.md#nodevalue) +- [nonce](kui_shell_core.Tab.md#nonce) +- [offsetHeight](kui_shell_core.Tab.md#offsetheight) +- [offsetLeft](kui_shell_core.Tab.md#offsetleft) +- [offsetParent](kui_shell_core.Tab.md#offsetparent) +- [offsetTop](kui_shell_core.Tab.md#offsettop) +- [offsetWidth](kui_shell_core.Tab.md#offsetwidth) +- [onabort](kui_shell_core.Tab.md#onabort) +- [onanimationcancel](kui_shell_core.Tab.md#onanimationcancel) +- [onanimationend](kui_shell_core.Tab.md#onanimationend) +- [onanimationiteration](kui_shell_core.Tab.md#onanimationiteration) +- [onanimationstart](kui_shell_core.Tab.md#onanimationstart) +- [onauxclick](kui_shell_core.Tab.md#onauxclick) +- [onblur](kui_shell_core.Tab.md#onblur) +- [oncancel](kui_shell_core.Tab.md#oncancel) +- [oncanplay](kui_shell_core.Tab.md#oncanplay) +- [oncanplaythrough](kui_shell_core.Tab.md#oncanplaythrough) +- [onchange](kui_shell_core.Tab.md#onchange) +- [onclick](kui_shell_core.Tab.md#onclick) +- [onclose](kui_shell_core.Tab.md#onclose) +- [oncontextmenu](kui_shell_core.Tab.md#oncontextmenu) +- [oncopy](kui_shell_core.Tab.md#oncopy) +- [oncuechange](kui_shell_core.Tab.md#oncuechange) +- [oncut](kui_shell_core.Tab.md#oncut) +- [ondblclick](kui_shell_core.Tab.md#ondblclick) +- [ondrag](kui_shell_core.Tab.md#ondrag) +- [ondragend](kui_shell_core.Tab.md#ondragend) +- [ondragenter](kui_shell_core.Tab.md#ondragenter) +- [ondragexit](kui_shell_core.Tab.md#ondragexit) +- [ondragleave](kui_shell_core.Tab.md#ondragleave) +- [ondragover](kui_shell_core.Tab.md#ondragover) +- [ondragstart](kui_shell_core.Tab.md#ondragstart) +- [ondrop](kui_shell_core.Tab.md#ondrop) +- [ondurationchange](kui_shell_core.Tab.md#ondurationchange) +- [onemptied](kui_shell_core.Tab.md#onemptied) +- [onended](kui_shell_core.Tab.md#onended) +- [onerror](kui_shell_core.Tab.md#onerror) +- [onfocus](kui_shell_core.Tab.md#onfocus) +- [onfullscreenchange](kui_shell_core.Tab.md#onfullscreenchange) +- [onfullscreenerror](kui_shell_core.Tab.md#onfullscreenerror) +- [ongotpointercapture](kui_shell_core.Tab.md#ongotpointercapture) +- [oninput](kui_shell_core.Tab.md#oninput) +- [oninvalid](kui_shell_core.Tab.md#oninvalid) +- [onkeydown](kui_shell_core.Tab.md#onkeydown) +- [onkeypress](kui_shell_core.Tab.md#onkeypress) +- [onkeyup](kui_shell_core.Tab.md#onkeyup) +- [onload](kui_shell_core.Tab.md#onload) +- [onloadeddata](kui_shell_core.Tab.md#onloadeddata) +- [onloadedmetadata](kui_shell_core.Tab.md#onloadedmetadata) +- [onloadstart](kui_shell_core.Tab.md#onloadstart) +- [onlostpointercapture](kui_shell_core.Tab.md#onlostpointercapture) +- [onmousedown](kui_shell_core.Tab.md#onmousedown) +- [onmouseenter](kui_shell_core.Tab.md#onmouseenter) +- [onmouseleave](kui_shell_core.Tab.md#onmouseleave) +- [onmousemove](kui_shell_core.Tab.md#onmousemove) +- [onmouseout](kui_shell_core.Tab.md#onmouseout) +- [onmouseover](kui_shell_core.Tab.md#onmouseover) +- [onmouseup](kui_shell_core.Tab.md#onmouseup) +- [onpaste](kui_shell_core.Tab.md#onpaste) +- [onpause](kui_shell_core.Tab.md#onpause) +- [onplay](kui_shell_core.Tab.md#onplay) +- [onplaying](kui_shell_core.Tab.md#onplaying) +- [onpointercancel](kui_shell_core.Tab.md#onpointercancel) +- [onpointerdown](kui_shell_core.Tab.md#onpointerdown) +- [onpointerenter](kui_shell_core.Tab.md#onpointerenter) +- [onpointerleave](kui_shell_core.Tab.md#onpointerleave) +- [onpointermove](kui_shell_core.Tab.md#onpointermove) +- [onpointerout](kui_shell_core.Tab.md#onpointerout) +- [onpointerover](kui_shell_core.Tab.md#onpointerover) +- [onpointerup](kui_shell_core.Tab.md#onpointerup) +- [onprogress](kui_shell_core.Tab.md#onprogress) +- [onratechange](kui_shell_core.Tab.md#onratechange) +- [onreset](kui_shell_core.Tab.md#onreset) +- [onresize](kui_shell_core.Tab.md#onresize) +- [onscroll](kui_shell_core.Tab.md#onscroll) +- [onsecuritypolicyviolation](kui_shell_core.Tab.md#onsecuritypolicyviolation) +- [onseeked](kui_shell_core.Tab.md#onseeked) +- [onseeking](kui_shell_core.Tab.md#onseeking) +- [onselect](kui_shell_core.Tab.md#onselect) +- [onselectionchange](kui_shell_core.Tab.md#onselectionchange) +- [onselectstart](kui_shell_core.Tab.md#onselectstart) +- [onstalled](kui_shell_core.Tab.md#onstalled) +- [onsubmit](kui_shell_core.Tab.md#onsubmit) +- [onsuspend](kui_shell_core.Tab.md#onsuspend) +- [ontimeupdate](kui_shell_core.Tab.md#ontimeupdate) +- [ontoggle](kui_shell_core.Tab.md#ontoggle) +- [ontouchcancel](kui_shell_core.Tab.md#ontouchcancel) +- [ontouchend](kui_shell_core.Tab.md#ontouchend) +- [ontouchmove](kui_shell_core.Tab.md#ontouchmove) +- [ontouchstart](kui_shell_core.Tab.md#ontouchstart) +- [ontransitioncancel](kui_shell_core.Tab.md#ontransitioncancel) +- [ontransitionend](kui_shell_core.Tab.md#ontransitionend) +- [ontransitionrun](kui_shell_core.Tab.md#ontransitionrun) +- [ontransitionstart](kui_shell_core.Tab.md#ontransitionstart) +- [onvolumechange](kui_shell_core.Tab.md#onvolumechange) +- [onwaiting](kui_shell_core.Tab.md#onwaiting) +- [onwheel](kui_shell_core.Tab.md#onwheel) +- [outerHTML](kui_shell_core.Tab.md#outerhtml) +- [ownerDocument](kui_shell_core.Tab.md#ownerdocument) +- [parentElement](kui_shell_core.Tab.md#parentelement) +- [parentNode](kui_shell_core.Tab.md#parentnode) +- [prefix](kui_shell_core.Tab.md#prefix) +- [previousElementSibling](kui_shell_core.Tab.md#previouselementsibling) +- [previousSibling](kui_shell_core.Tab.md#previoussibling) +- [queueListener](kui_shell_core.Tab.md#queuelistener) +- [scrollHeight](kui_shell_core.Tab.md#scrollheight) +- [scrollLeft](kui_shell_core.Tab.md#scrollleft) +- [scrollTop](kui_shell_core.Tab.md#scrolltop) +- [scrollWidth](kui_shell_core.Tab.md#scrollwidth) +- [shadowRoot](kui_shell_core.Tab.md#shadowroot) +- [slot](kui_shell_core.Tab.md#slot) +- [spellcheck](kui_shell_core.Tab.md#spellcheck) +- [state](kui_shell_core.Tab.md#state) +- [style](kui_shell_core.Tab.md#style) +- [tabIndex](kui_shell_core.Tab.md#tabindex) +- [tagName](kui_shell_core.Tab.md#tagname) +- [textContent](kui_shell_core.Tab.md#textcontent) +- [title](kui_shell_core.Tab.md#title) +- [translate](kui_shell_core.Tab.md#translate) +- [uuid](kui_shell_core.Tab.md#uuid) + +### Methods + +- [addClass](kui_shell_core.Tab.md#addclass) +- [addEventListener](kui_shell_core.Tab.md#addeventlistener) +- [after](kui_shell_core.Tab.md#after) +- [animate](kui_shell_core.Tab.md#animate) +- [append](kui_shell_core.Tab.md#append) +- [appendChild](kui_shell_core.Tab.md#appendchild) +- [attachShadow](kui_shell_core.Tab.md#attachshadow) +- [before](kui_shell_core.Tab.md#before) +- [blur](kui_shell_core.Tab.md#blur) +- [click](kui_shell_core.Tab.md#click) +- [cloneNode](kui_shell_core.Tab.md#clonenode) +- [closest](kui_shell_core.Tab.md#closest) +- [compareDocumentPosition](kui_shell_core.Tab.md#comparedocumentposition) +- [contains](kui_shell_core.Tab.md#contains) +- [dispatchEvent](kui_shell_core.Tab.md#dispatchevent) +- [focus](kui_shell_core.Tab.md#focus) +- [getAnimations](kui_shell_core.Tab.md#getanimations) +- [getAttribute](kui_shell_core.Tab.md#getattribute) +- [getAttributeNS](kui_shell_core.Tab.md#getattributens) +- [getAttributeNames](kui_shell_core.Tab.md#getattributenames) +- [getAttributeNode](kui_shell_core.Tab.md#getattributenode) +- [getAttributeNodeNS](kui_shell_core.Tab.md#getattributenodens) +- [getBoundingClientRect](kui_shell_core.Tab.md#getboundingclientrect) +- [getClientRects](kui_shell_core.Tab.md#getclientrects) +- [getElementsByClassName](kui_shell_core.Tab.md#getelementsbyclassname) +- [getElementsByTagName](kui_shell_core.Tab.md#getelementsbytagname) +- [getElementsByTagNameNS](kui_shell_core.Tab.md#getelementsbytagnamens) +- [getRootNode](kui_shell_core.Tab.md#getrootnode) +- [getSize](kui_shell_core.Tab.md#getsize) +- [hasAttribute](kui_shell_core.Tab.md#hasattribute) +- [hasAttributeNS](kui_shell_core.Tab.md#hasattributens) +- [hasAttributes](kui_shell_core.Tab.md#hasattributes) +- [hasChildNodes](kui_shell_core.Tab.md#haschildnodes) +- [hasPointerCapture](kui_shell_core.Tab.md#haspointercapture) +- [hasSideBySideTerminals](kui_shell_core.Tab.md#hassidebysideterminals) +- [insertAdjacentElement](kui_shell_core.Tab.md#insertadjacentelement) +- [insertAdjacentHTML](kui_shell_core.Tab.md#insertadjacenthtml) +- [insertAdjacentText](kui_shell_core.Tab.md#insertadjacenttext) +- [insertBefore](kui_shell_core.Tab.md#insertbefore) +- [isDefaultNamespace](kui_shell_core.Tab.md#isdefaultnamespace) +- [isEqualNode](kui_shell_core.Tab.md#isequalnode) +- [isSameNode](kui_shell_core.Tab.md#issamenode) +- [lookupNamespaceURI](kui_shell_core.Tab.md#lookupnamespaceuri) +- [lookupPrefix](kui_shell_core.Tab.md#lookupprefix) +- [matches](kui_shell_core.Tab.md#matches) +- [msGetRegionContent](kui_shell_core.Tab.md#msgetregioncontent) +- [normalize](kui_shell_core.Tab.md#normalize) +- [offActivate](kui_shell_core.Tab.md#offactivate) +- [onActivate](kui_shell_core.Tab.md#onactivate) +- [prepend](kui_shell_core.Tab.md#prepend) +- [querySelector](kui_shell_core.Tab.md#queryselector) +- [querySelectorAll](kui_shell_core.Tab.md#queryselectorall) +- [releasePointerCapture](kui_shell_core.Tab.md#releasepointercapture) +- [remove](kui_shell_core.Tab.md#remove) +- [removeAttribute](kui_shell_core.Tab.md#removeattribute) +- [removeAttributeNS](kui_shell_core.Tab.md#removeattributens) +- [removeAttributeNode](kui_shell_core.Tab.md#removeattributenode) +- [removeChild](kui_shell_core.Tab.md#removechild) +- [removeClass](kui_shell_core.Tab.md#removeclass) +- [removeEventListener](kui_shell_core.Tab.md#removeeventlistener) +- [replaceChild](kui_shell_core.Tab.md#replacechild) +- [replaceWith](kui_shell_core.Tab.md#replacewith) +- [requestFullscreen](kui_shell_core.Tab.md#requestfullscreen) +- [requestPointerLock](kui_shell_core.Tab.md#requestpointerlock) +- [scroll](kui_shell_core.Tab.md#scroll) +- [scrollBy](kui_shell_core.Tab.md#scrollby) +- [scrollIntoView](kui_shell_core.Tab.md#scrollintoview) +- [scrollTo](kui_shell_core.Tab.md#scrollto) +- [scrollToBottom](kui_shell_core.Tab.md#scrolltobottom) +- [scrollToTop](kui_shell_core.Tab.md#scrolltotop) +- [setAttribute](kui_shell_core.Tab.md#setattribute) +- [setAttributeNS](kui_shell_core.Tab.md#setattributens) +- [setAttributeNode](kui_shell_core.Tab.md#setattributenode) +- [setAttributeNodeNS](kui_shell_core.Tab.md#setattributenodens) +- [setPointerCapture](kui_shell_core.Tab.md#setpointercapture) +- [splitCount](kui_shell_core.Tab.md#splitcount) +- [toggleAttribute](kui_shell_core.Tab.md#toggleattribute) +- [webkitMatchesSelector](kui_shell_core.Tab.md#webkitmatchesselector) + +## Properties + +### ATTRIBUTE_NODE + +• `Readonly` **ATTRIBUTE_NODE**: `number` + +#### Inherited from + +HTMLDivElement.ATTRIBUTE_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10762 + +--- + +### CDATA_SECTION_NODE + +• `Readonly` **CDATA_SECTION_NODE**: `number` + +node is a CDATASection node. + +#### Inherited from + +HTMLDivElement.CDATA_SECTION_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10766 + +--- + +### COMMENT_NODE + +• `Readonly` **COMMENT_NODE**: `number` + +node is a Comment node. + +#### Inherited from + +HTMLDivElement.COMMENT_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10770 + +--- + +### DOCUMENT_FRAGMENT_NODE + +• `Readonly` **DOCUMENT_FRAGMENT_NODE**: `number` + +node is a DocumentFragment node. + +#### Inherited from + +HTMLDivElement.DOCUMENT_FRAGMENT_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10774 + +--- + +### DOCUMENT_NODE + +• `Readonly` **DOCUMENT_NODE**: `number` + +node is a document. + +#### Inherited from + +HTMLDivElement.DOCUMENT_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10778 + +--- + +### DOCUMENT_POSITION_CONTAINED_BY + +• `Readonly` **DOCUMENT_POSITION_CONTAINED_BY**: `number` + +Set when other is a descendant of node. + +#### Inherited from + +HTMLDivElement.DOCUMENT_POSITION_CONTAINED_BY + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10782 + +--- + +### DOCUMENT_POSITION_CONTAINS + +• `Readonly` **DOCUMENT_POSITION_CONTAINS**: `number` + +Set when other is an ancestor of node. + +#### Inherited from + +HTMLDivElement.DOCUMENT_POSITION_CONTAINS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10786 + +--- + +### DOCUMENT_POSITION_DISCONNECTED + +• `Readonly` **DOCUMENT_POSITION_DISCONNECTED**: `number` + +Set when node and other are not in the same tree. + +#### Inherited from + +HTMLDivElement.DOCUMENT_POSITION_DISCONNECTED + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10790 + +--- + +### DOCUMENT_POSITION_FOLLOWING + +• `Readonly` **DOCUMENT_POSITION_FOLLOWING**: `number` + +Set when other is following node. + +#### Inherited from + +HTMLDivElement.DOCUMENT_POSITION_FOLLOWING + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10794 + +--- + +### DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC + +• `Readonly` **DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC**: `number` + +#### Inherited from + +HTMLDivElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10795 + +--- + +### DOCUMENT_POSITION_PRECEDING + +• `Readonly` **DOCUMENT_POSITION_PRECEDING**: `number` + +Set when other is preceding node. + +#### Inherited from + +HTMLDivElement.DOCUMENT_POSITION_PRECEDING + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10799 + +--- + +### DOCUMENT_TYPE_NODE + +• `Readonly` **DOCUMENT_TYPE_NODE**: `number` + +node is a doctype. + +#### Inherited from + +HTMLDivElement.DOCUMENT_TYPE_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10803 + +--- + +### ELEMENT_NODE + +• `Readonly` **ELEMENT_NODE**: `number` + +node is an element. + +#### Inherited from + +HTMLDivElement.ELEMENT_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10807 + +--- + +### ENTITY_NODE + +• `Readonly` **ENTITY_NODE**: `number` + +#### Inherited from + +HTMLDivElement.ENTITY_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10808 + +--- + +### ENTITY_REFERENCE_NODE + +• `Readonly` **ENTITY_REFERENCE_NODE**: `number` + +#### Inherited from + +HTMLDivElement.ENTITY_REFERENCE_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10809 + +--- + +### NOTATION_NODE + +• `Readonly` **NOTATION_NODE**: `number` + +#### Inherited from + +HTMLDivElement.NOTATION_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10810 + +--- + +### PROCESSING_INSTRUCTION_NODE + +• `Readonly` **PROCESSING_INSTRUCTION_NODE**: `number` + +node is a ProcessingInstruction node. + +#### Inherited from + +HTMLDivElement.PROCESSING_INSTRUCTION_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10814 + +--- + +### REPL + +• **REPL**: [`REPL`](kui_shell_core.REPL.md) + +#### Defined in + +[packages/core/src/webapp/tab.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L24) + +--- + +### TEXT_NODE + +• `Readonly` **TEXT_NODE**: `number` + +node is a Text node. + +#### Inherited from + +HTMLDivElement.TEXT_NODE + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10818 + +--- + +### \_kui_session + +• **\_kui_session**: `Promise`<`any`\> + +#### Defined in + +[packages/core/src/webapp/tab.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L27) + +--- + +### accessKey + +• **accessKey**: `string` + +#### Inherited from + +HTMLDivElement.accessKey + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6592 + +--- + +### accessKeyLabel + +• `Readonly` **accessKeyLabel**: `string` + +#### Inherited from + +HTMLDivElement.accessKeyLabel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6593 + +--- + +### align + +• **align**: `string` + +**`deprecated`** + +#### Inherited from + +HTMLDivElement.align + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6562 + +--- + +### assignedSlot + +• `Readonly` **assignedSlot**: `HTMLSlotElement` + +#### Inherited from + +HTMLDivElement.assignedSlot + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:14832 + +--- + +### attributes + +• `Readonly` **attributes**: `NamedNodeMap` + +#### Inherited from + +HTMLDivElement.attributes + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5095 + +--- + +### autocapitalize + +• **autocapitalize**: `string` + +#### Inherited from + +HTMLDivElement.autocapitalize + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6594 + +--- + +### autofocus + +• **autofocus**: `boolean` + +#### Inherited from + +HTMLDivElement.autofocus + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8006 + +--- + +### baseURI + +• `Readonly` **baseURI**: `string` + +Returns node's node document's document base URL. + +#### Inherited from + +HTMLDivElement.baseURI + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10677 + +--- + +### childElementCount + +• `Readonly` **childElementCount**: `number` + +#### Inherited from + +HTMLDivElement.childElementCount + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11233 + +--- + +### childNodes + +• `Readonly` **childNodes**: `NodeListOf`<`ChildNode`\> + +Returns the children. + +#### Inherited from + +HTMLDivElement.childNodes + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10681 + +--- + +### children + +• `Readonly` **children**: `HTMLCollection` + +Returns the child elements. + +#### Inherited from + +HTMLDivElement.children + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11237 + +--- + +### classList + +• `Readonly` **classList**: `DOMTokenList` + +Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object. + +#### Inherited from + +HTMLDivElement.classList + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5099 + +--- + +### className + +• **className**: `string` + +Returns the value of element's class content attribute. Can be set to change it. + +#### Inherited from + +HTMLDivElement.className + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5103 + +--- + +### clientHeight + +• `Readonly` **clientHeight**: `number` + +#### Inherited from + +HTMLDivElement.clientHeight + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5104 + +--- + +### clientLeft + +• `Readonly` **clientLeft**: `number` + +#### Inherited from + +HTMLDivElement.clientLeft + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5105 + +--- + +### clientTop + +• `Readonly` **clientTop**: `number` + +#### Inherited from + +HTMLDivElement.clientTop + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5106 + +--- + +### clientWidth + +• `Readonly` **clientWidth**: `number` + +#### Inherited from + +HTMLDivElement.clientWidth + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5107 + +--- + +### contentEditable + +• **contentEditable**: `string` + +#### Inherited from + +HTMLDivElement.contentEditable + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5259 + +--- + +### dataset + +• `Readonly` **dataset**: `DOMStringMap` + +#### Inherited from + +HTMLDivElement.dataset + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8007 + +--- + +### dir + +• **dir**: `string` + +#### Inherited from + +HTMLDivElement.dir + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6595 + +--- + +### draggable + +• **draggable**: `boolean` + +#### Inherited from + +HTMLDivElement.draggable + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6596 + +--- + +### enterKeyHint + +• **enterKeyHint**: `string` + +#### Inherited from + +HTMLDivElement.enterKeyHint + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5260 + +--- + +### firstChild + +• `Readonly` **firstChild**: `ChildNode` + +Returns the first child. + +#### Inherited from + +HTMLDivElement.firstChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10685 + +--- + +### firstElementChild + +• `Readonly` **firstElementChild**: `Element` + +Returns the first child that is an element, and null otherwise. + +#### Inherited from + +HTMLDivElement.firstElementChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11241 + +--- + +### hidden + +• **hidden**: `boolean` + +#### Inherited from + +HTMLDivElement.hidden + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6597 + +--- + +### id + +• **id**: `string` + +Returns the value of element's id content attribute. Can be set to change it. + +#### Inherited from + +HTMLDivElement.id + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5111 + +--- + +### innerHTML + +• **innerHTML**: `string` + +#### Inherited from + +HTMLDivElement.innerHTML + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:9588 + +--- + +### innerText + +• **innerText**: `string` + +#### Inherited from + +HTMLDivElement.innerText + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6598 + +--- + +### inputMode + +• **inputMode**: `string` + +#### Inherited from + +HTMLDivElement.inputMode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5261 + +--- + +### isConnected + +• `Readonly` **isConnected**: `boolean` + +Returns true if node is connected and false otherwise. + +#### Inherited from + +HTMLDivElement.isConnected + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10689 + +--- + +### isContentEditable + +• `Readonly` **isContentEditable**: `boolean` + +#### Inherited from + +HTMLDivElement.isContentEditable + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5262 + +--- + +### lang + +• **lang**: `string` + +#### Inherited from + +HTMLDivElement.lang + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6599 + +--- + +### lastChild + +• `Readonly` **lastChild**: `ChildNode` + +Returns the last child. + +#### Inherited from + +HTMLDivElement.lastChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10693 + +--- + +### lastElementChild + +• `Readonly` **lastElementChild**: `Element` + +Returns the last child that is an element, and null otherwise. + +#### Inherited from + +HTMLDivElement.lastElementChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11245 + +--- + +### localName + +• `Readonly` **localName**: `string` + +Returns the local name. + +#### Inherited from + +HTMLDivElement.localName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5115 + +--- + +### namespaceURI + +• `Readonly` **namespaceURI**: `string` + +Returns the namespace. + +#### Inherited from + +HTMLDivElement.namespaceURI + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5119 + +--- + +### nextElementSibling + +• `Readonly` **nextElementSibling**: `Element` + +Returns the first following sibling that is an element, and null otherwise. + +#### Inherited from + +HTMLDivElement.nextElementSibling + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10963 + +--- + +### nextSibling + +• `Readonly` **nextSibling**: `ChildNode` + +Returns the next sibling. + +#### Inherited from + +HTMLDivElement.nextSibling + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10699 + +--- + +### nodeName + +• `Readonly` **nodeName**: `string` + +Returns a string appropriate for the type of node. + +#### Inherited from + +HTMLDivElement.nodeName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10703 + +--- + +### nodeType + +• `Readonly` **nodeType**: `number` + +Returns the type of node. + +#### Inherited from + +HTMLDivElement.nodeType + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10707 + +--- + +### nodeValue + +• **nodeValue**: `string` + +#### Inherited from + +HTMLDivElement.nodeValue + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10708 + +--- + +### nonce + +• `Optional` **nonce**: `string` + +#### Inherited from + +HTMLDivElement.nonce + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8008 + +--- + +### offsetHeight + +• `Readonly` **offsetHeight**: `number` + +#### Inherited from + +HTMLDivElement.offsetHeight + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6600 + +--- + +### offsetLeft + +• `Readonly` **offsetLeft**: `number` + +#### Inherited from + +HTMLDivElement.offsetLeft + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6601 + +--- + +### offsetParent + +• `Readonly` **offsetParent**: `Element` + +#### Inherited from + +HTMLDivElement.offsetParent + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6602 + +--- + +### offsetTop + +• `Readonly` **offsetTop**: `number` + +#### Inherited from + +HTMLDivElement.offsetTop + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6603 + +--- + +### offsetWidth + +• `Readonly` **offsetWidth**: `number` + +#### Inherited from + +HTMLDivElement.offsetWidth + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6604 + +--- + +### onabort + +• **onabort**: (`ev`: `UIEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user aborts the download. + +##### Parameters + +| Name | Type | Description | +| :--- | :-------- | :---------- | +| `ev` | `UIEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onabort + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5805 + +--- + +### onanimationcancel + +• **onanimationcancel**: (`ev`: `AnimationEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `AnimationEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onanimationcancel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5806 + +--- + +### onanimationend + +• **onanimationend**: (`ev`: `AnimationEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `AnimationEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onanimationend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5807 + +--- + +### onanimationiteration + +• **onanimationiteration**: (`ev`: `AnimationEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `AnimationEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onanimationiteration + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5808 + +--- + +### onanimationstart + +• **onanimationstart**: (`ev`: `AnimationEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `AnimationEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onanimationstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5809 + +--- + +### onauxclick + +• **onauxclick**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `MouseEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onauxclick + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5810 + +--- + +### onblur + +• **onblur**: (`ev`: `FocusEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the object loses the input focus. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `FocusEvent` | The focus event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onblur + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5815 + +--- + +### oncancel + +• **oncancel**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.oncancel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5816 + +--- + +### oncanplay + +• **oncanplay**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when playback is possible, but would require further buffering. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.oncanplay + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5821 + +--- + +### oncanplaythrough + +• **oncanplaythrough**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.oncanplaythrough + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5822 + +--- + +### onchange + +• **onchange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the contents of the object or selection have changed. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onchange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5827 + +--- + +### onclick + +• **onclick**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user clicks the left mouse button on the object + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onclick + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5832 + +--- + +### onclose + +• **onclose**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onclose + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5833 + +--- + +### oncontextmenu + +• **oncontextmenu**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user clicks the right mouse button in the client area, opening the context menu. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.oncontextmenu + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5838 + +--- + +### oncopy + +• **oncopy**: (`ev`: `ClipboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `ClipboardEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.oncopy + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:4899 + +--- + +### oncuechange + +• **oncuechange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.oncuechange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5839 + +--- + +### oncut + +• **oncut**: (`ev`: `ClipboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `ClipboardEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.oncut + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:4900 + +--- + +### ondblclick + +• **ondblclick**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user double-clicks the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ondblclick + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5844 + +--- + +### ondrag + +• **ondrag**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the source object continuously during a drag operation. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :---------- | +| `ev` | `DragEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ondrag + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5849 + +--- + +### ondragend + +• **ondragend**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the source object when the user releases the mouse at the close of a drag operation. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :---------- | +| `ev` | `DragEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ondragend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5854 + +--- + +### ondragenter + +• **ondragenter**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the target element when the user drags the object to a valid drop target. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :-------------- | +| `ev` | `DragEvent` | The drag event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ondragenter + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5859 + +--- + +### ondragexit + +• **ondragexit**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ondragexit + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5860 + +--- + +### ondragleave + +• **ondragleave**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :-------------- | +| `ev` | `DragEvent` | The drag event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ondragleave + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5865 + +--- + +### ondragover + +• **ondragover**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the target element continuously while the user drags the object over a valid drop target. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :---------- | +| `ev` | `DragEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ondragover + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5870 + +--- + +### ondragstart + +• **ondragstart**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires on the source object when the user starts to drag a text selection or selected object. + +##### Parameters + +| Name | Type | Description | +| :--- | :---------- | :---------- | +| `ev` | `DragEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ondragstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5875 + +--- + +### ondrop + +• **ondrop**: (`ev`: `DragEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :---------- | +| `ev` | `DragEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ondrop + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5876 + +--- + +### ondurationchange + +• **ondurationchange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the duration attribute is updated. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ondurationchange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5881 + +--- + +### onemptied + +• **onemptied**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the media element is reset to its initial state. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onemptied + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5886 + +--- + +### onended + +• **onended**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the end of playback is reached. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onended + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5891 + +--- + +### onerror + +• **onerror**: `OnErrorEventHandlerNonNull` + +Fires when an error occurs during object loading. + +**`param`** The event. + +#### Inherited from + +HTMLDivElement.onerror + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5896 + +--- + +### onfocus + +• **onfocus**: (`ev`: `FocusEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the object receives focus. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :---------- | +| `ev` | `FocusEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onfocus + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5901 + +--- + +### onfullscreenchange + +• **onfullscreenchange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onfullscreenchange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5120 + +--- + +### onfullscreenerror + +• **onfullscreenerror**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onfullscreenerror + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5121 + +--- + +### ongotpointercapture + +• **ongotpointercapture**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ongotpointercapture + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5902 + +--- + +### oninput + +• **oninput**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.oninput + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5903 + +--- + +### oninvalid + +• **oninvalid**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.oninvalid + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5904 + +--- + +### onkeydown + +• **onkeydown**: (`ev`: `KeyboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user presses a key. + +##### Parameters + +| Name | Type | Description | +| :--- | :-------------- | :----------------- | +| `ev` | `KeyboardEvent` | The keyboard event | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onkeydown + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5909 + +--- + +### onkeypress + +• **onkeypress**: (`ev`: `KeyboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user presses an alphanumeric key. + +##### Parameters + +| Name | Type | Description | +| :--- | :-------------- | :---------- | +| `ev` | `KeyboardEvent` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onkeypress + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5914 + +--- + +### onkeyup + +• **onkeyup**: (`ev`: `KeyboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user releases a key. + +##### Parameters + +| Name | Type | Description | +| :--- | :-------------- | :----------------- | +| `ev` | `KeyboardEvent` | The keyboard event | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onkeyup + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5919 + +--- + +### onload + +• **onload**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires immediately after the browser loads the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onload + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5924 + +--- + +### onloadeddata + +• **onloadeddata**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when media data is loaded at the current playback position. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onloadeddata + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5929 + +--- + +### onloadedmetadata + +• **onloadedmetadata**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the duration and dimensions of the media have been determined. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onloadedmetadata + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5934 + +--- + +### onloadstart + +• **onloadstart**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when Internet Explorer begins looking for media data. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onloadstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5939 + +--- + +### onlostpointercapture + +• **onlostpointercapture**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onlostpointercapture + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5940 + +--- + +### onmousedown + +• **onmousedown**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user clicks the object with either mouse button. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onmousedown + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5945 + +--- + +### onmouseenter + +• **onmouseenter**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `MouseEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onmouseenter + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5946 + +--- + +### onmouseleave + +• **onmouseleave**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `MouseEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onmouseleave + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5947 + +--- + +### onmousemove + +• **onmousemove**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user moves the mouse over the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onmousemove + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5952 + +--- + +### onmouseout + +• **onmouseout**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user moves the mouse pointer outside the boundaries of the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onmouseout + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5957 + +--- + +### onmouseover + +• **onmouseover**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user moves the mouse pointer into the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onmouseover + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5962 + +--- + +### onmouseup + +• **onmouseup**: (`ev`: `MouseEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user releases a mouse button while the mouse is over the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :----------- | :--------------- | +| `ev` | `MouseEvent` | The mouse event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onmouseup + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5967 + +--- + +### onpaste + +• **onpaste**: (`ev`: `ClipboardEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :--------------- | +| `ev` | `ClipboardEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onpaste + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:4901 + +--- + +### onpause + +• **onpause**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when playback is paused. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onpause + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5972 + +--- + +### onplay + +• **onplay**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the play method is requested. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onplay + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5977 + +--- + +### onplaying + +• **onplaying**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the audio or video has started playing. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onplaying + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5982 + +--- + +### onpointercancel + +• **onpointercancel**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onpointercancel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5983 + +--- + +### onpointerdown + +• **onpointerdown**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onpointerdown + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5984 + +--- + +### onpointerenter + +• **onpointerenter**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onpointerenter + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5985 + +--- + +### onpointerleave + +• **onpointerleave**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onpointerleave + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5986 + +--- + +### onpointermove + +• **onpointermove**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onpointermove + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5987 + +--- + +### onpointerout + +• **onpointerout**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onpointerout + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5988 + +--- + +### onpointerover + +• **onpointerover**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onpointerover + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5989 + +--- + +### onpointerup + +• **onpointerup**: (`ev`: `PointerEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------------- | +| `ev` | `PointerEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onpointerup + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5990 + +--- + +### onprogress + +• **onprogress**: (`ev`: `ProgressEvent`<`EventTarget`\>) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs to indicate progress while downloading media data. + +##### Parameters + +| Name | Type | Description | +| :--- | :------------------------------ | :---------- | +| `ev` | `ProgressEvent`<`EventTarget`\> | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onprogress + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5995 + +--- + +### onratechange + +• **onratechange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the playback rate is increased or decreased. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onratechange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6000 + +--- + +### onreset + +• **onreset**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user resets a form. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onreset + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6005 + +--- + +### onresize + +• **onresize**: (`ev`: `UIEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :-------- | +| `ev` | `UIEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onresize + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6006 + +--- + +### onscroll + +• **onscroll**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the user repositions the scroll box in the scroll bar on the object. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onscroll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6011 + +--- + +### onsecuritypolicyviolation + +• **onsecuritypolicyviolation**: (`ev`: `SecurityPolicyViolationEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------------------------- | +| `ev` | `SecurityPolicyViolationEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onsecuritypolicyviolation + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6012 + +--- + +### onseeked + +• **onseeked**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the seek operation ends. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onseeked + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6017 + +--- + +### onseeking + +• **onseeking**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the current playback position is moved. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onseeking + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6022 + +--- + +### onselect + +• **onselect**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Fires when the current selection changes. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onselect + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6027 + +--- + +### onselectionchange + +• **onselectionchange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onselectionchange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6028 + +--- + +### onselectstart + +• **onselectstart**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onselectstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6029 + +--- + +### onstalled + +• **onstalled**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the download has stopped. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onstalled + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6034 + +--- + +### onsubmit + +• **onsubmit**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onsubmit + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6035 + +--- + +### onsuspend + +• **onsuspend**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs if the load operation has been intentionally halted. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onsuspend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6040 + +--- + +### ontimeupdate + +• **ontimeupdate**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs to indicate the current playback position. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ontimeupdate + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6045 + +--- + +### ontoggle + +• **ontoggle**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :------ | +| `ev` | `Event` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ontoggle + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6046 + +--- + +### ontouchcancel + +• `Optional` **ontouchcancel**: (`ev`: `TouchEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `TouchEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ontouchcancel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6047 + +--- + +### ontouchend + +• `Optional` **ontouchend**: (`ev`: `TouchEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `TouchEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ontouchend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6048 + +--- + +### ontouchmove + +• `Optional` **ontouchmove**: (`ev`: `TouchEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `TouchEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ontouchmove + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6049 + +--- + +### ontouchstart + +• `Optional` **ontouchstart**: (`ev`: `TouchEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `TouchEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ontouchstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6050 + +--- + +### ontransitioncancel + +• **ontransitioncancel**: (`ev`: `TransitionEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :---------------- | +| `ev` | `TransitionEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ontransitioncancel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6051 + +--- + +### ontransitionend + +• **ontransitionend**: (`ev`: `TransitionEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :---------------- | +| `ev` | `TransitionEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ontransitionend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6052 + +--- + +### ontransitionrun + +• **ontransitionrun**: (`ev`: `TransitionEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :---------------- | +| `ev` | `TransitionEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ontransitionrun + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6053 + +--- + +### ontransitionstart + +• **ontransitionstart**: (`ev`: `TransitionEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :---------------- | +| `ev` | `TransitionEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.ontransitionstart + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6054 + +--- + +### onvolumechange + +• **onvolumechange**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when the volume is changed, or playback is muted or unmuted. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onvolumechange + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6059 + +--- + +### onwaiting + +• **onwaiting**: (`ev`: `Event`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +Occurs when playback stops because the next frame of a video resource is not available. + +##### Parameters + +| Name | Type | Description | +| :--- | :------ | :---------- | +| `ev` | `Event` | The event. | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onwaiting + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6064 + +--- + +### onwheel + +• **onwheel**: (`ev`: `WheelEvent`) => `any` + +#### Type declaration + +▸ (`ev`): `any` + +##### Parameters + +| Name | Type | +| :--- | :----------- | +| `ev` | `WheelEvent` | + +##### Returns + +`any` + +#### Inherited from + +HTMLDivElement.onwheel + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6065 + +--- + +### outerHTML + +• **outerHTML**: `string` + +#### Inherited from + +HTMLDivElement.outerHTML + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5122 + +--- + +### ownerDocument + +• `Readonly` **ownerDocument**: `Document` + +#### Inherited from + +HTMLDivElement.ownerDocument + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5123 + +--- + +### parentElement + +• `Readonly` **parentElement**: `HTMLElement` + +Returns the parent element. + +#### Inherited from + +HTMLDivElement.parentElement + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10716 + +--- + +### parentNode + +• `Readonly` **parentNode**: `Node` & `ParentNode` + +Returns the parent. + +#### Inherited from + +HTMLDivElement.parentNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10720 + +--- + +### prefix + +• `Readonly` **prefix**: `string` + +Returns the namespace prefix. + +#### Inherited from + +HTMLDivElement.prefix + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5127 + +--- + +### previousElementSibling + +• `Readonly` **previousElementSibling**: `Element` + +Returns the first preceding sibling that is an element, and null otherwise. + +#### Inherited from + +HTMLDivElement.previousElementSibling + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10967 + +--- + +### previousSibling + +• `Readonly` **previousSibling**: `ChildNode` + +Returns the previous sibling. + +#### Inherited from + +HTMLDivElement.previousSibling + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10724 + +--- + +### queueListener + +• **queueListener**: `EventListener` + +#### Defined in + +[packages/core/src/webapp/tab.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L26) + +--- + +### scrollHeight + +• `Readonly` **scrollHeight**: `number` + +#### Inherited from + +HTMLDivElement.scrollHeight + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5128 + +--- + +### scrollLeft + +• **scrollLeft**: `number` + +#### Inherited from + +HTMLDivElement.scrollLeft + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5129 + +--- + +### scrollTop + +• **scrollTop**: `number` + +#### Inherited from + +HTMLDivElement.scrollTop + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5130 + +--- + +### scrollWidth + +• `Readonly` **scrollWidth**: `number` + +#### Inherited from + +HTMLDivElement.scrollWidth + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5131 + +--- + +### shadowRoot + +• `Readonly` **shadowRoot**: `ShadowRoot` + +Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise. + +#### Inherited from + +HTMLDivElement.shadowRoot + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5135 + +--- + +### slot + +• **slot**: `string` + +Returns the value of element's slot content attribute. Can be set to change it. + +#### Inherited from + +HTMLDivElement.slot + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5139 + +--- + +### spellcheck + +• **spellcheck**: `boolean` + +#### Inherited from + +HTMLDivElement.spellcheck + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6605 + +--- + +### state + +• **state**: [`TabState`](../classes/kui_shell_core.TabState.md) + +#### Defined in + +[packages/core/src/webapp/tab.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L25) + +--- + +### style + +• `Readonly` **style**: `CSSStyleDeclaration` + +#### Inherited from + +HTMLDivElement.style + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5255 + +--- + +### tabIndex + +• **tabIndex**: `number` + +#### Inherited from + +HTMLDivElement.tabIndex + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8009 + +--- + +### tagName + +• `Readonly` **tagName**: `string` + +Returns the HTML-uppercased qualified name. + +#### Inherited from + +HTMLDivElement.tagName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5143 + +--- + +### textContent + +• **textContent**: `string` + +#### Inherited from + +HTMLDivElement.textContent + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10725 + +--- + +### title + +• **title**: `string` + +#### Inherited from + +HTMLDivElement.title + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6606 + +--- + +### translate + +• **translate**: `boolean` + +#### Inherited from + +HTMLDivElement.translate + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6607 + +--- + +### uuid + +• **uuid**: `string` + +#### Defined in + +[packages/core/src/webapp/tab.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L23) + +## Methods + +### addClass + +▸ **addClass**(`cls`): `void` + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `cls` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/tab.ts:32](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L32) + +--- + +### addEventListener + +▸ **addEventListener**<`K`\>(`type`, `listener`, `options?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------- | +| `K` | extends keyof `HTMLElementEventMap` | + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------ | +| `type` | `K` | +| `listener` | (`ev`: `HTMLElementEventMap`[`K`]) => `any` | +| `options?` | `boolean` \| `AddEventListenerOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.addEventListener + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6563 + +▸ **addEventListener**(`type`, `listener`, `options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------- | +| `type` | `string` | +| `listener` | `EventListenerOrEventListenerObject` | +| `options?` | `boolean` \| `AddEventListenerOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.addEventListener + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6564 + +--- + +### after + +▸ **after**(...`nodes`): `void` + +Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------- | +| `...nodes` | (`string` \| `Node`)[] | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.after + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:3537 + +--- + +### animate + +▸ **animate**(`keyframes`, `options?`): `Animation` + +#### Parameters + +| Name | Type | +| :---------- | :----------------------------------------- | +| `keyframes` | `Keyframe`[] \| `PropertyIndexedKeyframes` | +| `options?` | `number` \| `KeyframeAnimationOptions` | + +#### Returns + +`Animation` + +#### Inherited from + +HTMLDivElement.animate + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:2073 + +--- + +### append + +▸ **append**(...`nodes`): `void` + +Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------- | +| `...nodes` | (`string` \| `Node`)[] | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.append + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11251 + +--- + +### appendChild + +▸ **appendChild**<`T`\>(`newChild`): `T` + +#### Type parameters + +| Name | Type | +| :--- | :------------- | +| `T` | extends `Node` | + +#### Parameters + +| Name | Type | +| :--------- | :--- | +| `newChild` | `T` | + +#### Returns + +`T` + +#### Inherited from + +HTMLDivElement.appendChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10726 + +--- + +### attachShadow + +▸ **attachShadow**(`init`): `ShadowRoot` + +Creates a shadow root for element and returns it. + +#### Parameters + +| Name | Type | +| :----- | :--------------- | +| `init` | `ShadowRootInit` | + +#### Returns + +`ShadowRoot` + +#### Inherited from + +HTMLDivElement.attachShadow + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5147 + +--- + +### before + +▸ **before**(...`nodes`): `void` + +Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------- | +| `...nodes` | (`string` \| `Node`)[] | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.before + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:3543 + +--- + +### blur + +▸ **blur**(): `void` + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.blur + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8010 + +--- + +### click + +▸ **click**(): `void` + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.click + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6608 + +--- + +### cloneNode + +▸ **cloneNode**(`deep?`): `Node` + +Returns a copy of node. If deep is true, the copy also includes the node's descendants. + +#### Parameters + +| Name | Type | +| :------ | :-------- | +| `deep?` | `boolean` | + +#### Returns + +`Node` + +#### Inherited from + +HTMLDivElement.cloneNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10730 + +--- + +### closest + +▸ **closest**<`K`\>(`selector`): `HTMLElementTagNameMap`[`K`] + +Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise. + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------ | +| `K` | extends keyof `HTMLElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :--------- | :--- | +| `selector` | `K` | + +#### Returns + +`HTMLElementTagNameMap`[`K`] + +#### Inherited from + +HTMLDivElement.closest + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5151 + +▸ **closest**<`K`\>(`selector`): `SVGElementTagNameMap`[`K`] + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------- | +| `K` | extends keyof `SVGElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :--------- | :--- | +| `selector` | `K` | + +#### Returns + +`SVGElementTagNameMap`[`K`] + +#### Inherited from + +HTMLDivElement.closest + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5152 + +▸ **closest**<`E`\>(`selector`): `E` + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------- | +| `E` | extends ` Element``Element ` | + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `selector` | `string` | + +#### Returns + +`E` + +#### Inherited from + +HTMLDivElement.closest + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5153 + +--- + +### compareDocumentPosition + +▸ **compareDocumentPosition**(`other`): `number` + +Returns a bitmask indicating the position of other relative to node. + +#### Parameters + +| Name | Type | +| :------ | :----- | +| `other` | `Node` | + +#### Returns + +`number` + +#### Inherited from + +HTMLDivElement.compareDocumentPosition + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10734 + +--- + +### contains + +▸ **contains**(`other`): `boolean` + +Returns true if other is an inclusive descendant of node, and false otherwise. + +#### Parameters + +| Name | Type | +| :------ | :----- | +| `other` | `Node` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.contains + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10738 + +--- + +### dispatchEvent + +▸ **dispatchEvent**(`event`): `boolean` + +Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `Event` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.dispatchEvent + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5423 + +--- + +### focus + +▸ **focus**(`options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :------------- | +| `options?` | `FocusOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.focus + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:8011 + +--- + +### getAnimations + +▸ **getAnimations**(): `Animation`[] + +#### Returns + +`Animation`[] + +#### Inherited from + +HTMLDivElement.getAnimations + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:2074 + +--- + +### getAttribute + +▸ **getAttribute**(`qualifiedName`): `string` + +Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise. + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | + +#### Returns + +`string` + +#### Inherited from + +HTMLDivElement.getAttribute + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5157 + +--- + +### getAttributeNS + +▸ **getAttributeNS**(`namespace`, `localName`): `string` + +Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise. + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | +| `localName` | `string` | + +#### Returns + +`string` + +#### Inherited from + +HTMLDivElement.getAttributeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5161 + +--- + +### getAttributeNames + +▸ **getAttributeNames**(): `string`[] + +Returns the qualified names of all element's attributes. Can contain duplicates. + +#### Returns + +`string`[] + +#### Inherited from + +HTMLDivElement.getAttributeNames + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5165 + +--- + +### getAttributeNode + +▸ **getAttributeNode**(`qualifiedName`): `Attr` + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | + +#### Returns + +`Attr` + +#### Inherited from + +HTMLDivElement.getAttributeNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5166 + +--- + +### getAttributeNodeNS + +▸ **getAttributeNodeNS**(`namespace`, `localName`): `Attr` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | +| `localName` | `string` | + +#### Returns + +`Attr` + +#### Inherited from + +HTMLDivElement.getAttributeNodeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5167 + +--- + +### getBoundingClientRect + +▸ **getBoundingClientRect**(): `DOMRect` + +#### Returns + +`DOMRect` + +#### Inherited from + +HTMLDivElement.getBoundingClientRect + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5168 + +--- + +### getClientRects + +▸ **getClientRects**(): `DOMRectList` + +#### Returns + +`DOMRectList` + +#### Inherited from + +HTMLDivElement.getClientRects + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5169 + +--- + +### getElementsByClassName + +▸ **getElementsByClassName**(`classNames`): `HTMLCollectionOf`<`Element`\> + +Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes. + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `classNames` | `string` | + +#### Returns + +`HTMLCollectionOf`<`Element`\> + +#### Inherited from + +HTMLDivElement.getElementsByClassName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5173 + +--- + +### getElementsByTagName + +▸ **getElementsByTagName**<`K`\>(`qualifiedName`): `HTMLCollectionOf`<`HTMLElementTagNameMap`[`K`]\> + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------ | +| `K` | extends keyof `HTMLElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :-------------- | :--- | +| `qualifiedName` | `K` | + +#### Returns + +`HTMLCollectionOf`<`HTMLElementTagNameMap`[`K`]\> + +#### Inherited from + +HTMLDivElement.getElementsByTagName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5174 + +▸ **getElementsByTagName**<`K`\>(`qualifiedName`): `HTMLCollectionOf`<`SVGElementTagNameMap`[`K`]\> + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------- | +| `K` | extends keyof `SVGElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :-------------- | :--- | +| `qualifiedName` | `K` | + +#### Returns + +`HTMLCollectionOf`<`SVGElementTagNameMap`[`K`]\> + +#### Inherited from + +HTMLDivElement.getElementsByTagName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5175 + +▸ **getElementsByTagName**(`qualifiedName`): `HTMLCollectionOf`<`Element`\> + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | + +#### Returns + +`HTMLCollectionOf`<`Element`\> + +#### Inherited from + +HTMLDivElement.getElementsByTagName + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5176 + +--- + +### getElementsByTagNameNS + +▸ **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`<`HTMLElement`\> + +#### Parameters + +| Name | Type | +| :------------- | :------------------------------- | +| `namespaceURI` | `"http://www.w3.org/1999/xhtml"` | +| `localName` | `string` | + +#### Returns + +`HTMLCollectionOf`<`HTMLElement`\> + +#### Inherited from + +HTMLDivElement.getElementsByTagNameNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5177 + +▸ **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`<`SVGElement`\> + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------- | +| `namespaceURI` | `"http://www.w3.org/2000/svg"` | +| `localName` | `string` | + +#### Returns + +`HTMLCollectionOf`<`SVGElement`\> + +#### Inherited from + +HTMLDivElement.getElementsByTagNameNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5178 + +▸ **getElementsByTagNameNS**(`namespaceURI`, `localName`): `HTMLCollectionOf`<`Element`\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `namespaceURI` | `string` | +| `localName` | `string` | + +#### Returns + +`HTMLCollectionOf`<`Element`\> + +#### Inherited from + +HTMLDivElement.getElementsByTagNameNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5179 + +--- + +### getRootNode + +▸ **getRootNode**(`options?`): `Node` + +Returns node's root. + +#### Parameters + +| Name | Type | +| :--------- | :------------------- | +| `options?` | `GetRootNodeOptions` | + +#### Returns + +`Node` + +#### Inherited from + +HTMLDivElement.getRootNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10742 + +--- + +### getSize + +▸ **getSize**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------- | :------- | +| `height` | `number` | +| `width` | `number` | + +#### Defined in + +[packages/core/src/webapp/tab.ts:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L37) + +--- + +### hasAttribute + +▸ **hasAttribute**(`qualifiedName`): `boolean` + +Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise. + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.hasAttribute + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5183 + +--- + +### hasAttributeNS + +▸ **hasAttributeNS**(`namespace`, `localName`): `boolean` + +Returns true if element has an attribute whose namespace is namespace and local name is localName. + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | +| `localName` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.hasAttributeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5187 + +--- + +### hasAttributes + +▸ **hasAttributes**(): `boolean` + +Returns true if element has attributes, and false otherwise. + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.hasAttributes + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5191 + +--- + +### hasChildNodes + +▸ **hasChildNodes**(): `boolean` + +Returns whether node has children. + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.hasChildNodes + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10746 + +--- + +### hasPointerCapture + +▸ **hasPointerCapture**(`pointerId`): `boolean` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `pointerId` | `number` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.hasPointerCapture + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5192 + +--- + +### hasSideBySideTerminals + +▸ **hasSideBySideTerminals**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/webapp/tab.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L40) + +--- + +### insertAdjacentElement + +▸ **insertAdjacentElement**(`position`, `insertedElement`): `Element` + +#### Parameters + +| Name | Type | +| :---------------- | :--------------- | +| `position` | `InsertPosition` | +| `insertedElement` | `Element` | + +#### Returns + +`Element` + +#### Inherited from + +HTMLDivElement.insertAdjacentElement + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5193 + +--- + +### insertAdjacentHTML + +▸ **insertAdjacentHTML**(`where`, `html`): `void` + +#### Parameters + +| Name | Type | +| :------ | :--------------- | +| `where` | `InsertPosition` | +| `html` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.insertAdjacentHTML + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5194 + +--- + +### insertAdjacentText + +▸ **insertAdjacentText**(`where`, `text`): `void` + +#### Parameters + +| Name | Type | +| :------ | :--------------- | +| `where` | `InsertPosition` | +| `text` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.insertAdjacentText + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5195 + +--- + +### insertBefore + +▸ **insertBefore**<`T`\>(`newChild`, `refChild`): `T` + +#### Type parameters + +| Name | Type | +| :--- | :------------- | +| `T` | extends `Node` | + +#### Parameters + +| Name | Type | +| :--------- | :----- | +| `newChild` | `T` | +| `refChild` | `Node` | + +#### Returns + +`T` + +#### Inherited from + +HTMLDivElement.insertBefore + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10747 + +--- + +### isDefaultNamespace + +▸ **isDefaultNamespace**(`namespace`): `boolean` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.isDefaultNamespace + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10748 + +--- + +### isEqualNode + +▸ **isEqualNode**(`otherNode`): `boolean` + +Returns whether node and otherNode have the same properties. + +#### Parameters + +| Name | Type | +| :---------- | :----- | +| `otherNode` | `Node` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.isEqualNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10752 + +--- + +### isSameNode + +▸ **isSameNode**(`otherNode`): `boolean` + +#### Parameters + +| Name | Type | +| :---------- | :----- | +| `otherNode` | `Node` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.isSameNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10753 + +--- + +### lookupNamespaceURI + +▸ **lookupNamespaceURI**(`prefix`): `string` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `prefix` | `string` | + +#### Returns + +`string` + +#### Inherited from + +HTMLDivElement.lookupNamespaceURI + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10754 + +--- + +### lookupPrefix + +▸ **lookupPrefix**(`namespace`): `string` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | + +#### Returns + +`string` + +#### Inherited from + +HTMLDivElement.lookupPrefix + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10755 + +--- + +### matches + +▸ **matches**(`selectors`): `boolean` + +Returns true if matching selectors against element's root yields element, and false otherwise. + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `selectors` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.matches + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5199 + +--- + +### msGetRegionContent + +▸ **msGetRegionContent**(): `any` + +#### Returns + +`any` + +#### Inherited from + +HTMLDivElement.msGetRegionContent + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5200 + +--- + +### normalize + +▸ **normalize**(): `void` + +Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes. + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.normalize + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10759 + +--- + +### offActivate + +▸ **offActivate**(`handler`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------- | +| `handler` | (`isActive`: `boolean`) => `void` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/tab.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L30) + +--- + +### onActivate + +▸ **onActivate**(`handler`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------- | +| `handler` | (`isActive`: `boolean`) => `void` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/tab.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L29) + +--- + +### prepend + +▸ **prepend**(...`nodes`): `void` + +Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------- | +| `...nodes` | (`string` \| `Node`)[] | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.prepend + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11257 + +--- + +### querySelector + +▸ **querySelector**<`K`\>(`selectors`): `HTMLElementTagNameMap`[`K`] + +Returns the first element that is a descendant of node that matches selectors. + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------ | +| `K` | extends keyof `HTMLElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :---------- | :--- | +| `selectors` | `K` | + +#### Returns + +`HTMLElementTagNameMap`[`K`] + +#### Inherited from + +HTMLDivElement.querySelector + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11261 + +▸ **querySelector**<`K`\>(`selectors`): `SVGElementTagNameMap`[`K`] + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------- | +| `K` | extends keyof `SVGElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :---------- | :--- | +| `selectors` | `K` | + +#### Returns + +`SVGElementTagNameMap`[`K`] + +#### Inherited from + +HTMLDivElement.querySelector + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11262 + +▸ **querySelector**<`E`\>(`selectors`): `E` + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------- | +| `E` | extends ` Element``Element ` | + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `selectors` | `string` | + +#### Returns + +`E` + +#### Inherited from + +HTMLDivElement.querySelector + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11263 + +--- + +### querySelectorAll + +▸ **querySelectorAll**<`K`\>(`selectors`): `NodeListOf`<`HTMLElementTagNameMap`[`K`]\> + +Returns all element descendants of node that match selectors. + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------ | +| `K` | extends keyof `HTMLElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :---------- | :--- | +| `selectors` | `K` | + +#### Returns + +`NodeListOf`<`HTMLElementTagNameMap`[`K`]\> + +#### Inherited from + +HTMLDivElement.querySelectorAll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11267 + +▸ **querySelectorAll**<`K`\>(`selectors`): `NodeListOf`<`SVGElementTagNameMap`[`K`]\> + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------- | +| `K` | extends keyof `SVGElementTagNameMap` | + +#### Parameters + +| Name | Type | +| :---------- | :--- | +| `selectors` | `K` | + +#### Returns + +`NodeListOf`<`SVGElementTagNameMap`[`K`]\> + +#### Inherited from + +HTMLDivElement.querySelectorAll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11268 + +▸ **querySelectorAll**<`E`\>(`selectors`): `NodeListOf`<`E`\> + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------- | +| `E` | extends ` Element``Element ` | + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `selectors` | `string` | + +#### Returns + +`NodeListOf`<`E`\> + +#### Inherited from + +HTMLDivElement.querySelectorAll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:11269 + +--- + +### releasePointerCapture + +▸ **releasePointerCapture**(`pointerId`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `pointerId` | `number` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.releasePointerCapture + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5201 + +--- + +### remove + +▸ **remove**(): `void` + +Removes node. + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.remove + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:3547 + +--- + +### removeAttribute + +▸ **removeAttribute**(`qualifiedName`): `void` + +Removes element's first attribute whose qualified name is qualifiedName. + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.removeAttribute + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5205 + +--- + +### removeAttributeNS + +▸ **removeAttributeNS**(`namespace`, `localName`): `void` + +Removes element's attribute whose namespace is namespace and local name is localName. + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `namespace` | `string` | +| `localName` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.removeAttributeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5209 + +--- + +### removeAttributeNode + +▸ **removeAttributeNode**(`attr`): `Attr` + +#### Parameters + +| Name | Type | +| :----- | :----- | +| `attr` | `Attr` | + +#### Returns + +`Attr` + +#### Inherited from + +HTMLDivElement.removeAttributeNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5210 + +--- + +### removeChild + +▸ **removeChild**<`T`\>(`oldChild`): `T` + +#### Type parameters + +| Name | Type | +| :--- | :------------- | +| `T` | extends `Node` | + +#### Parameters + +| Name | Type | +| :--------- | :--- | +| `oldChild` | `T` | + +#### Returns + +`T` + +#### Inherited from + +HTMLDivElement.removeChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10760 + +--- + +### removeClass + +▸ **removeClass**(`cls`): `void` + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `cls` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/tab.ts:33](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L33) + +--- + +### removeEventListener + +▸ **removeEventListener**<`K`\>(`type`, `listener`, `options?`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------- | +| `K` | extends keyof `HTMLElementEventMap` | + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------ | +| `type` | `K` | +| `listener` | (`ev`: `HTMLElementEventMap`[`K`]) => `any` | +| `options?` | `boolean` \| `EventListenerOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.removeEventListener + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6565 + +▸ **removeEventListener**(`type`, `listener`, `options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------- | +| `type` | `string` | +| `listener` | `EventListenerOrEventListenerObject` | +| `options?` | `boolean` \| `EventListenerOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.removeEventListener + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:6566 + +--- + +### replaceChild + +▸ **replaceChild**<`T`\>(`newChild`, `oldChild`): `T` + +#### Type parameters + +| Name | Type | +| :--- | :------------- | +| `T` | extends `Node` | + +#### Parameters + +| Name | Type | +| :--------- | :----- | +| `newChild` | `Node` | +| `oldChild` | `T` | + +#### Returns + +`T` + +#### Inherited from + +HTMLDivElement.replaceChild + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:10761 + +--- + +### replaceWith + +▸ **replaceWith**(...`nodes`): `void` + +Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------- | +| `...nodes` | (`string` \| `Node`)[] | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.replaceWith + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:3553 + +--- + +### requestFullscreen + +▸ **requestFullscreen**(`options?`): `Promise`<`void`\> + +Displays element fullscreen and resolves promise when done. + +When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference. + +#### Parameters + +| Name | Type | +| :--------- | :------------------ | +| `options?` | `FullscreenOptions` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +HTMLDivElement.requestFullscreen + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5216 + +--- + +### requestPointerLock + +▸ **requestPointerLock**(): `void` + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.requestPointerLock + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5217 + +--- + +### scroll + +▸ **scroll**(`options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :---------------- | +| `options?` | `ScrollToOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.scroll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5218 + +▸ **scroll**(`x`, `y`): `void` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `x` | `number` | +| `y` | `number` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.scroll + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5219 + +--- + +### scrollBy + +▸ **scrollBy**(`options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :---------------- | +| `options?` | `ScrollToOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.scrollBy + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5220 + +▸ **scrollBy**(`x`, `y`): `void` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `x` | `number` | +| `y` | `number` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.scrollBy + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5221 + +--- + +### scrollIntoView + +▸ **scrollIntoView**(`arg?`): `void` + +#### Parameters + +| Name | Type | +| :----- | :----------------------------------- | +| `arg?` | `boolean` \| `ScrollIntoViewOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.scrollIntoView + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5222 + +--- + +### scrollTo + +▸ **scrollTo**(`options?`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :---------------- | +| `options?` | `ScrollToOptions` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.scrollTo + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5223 + +▸ **scrollTo**(`x`, `y`): `void` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `x` | `number` | +| `y` | `number` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.scrollTo + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5224 + +--- + +### scrollToBottom + +▸ **scrollToBottom**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/tab.ts:36](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L36) + +--- + +### scrollToTop + +▸ **scrollToTop**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/tab.ts:35](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L35) + +--- + +### setAttribute + +▸ **setAttribute**(`qualifiedName`, `value`): `void` + +Sets the value of element's first attribute whose qualified name is qualifiedName to value. + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `qualifiedName` | `string` | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.setAttribute + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5228 + +--- + +### setAttributeNS + +▸ **setAttributeNS**(`namespace`, `qualifiedName`, `value`): `void` + +Sets the value of element's attribute whose namespace is namespace and local name is localName to value. + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `namespace` | `string` | +| `qualifiedName` | `string` | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.setAttributeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5232 + +--- + +### setAttributeNode + +▸ **setAttributeNode**(`attr`): `Attr` + +#### Parameters + +| Name | Type | +| :----- | :----- | +| `attr` | `Attr` | + +#### Returns + +`Attr` + +#### Inherited from + +HTMLDivElement.setAttributeNode + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5233 + +--- + +### setAttributeNodeNS + +▸ **setAttributeNodeNS**(`attr`): `Attr` + +#### Parameters + +| Name | Type | +| :----- | :----- | +| `attr` | `Attr` | + +#### Returns + +`Attr` + +#### Inherited from + +HTMLDivElement.setAttributeNodeNS + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5234 + +--- + +### setPointerCapture + +▸ **setPointerCapture**(`pointerId`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `pointerId` | `number` | + +#### Returns + +`void` + +#### Inherited from + +HTMLDivElement.setPointerCapture + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5235 + +--- + +### splitCount + +▸ **splitCount**(): `number` + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/webapp/tab.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L39) + +--- + +### toggleAttribute + +▸ **toggleAttribute**(`qualifiedName`, `force?`): `boolean` + +If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. + +Returns true if qualifiedName is now present, and false otherwise. + +#### Parameters + +| Name | Type | +| :-------------- | :-------- | +| `qualifiedName` | `string` | +| `force?` | `boolean` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.toggleAttribute + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5241 + +--- + +### webkitMatchesSelector + +▸ **webkitMatchesSelector**(`selectors`): `boolean` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `selectors` | `string` | + +#### Returns + +`boolean` + +#### Inherited from + +HTMLDivElement.webkitMatchesSelector + +#### Defined in + +node_modules/typescript/lib/lib.dom.d.ts:5242 diff --git a/docs/api/interfaces/kui_shell_core.TabCompletionSpec.md b/docs/api/interfaces/kui_shell_core.TabCompletionSpec.md new file mode 100644 index 00000000000..28f3d0a1a5e --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.TabCompletionSpec.md @@ -0,0 +1,40 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / TabCompletionSpec + +# Interface: TabCompletionSpec + +[@kui-shell/core](../modules/kui_shell_core.md).TabCompletionSpec + +A registrar for enumerators + +## Table of contents + +### Properties + +- [toBeCompleted](kui_shell_core.TabCompletionSpec.md#tobecompleted) +- [toBeCompletedIdx](kui_shell_core.TabCompletionSpec.md#tobecompletedidx) + +## Properties + +### toBeCompleted + +• **toBeCompleted**: `string` + +The prefix of the to-be-completed parameter that has been typed +so far. + +#### Defined in + +[packages/core/src/repl/tab-completion.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/tab-completion.ts#L29) + +--- + +### toBeCompletedIdx + +• **toBeCompletedIdx**: `number` + +An index into CommandLine.argv, or -1 if it is the trailing +argument that is to be completed. + +#### Defined in + +[packages/core/src/repl/tab-completion.ts:35](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/tab-completion.ts#L35) diff --git a/docs/api/interfaces/kui_shell_core.ThemeProperties.md b/docs/api/interfaces/kui_shell_core.ThemeProperties.md new file mode 100644 index 00000000000..78b8c9fe47f --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.ThemeProperties.md @@ -0,0 +1,34 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ThemeProperties + +# Interface: ThemeProperties + +[@kui-shell/core](../modules/kui_shell_core.md).ThemeProperties + +Properties that can be associated with component + +## Table of contents + +### Properties + +- [components](kui_shell_core.ThemeProperties.md#components) +- [topTabNames](kui_shell_core.ThemeProperties.md#toptabnames) + +## Properties + +### components + +• **components**: `"patternfly"` + +#### Defined in + +[packages/core/src/webapp/themes/Theme.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/themes/Theme.ts#L25) + +--- + +### topTabNames + +• **topTabNames**: `"command"` \| `"fixed"` + +#### Defined in + +[packages/core/src/webapp/themes/Theme.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/themes/Theme.ts#L26) diff --git a/docs/api/interfaces/kui_shell_core.ToolbarAlert.md b/docs/api/interfaces/kui_shell_core.ToolbarAlert.md new file mode 100644 index 00000000000..92a0a35d702 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.ToolbarAlert.md @@ -0,0 +1,43 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ToolbarAlert + +# Interface: ToolbarAlert + +[@kui-shell/core](../modules/kui_shell_core.md).ToolbarAlert + +## Table of contents + +### Properties + +- [body](kui_shell_core.ToolbarAlert.md#body) +- [title](kui_shell_core.ToolbarAlert.md#title) +- [type](kui_shell_core.ToolbarAlert.md#type) + +## Properties + +### body + +• `Optional` **body**: `string` + +#### Defined in + +[packages/core/src/webapp/views/toolbar-text.ts:33](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/toolbar-text.ts#L33) + +--- + +### title + +• **title**: `string` + +#### Defined in + +[packages/core/src/webapp/views/toolbar-text.ts:32](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/toolbar-text.ts#L32) + +--- + +### type + +• **type**: `ToolbarTextType` + +#### Defined in + +[packages/core/src/webapp/views/toolbar-text.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/toolbar-text.ts#L31) diff --git a/docs/api/interfaces/kui_shell_core.ToolbarText.md b/docs/api/interfaces/kui_shell_core.ToolbarText.md new file mode 100644 index 00000000000..4ebfdccd1a2 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.ToolbarText.md @@ -0,0 +1,43 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / ToolbarText + +# Interface: ToolbarText + +[@kui-shell/core](../modules/kui_shell_core.md).ToolbarText + +## Table of contents + +### Properties + +- [alerts](kui_shell_core.ToolbarText.md#alerts) +- [text](kui_shell_core.ToolbarText.md#text) +- [type](kui_shell_core.ToolbarText.md#type) + +## Properties + +### alerts + +• `Optional` **alerts**: [`ToolbarAlert`](kui_shell_core.ToolbarAlert.md)[] + +#### Defined in + +[packages/core/src/webapp/views/toolbar-text.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/toolbar-text.ts#L39) + +--- + +### text + +• **text**: `ToolbarTextValue` + +#### Defined in + +[packages/core/src/webapp/views/toolbar-text.ts:38](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/toolbar-text.ts#L38) + +--- + +### type + +• **type**: `ToolbarTextType` + +#### Defined in + +[packages/core/src/webapp/views/toolbar-text.ts:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/toolbar-text.ts#L37) diff --git a/docs/api/interfaces/kui_shell_core.UsageModel.md b/docs/api/interfaces/kui_shell_core.UsageModel.md new file mode 100644 index 00000000000..03cd45ab065 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.UsageModel.md @@ -0,0 +1,430 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / UsageModel + +# Interface: UsageModel + +[@kui-shell/core](../modules/kui_shell_core.md).UsageModel + +## Hierarchy + +- `CapabilityRequirements` + + ↳ **`UsageModel`** + +## Table of contents + +### Properties + +- [available](kui_shell_core.UsageModel.md#available) +- [breadcrumb](kui_shell_core.UsageModel.md#breadcrumb) +- [children](kui_shell_core.UsageModel.md#children) +- [command](kui_shell_core.UsageModel.md#command) +- [commandPrefix](kui_shell_core.UsageModel.md#commandprefix) +- [commandPrefixNotNeeded](kui_shell_core.UsageModel.md#commandprefixnotneeded) +- [commandSuffix](kui_shell_core.UsageModel.md#commandsuffix) +- [configuration](kui_shell_core.UsageModel.md#configuration) +- [detailedExample](kui_shell_core.UsageModel.md#detailedexample) +- [docs](kui_shell_core.UsageModel.md#docs) +- [example](kui_shell_core.UsageModel.md#example) +- [fullscreen](kui_shell_core.UsageModel.md#fullscreen) +- [header](kui_shell_core.UsageModel.md#header) +- [hide](kui_shell_core.UsageModel.md#hide) +- [intro](kui_shell_core.UsageModel.md#intro) +- [nRowsInViewport](kui_shell_core.UsageModel.md#nrowsinviewport) +- [needsUI](kui_shell_core.UsageModel.md#needsui) +- [noAuthOk](kui_shell_core.UsageModel.md#noauthok) +- [noHelp](kui_shell_core.UsageModel.md#nohelp) +- [noHelpAlias](kui_shell_core.UsageModel.md#nohelpalias) +- [oneof](kui_shell_core.UsageModel.md#oneof) +- [onlyEnforceOptions](kui_shell_core.UsageModel.md#onlyenforceoptions) +- [optional](kui_shell_core.UsageModel.md#optional) +- [parents](kui_shell_core.UsageModel.md#parents) +- [preserveCase](kui_shell_core.UsageModel.md#preservecase) +- [related](kui_shell_core.UsageModel.md#related) +- [required](kui_shell_core.UsageModel.md#required) +- [requiresLocal](kui_shell_core.UsageModel.md#requireslocal) +- [sampleInputs](kui_shell_core.UsageModel.md#sampleinputs) +- [sections](kui_shell_core.UsageModel.md#sections) +- [strict](kui_shell_core.UsageModel.md#strict) +- [synonymFor](kui_shell_core.UsageModel.md#synonymfor) +- [synonyms](kui_shell_core.UsageModel.md#synonyms) +- [title](kui_shell_core.UsageModel.md#title) + +### Methods + +- [fn](kui_shell_core.UsageModel.md#fn) + +## Properties + +### available + +• `Optional` **available**: [`UsageRow`](kui_shell_core.UsageRow.md)[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:852](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L852) + +--- + +### breadcrumb + +• `Optional` **breadcrumb**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:835](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L835) + +--- + +### children + +• `Optional` **children**: `Record`<`string`, `Object`\> + +#### Defined in + +[packages/core/src/core/usage-error.ts:831](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L831) + +--- + +### command + +• `Optional` **command**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:837](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L837) + +--- + +### commandPrefix + +• `Optional` **commandPrefix**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:846](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L846) + +--- + +### commandPrefixNotNeeded + +• `Optional` **commandPrefixNotNeeded**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:847](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L847) + +--- + +### commandSuffix + +• `Optional` **commandSuffix**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:848](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L848) + +--- + +### configuration + +• `Optional` **configuration**: `YargsParserConfiguration` + +#### Defined in + +[packages/core/src/core/usage-error.ts:828](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L828) + +--- + +### detailedExample + +• `Optional` **detailedExample**: `DetailedExample` \| `DetailedExample`[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:842](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L842) + +--- + +### docs + +• `Optional` **docs**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:839](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L839) + +--- + +### example + +• `Optional` **example**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:841](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L841) + +--- + +### fullscreen + +• `Optional` **fullscreen**: `boolean` + +#### Inherited from + +CapabilityRequirements.fullscreen + +#### Defined in + +[packages/core/src/models/command.ts:262](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L262) + +--- + +### header + +• `Optional` **header**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:840](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L840) + +--- + +### hide + +• `Optional` **hide**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:830](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L830) + +--- + +### intro + +• `Optional` **intro**: `TitledContent` + +#### Defined in + +[packages/core/src/core/usage-error.ts:844](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L844) + +--- + +### nRowsInViewport + +• `Optional` **nRowsInViewport**: `number` \| `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:856](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L856) + +--- + +### needsUI + +• `Optional` **needsUI**: `boolean` + +#### Inherited from + +CapabilityRequirements.needsUI + +#### Defined in + +[packages/core/src/models/command.ts:259](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L259) + +--- + +### noAuthOk + +• `Optional` **noAuthOk**: `boolean` \| `string`[] + +#### Inherited from + +CapabilityRequirements.noAuthOk + +#### Defined in + +[packages/core/src/models/command.ts:261](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L261) + +--- + +### noHelp + +• `Optional` **noHelp**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:819](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L819) + +--- + +### noHelpAlias + +• `Optional` **noHelpAlias**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:822](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L822) + +--- + +### oneof + +• `Optional` **oneof**: [`UsageRow`](kui_shell_core.UsageRow.md)[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:855](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L855) + +--- + +### onlyEnforceOptions + +• `Optional` **onlyEnforceOptions**: `boolean` \| `string`[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:825](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L825) + +--- + +### optional + +• `Optional` **optional**: [`UsageRow`](kui_shell_core.UsageRow.md)[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:854](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L854) + +--- + +### parents + +• `Optional` **parents**: `BreadcrumbLabel`[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:850](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L850) + +--- + +### preserveCase + +• `Optional` **preserveCase**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:849](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L849) + +--- + +### related + +• `Optional` **related**: `string`[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:851](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L851) + +--- + +### required + +• `Optional` **required**: [`UsageRow`](kui_shell_core.UsageRow.md)[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:853](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L853) + +--- + +### requiresLocal + +• `Optional` **requiresLocal**: `boolean` + +#### Inherited from + +CapabilityRequirements.requiresLocal + +#### Defined in + +[packages/core/src/models/command.ts:260](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L260) + +--- + +### sampleInputs + +• `Optional` **sampleInputs**: [`UsageRow`](kui_shell_core.UsageRow.md)[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:843](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L843) + +--- + +### sections + +• `Optional` **sections**: `UsageSection`[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:845](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L845) + +--- + +### strict + +• `Optional` **strict**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:838](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L838) + +--- + +### synonymFor + +• `Optional` **synonymFor**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:832](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L832) + +--- + +### synonyms + +• `Optional` **synonyms**: `string`[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:833](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L833) + +--- + +### title + +• `Optional` **title**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:836](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L836) + +## Methods + +### fn + +▸ `Optional` **fn**(`command`): [`UsageModel`](kui_shell_core.UsageModel.md) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `command` | `string` | + +#### Returns + +[`UsageModel`](kui_shell_core.UsageModel.md) + +#### Defined in + +[packages/core/src/core/usage-error.ts:816](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L816) diff --git a/docs/api/interfaces/kui_shell_core.UsageRow.md b/docs/api/interfaces/kui_shell_core.UsageRow.md new file mode 100644 index 00000000000..f525f097beb --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.UsageRow.md @@ -0,0 +1,340 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / UsageRow + +# Interface: UsageRow + +[@kui-shell/core](../modules/kui_shell_core.md).UsageRow + +## Table of contents + +### Properties + +- [advanced](kui_shell_core.UsageRow.md#advanced) +- [alias](kui_shell_core.UsageRow.md#alias) +- [aliases](kui_shell_core.UsageRow.md#aliases) +- [allowed](kui_shell_core.UsageRow.md#allowed) +- [allowedIsPrefixMatch](kui_shell_core.UsageRow.md#allowedisprefixmatch) +- [available](kui_shell_core.UsageRow.md#available) +- [boolean](kui_shell_core.UsageRow.md#boolean) +- [booleanOK](kui_shell_core.UsageRow.md#booleanok) +- [command](kui_shell_core.UsageRow.md#command) +- [commandPrefix](kui_shell_core.UsageRow.md#commandprefix) +- [commandSuffix](kui_shell_core.UsageRow.md#commandsuffix) +- [consumesPositional](kui_shell_core.UsageRow.md#consumespositional) +- [defaultValue](kui_shell_core.UsageRow.md#defaultvalue) +- [dir](kui_shell_core.UsageRow.md#dir) +- [docs](kui_shell_core.UsageRow.md#docs) +- [example](kui_shell_core.UsageRow.md#example) +- [file](kui_shell_core.UsageRow.md#file) +- [header](kui_shell_core.UsageRow.md#header) +- [hidden](kui_shell_core.UsageRow.md#hidden) +- [implicitOK](kui_shell_core.UsageRow.md#implicitok) +- [label](kui_shell_core.UsageRow.md#label) +- [name](kui_shell_core.UsageRow.md#name) +- [narg](kui_shell_core.UsageRow.md#narg) +- [noclick](kui_shell_core.UsageRow.md#noclick) +- [notNeededIfImplicit](kui_shell_core.UsageRow.md#notneededifimplicit) +- [numeric](kui_shell_core.UsageRow.md#numeric) +- [partial](kui_shell_core.UsageRow.md#partial) +- [positional](kui_shell_core.UsageRow.md#positional) +- [synonyms](kui_shell_core.UsageRow.md#synonyms) +- [title](kui_shell_core.UsageRow.md#title) + +## Properties + +### advanced + +• `Optional` **advanced**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:777](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L777) + +--- + +### alias + +• `Optional` **alias**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:746](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L746) + +--- + +### aliases + +• `Optional` **aliases**: `string`[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:775](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L775) + +--- + +### allowed + +• `Optional` **allowed**: (`string` \| `number` \| `boolean`)[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:791](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L791) + +--- + +### allowedIsPrefixMatch + +• `Optional` **allowedIsPrefixMatch**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:788](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L788) + +--- + +### available + +• `Optional` **available**: [`UsageRow`](kui_shell_core.UsageRow.md)[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:785](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L785) + +--- + +### boolean + +• `Optional` **boolean**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:767](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L767) + +--- + +### booleanOK + +• `Optional` **booleanOK**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:764](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L764) + +--- + +### command + +• `Optional` **command**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:741](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L741) + +--- + +### commandPrefix + +• `Optional` **commandPrefix**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:739](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L739) + +--- + +### commandSuffix + +• `Optional` **commandSuffix**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:740](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L740) + +--- + +### consumesPositional + +• `Optional` **consumesPositional**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:758](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L758) + +--- + +### defaultValue + +• `Optional` **defaultValue**: `string` \| `number` \| `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:784](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L784) + +--- + +### dir + +• `Optional` **dir**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:779](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L779) + +--- + +### docs + +• `Optional` **docs**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:782](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L782) + +--- + +### example + +• `Optional` **example**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:778](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L778) + +--- + +### file + +• `Optional` **file**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:773](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L773) + +--- + +### header + +• `Optional` **header**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:781](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L781) + +--- + +### hidden + +• `Optional` **hidden**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:776](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L776) + +--- + +### implicitOK + +• `Optional` **implicitOK**: `string`[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:752](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L752) + +--- + +### label + +• `Optional` **label**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:743](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L743) + +--- + +### name + +• `Optional` **name**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:742](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L742) + +--- + +### narg + +• `Optional` **narg**: `number` + +#### Defined in + +[packages/core/src/core/usage-error.ts:749](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L749) + +--- + +### noclick + +• `Optional` **noclick**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:744](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L744) + +--- + +### notNeededIfImplicit + +• `Optional` **notNeededIfImplicit**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:755](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L755) + +--- + +### numeric + +• `Optional` **numeric**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:770](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L770) + +--- + +### partial + +• `Optional` **partial**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:783](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L783) + +--- + +### positional + +• `Optional` **positional**: `boolean` + +#### Defined in + +[packages/core/src/core/usage-error.ts:761](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L761) + +--- + +### synonyms + +• `Optional` **synonyms**: `string`[] + +#### Defined in + +[packages/core/src/core/usage-error.ts:745](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L745) + +--- + +### title + +• `Optional` **title**: `string` + +#### Defined in + +[packages/core/src/core/usage-error.ts:780](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L780) diff --git a/docs/api/interfaces/kui_shell_core.WatchPusher.md b/docs/api/interfaces/kui_shell_core.WatchPusher.md new file mode 100644 index 00000000000..b72fe2b6baa --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.WatchPusher.md @@ -0,0 +1,177 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / WatchPusher + +# Interface: WatchPusher + +[@kui-shell/core](../modules/kui_shell_core.md).WatchPusher + +callbacks to indicate state changes + +## Table of contents + +### Methods + +- [allOffline](kui_shell_core.WatchPusher.md#alloffline) +- [batchUpdateDone](kui_shell_core.WatchPusher.md#batchupdatedone) +- [done](kui_shell_core.WatchPusher.md#done) +- [footer](kui_shell_core.WatchPusher.md#footer) +- [header](kui_shell_core.WatchPusher.md#header) +- [offline](kui_shell_core.WatchPusher.md#offline) +- [setBody](kui_shell_core.WatchPusher.md#setbody) +- [update](kui_shell_core.WatchPusher.md#update) + +## Methods + +### allOffline + +▸ **allOffline**(): `void` + +The entire underlying model has disappared + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/watchable.ts:62](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/watchable.ts#L62) + +--- + +### batchUpdateDone + +▸ **batchUpdateDone**(): `void` + +A batch of calls to `update` is complete + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/watchable.ts:53](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/watchable.ts#L53) + +--- + +### done + +▸ **done**(): `void` + +No more updates will be performed + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/watchable.ts:59](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/watchable.ts#L59) + +--- + +### footer + +▸ **footer**(`streams`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :--------- | +| `streams` | `string`[] | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/watchable.ts:67](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/watchable.ts#L67) + +--- + +### header + +▸ **header**(`response`): `void` + +The header model has changed + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------- | +| `response` | [`Row`](../classes/kui_shell_core.Row.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/watchable.ts:65](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/watchable.ts#L65) + +--- + +### 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:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/watchable.ts#L56) + +--- + +### setBody + +▸ **setBody**(`response`): `void` + +set table body + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------ | +| `response` | [`Row`](../classes/kui_shell_core.Row.md)[] | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/watchable.ts:50](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/watchable.ts#L50) + +--- + +### update + +▸ **update**(`response`, `batch?`, `changed?`, `idxToUpdate?`): `void` + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------- | :---------------- | +| `response` | [`Row`](../classes/kui_shell_core.Row.md) | Updated row model | +| `batch?` | `boolean` | - | +| `changed?` | `boolean` | - | +| `idxToUpdate?` | `number` | - | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/watchable.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/watchable.ts#L47) diff --git a/docs/api/interfaces/kui_shell_core.Watchable.md b/docs/api/interfaces/kui_shell_core.Watchable.md new file mode 100644 index 00000000000..d646f552b94 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Watchable.md @@ -0,0 +1,21 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Watchable + +# Interface: Watchable + +[@kui-shell/core](../modules/kui_shell_core.md).Watchable + +## Table of contents + +### Properties + +- [watch](kui_shell_core.Watchable.md#watch) + +## Properties + +### watch + +• **watch**: [`Watcher`](kui_shell_core.Watcher.md) & [`Abortable`](kui_shell_core.Abortable.md) & `Partial`<[`Suspendable`](../modules/kui_shell_core.md#suspendable)\> + +#### Defined in + +[packages/core/src/core/jobs/watchable.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/watchable.ts#L31) diff --git a/docs/api/interfaces/kui_shell_core.Watcher.md b/docs/api/interfaces/kui_shell_core.Watcher.md new file mode 100644 index 00000000000..c1b69693c4d --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.Watcher.md @@ -0,0 +1,35 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / Watcher + +# Interface: Watcher + +[@kui-shell/core](../modules/kui_shell_core.md).Watcher + +## Table of contents + +### Methods + +- [init](kui_shell_core.Watcher.md#init) + +## Methods + +### init + +▸ **init**(`pusher`): `void` + +the table renderer will call this function when the DOM +is ready to accept updates. when you have updates, please call +one or the other of the provided functions + +#### Parameters + +| Name | Type | +| :------- | :--------------------------------------------- | +| `pusher` | [`WatchPusher`](kui_shell_core.WatchPusher.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/watchable.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/watchable.ts#L27) diff --git a/docs/api/interfaces/kui_shell_core.WithSourceReferences.md b/docs/api/interfaces/kui_shell_core.WithSourceReferences.md new file mode 100644 index 00000000000..bd4f9ff8fb6 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.WithSourceReferences.md @@ -0,0 +1,21 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / WithSourceReferences + +# Interface: WithSourceReferences + +[@kui-shell/core](../modules/kui_shell_core.md).WithSourceReferences + +## Table of contents + +### Properties + +- [kuiSourceRef](kui_shell_core.WithSourceReferences.md#kuisourceref) + +## Properties + +### kuiSourceRef + +• **kuiSourceRef**: [`SourceRef`](kui_shell_core.SourceRef.md) + +#### Defined in + +[packages/core/src/models/entity.ts:236](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L236) diff --git a/docs/api/interfaces/kui_shell_core.XtermResponse.md b/docs/api/interfaces/kui_shell_core.XtermResponse.md new file mode 100644 index 00000000000..75317dee278 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.XtermResponse.md @@ -0,0 +1,54 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / XtermResponse + +# Interface: XtermResponse + +[@kui-shell/core](../modules/kui_shell_core.md).XtermResponse + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_core.XtermResponse.md#apiversion) +- [code](kui_shell_core.XtermResponse.md#code) +- [kind](kui_shell_core.XtermResponse.md#kind) +- [rows](kui_shell_core.XtermResponse.md#rows) + +## Properties + +### apiVersion + +• **apiVersion**: `"kui-shell/v1"` + +#### Defined in + +[packages/core/src/models/XtermResponse.ts:20](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/XtermResponse.ts#L20) + +--- + +### code + +• `Optional` **code**: `number` + +#### Defined in + +[packages/core/src/models/XtermResponse.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/XtermResponse.ts#L23) + +--- + +### kind + +• **kind**: `"XtermResponse"` + +#### Defined in + +[packages/core/src/models/XtermResponse.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/XtermResponse.ts#L21) + +--- + +### rows + +• **rows**: [`XtermResponseCell`](kui_shell_core.XtermResponseCell.md)[][] + +#### Defined in + +[packages/core/src/models/XtermResponse.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/XtermResponse.ts#L22) diff --git a/docs/api/interfaces/kui_shell_core.XtermResponseCell.md b/docs/api/interfaces/kui_shell_core.XtermResponseCell.md new file mode 100644 index 00000000000..a7d147e1274 --- /dev/null +++ b/docs/api/interfaces/kui_shell_core.XtermResponseCell.md @@ -0,0 +1,54 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](../modules/kui_shell_core.md) / XtermResponseCell + +# Interface: XtermResponseCell + +[@kui-shell/core](../modules/kui_shell_core.md).XtermResponseCell + +## Table of contents + +### Properties + +- [classList](kui_shell_core.XtermResponseCell.md#classlist) +- [innerText](kui_shell_core.XtermResponseCell.md#innertext) +- [style](kui_shell_core.XtermResponseCell.md#style) +- [textContent](kui_shell_core.XtermResponseCell.md#textcontent) + +## Properties + +### classList + +• `Optional` **classList**: `string`[] + +#### Defined in + +[packages/core/src/models/XtermResponse.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/XtermResponse.ts#L29) + +--- + +### innerText + +• **innerText**: `string` + +#### Defined in + +[packages/core/src/models/XtermResponse.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/XtermResponse.ts#L27) + +--- + +### style + +• `Optional` **style**: `Record`<`string`, `string`\> + +#### Defined in + +[packages/core/src/models/XtermResponse.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/XtermResponse.ts#L30) + +--- + +### textContent + +• **textContent**: `string` + +#### Defined in + +[packages/core/src/models/XtermResponse.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/XtermResponse.ts#L28) diff --git a/docs/api/interfaces/kui_shell_plugin_client_common.DropDownAction.md b/docs/api/interfaces/kui_shell_plugin_client_common.DropDownAction.md new file mode 100644 index 00000000000..eb995beb427 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_client_common.DropDownAction.md @@ -0,0 +1,61 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / DropDownAction + +# Interface: DropDownAction + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).DropDownAction + +## Table of contents + +### Properties + +- [hasDivider](kui_shell_plugin_client_common.DropDownAction.md#hasdivider) +- [isSelected](kui_shell_plugin_client_common.DropDownAction.md#isselected) +- [label](kui_shell_plugin_client_common.DropDownAction.md#label) + +### Methods + +- [handler](kui_shell_plugin_client_common.DropDownAction.md#handler) + +## Properties + +### hasDivider + +• `Optional` **hasDivider**: `boolean` + +#### Defined in + +[plugins/plugin-client-common/src/components/spi/DropDown/model.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/spi/DropDown/model.ts#L21) + +--- + +### isSelected + +• `Optional` **isSelected**: `boolean` + +#### Defined in + +[plugins/plugin-client-common/src/components/spi/DropDown/model.ts:20](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/spi/DropDown/model.ts#L20) + +--- + +### label + +• **label**: `string` + +#### Defined in + +[plugins/plugin-client-common/src/components/spi/DropDown/model.ts:18](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/spi/DropDown/model.ts#L18) + +## Methods + +### handler + +▸ **handler**(): `void` + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/spi/DropDown/model.ts:19](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/spi/DropDown/model.ts#L19) diff --git a/docs/api/interfaces/kui_shell_plugin_client_common.InputProviderState.md b/docs/api/interfaces/kui_shell_plugin_client_common.InputProviderState.md new file mode 100644 index 00000000000..8730ae580ae --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_client_common.InputProviderState.md @@ -0,0 +1,151 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / InputProviderState + +# Interface: InputProviderState + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).InputProviderState + +## Table of contents + +### Properties + +- [counter](kui_shell_plugin_client_common.InputProviderState.md#counter) +- [durationDom](kui_shell_plugin_client_common.InputProviderState.md#durationdom) +- [execUUID](kui_shell_plugin_client_common.InputProviderState.md#execuuid) +- [isReEdit](kui_shell_plugin_client_common.InputProviderState.md#isreedit) +- [isearch](kui_shell_plugin_client_common.InputProviderState.md#isearch) +- [model](kui_shell_plugin_client_common.InputProviderState.md#model) +- [multiline](kui_shell_plugin_client_common.InputProviderState.md#multiline) +- [pasteMultiLineTexts](kui_shell_plugin_client_common.InputProviderState.md#pastemultilinetexts) +- [prompt](kui_shell_plugin_client_common.InputProviderState.md#prompt) +- [tabCompletion](kui_shell_plugin_client_common.InputProviderState.md#tabcompletion) +- [typeahead](kui_shell_plugin_client_common.InputProviderState.md#typeahead) + +## Properties + +### counter + +• `Optional` **counter**: `Timeout` + +durationDom, used for counting up duration while Processing + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:189](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L189) + +--- + +### durationDom + +• `Optional` **durationDom**: `RefObject`<`HTMLSpanElement`\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:190](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L190) + +--- + +### execUUID + +• `Optional` **execUUID**: `string` + +the execution ID for this prompt, if any + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:177](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L177) + +--- + +### isReEdit + +• `Optional` **isReEdit**: `boolean` + +did user click to re-edit the input? + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:174](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L174) + +--- + +### isearch + +• `Optional` **isearch**: `default` + +state of active reverse-i-search + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:183](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L183) + +--- + +### model + +• **model**: `BlockModel` + +Copy from props; to help with getDerivedStateFromProps + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:165](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L165) + +--- + +### multiline + +• `Optional` **multiline**: `boolean` + +is the input in multi-line mode? if true, use text area rather than in-line input + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:168](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L168) + +--- + +### pasteMultiLineTexts + +• `Optional` **pasteMultiLineTexts**: `string` + +did user paste multiline texts + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:171](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L171) + +--- + +### prompt + +• `Optional` **prompt**: `InputElement` + +DOM element for prompt; set via `ref` in render() below + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:180](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L180) + +--- + +### tabCompletion + +• `Optional` **tabCompletion**: `TabCompletionState` + +state of tab completion + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:186](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L186) + +--- + +### typeahead + +• `Optional` **typeahead**: `string` + +typeahead completion? + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:193](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L193) diff --git a/docs/api/interfaces/kui_shell_plugin_client_common.TextWithIconWidgetOptions.md b/docs/api/interfaces/kui_shell_plugin_client_common.TextWithIconWidgetOptions.md new file mode 100644 index 00000000000..63c5d56969d --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_client_common.TextWithIconWidgetOptions.md @@ -0,0 +1,42 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / TextWithIconWidgetOptions + +# Interface: TextWithIconWidgetOptions + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).TextWithIconWidgetOptions + +End-user options + +## Hierarchy + +- **`TextWithIconWidgetOptions`** + + ↳ [`TextWithIconWidgetProps`](kui_shell_plugin_client_common.TextWithIconWidgetProps.md) + +## Table of contents + +### Properties + +- [className](kui_shell_plugin_client_common.TextWithIconWidgetOptions.md#classname) +- [position](kui_shell_plugin_client_common.TextWithIconWidgetOptions.md#position) + +## Properties + +### className + +• `Optional` **className**: `string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L28) + +--- + +### position + +• `Optional` **position**: `"bottom"` \| `"top-end"` \| `"top"` \| `"top-start"` \| `"left"` \| `"right"` \| `"auto"` + +popover position override specified by container (not client)? + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L31) diff --git a/docs/api/interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md b/docs/api/interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md new file mode 100644 index 00000000000..1a820c654a5 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md @@ -0,0 +1,140 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md) / TextWithIconWidgetProps + +# Interface: TextWithIconWidgetProps + +[@kui-shell/plugin-client-common](../modules/kui_shell_plugin_client_common.md).TextWithIconWidgetProps + +Component-specific Options + +## Hierarchy + +- [`TextWithIconWidgetOptions`](kui_shell_plugin_client_common.TextWithIconWidgetOptions.md) + + ↳ **`TextWithIconWidgetProps`** + +## Table of contents + +### Properties + +- [className](kui_shell_plugin_client_common.TextWithIconWidgetProps.md#classname) +- [iconIsNarrow](kui_shell_plugin_client_common.TextWithIconWidgetProps.md#iconisnarrow) +- [iconOnclick](kui_shell_plugin_client_common.TextWithIconWidgetProps.md#icononclick) +- [id](kui_shell_plugin_client_common.TextWithIconWidgetProps.md#id) +- [popover](kui_shell_plugin_client_common.TextWithIconWidgetProps.md#popover) +- [position](kui_shell_plugin_client_common.TextWithIconWidgetProps.md#position) +- [text](kui_shell_plugin_client_common.TextWithIconWidgetProps.md#text) +- [textOnclick](kui_shell_plugin_client_common.TextWithIconWidgetProps.md#textonclick) +- [title](kui_shell_plugin_client_common.TextWithIconWidgetProps.md#title) +- [viewLevel](kui_shell_plugin_client_common.TextWithIconWidgetProps.md#viewlevel) + +## Properties + +### className + +• `Optional` **className**: `string` + +#### Inherited from + +[TextWithIconWidgetOptions](kui_shell_plugin_client_common.TextWithIconWidgetOptions.md).[className](kui_shell_plugin_client_common.TextWithIconWidgetOptions.md#classname) + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L28) + +--- + +### iconIsNarrow + +• `Optional` **iconIsNarrow**: `boolean` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L40) + +--- + +### iconOnclick + +• `Optional` **iconOnclick**: `string` \| () => `void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:41](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L41) + +--- + +### id + +• `Optional` **id**: `string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L43) + +--- + +### popover + +• `Optional` **popover**: `Pick`<`Props`, `"headerContent"` \| `"bodyContent"`\> & `Partial`<`Props`\> + +popover properties specified by client + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L46) + +--- + +### position + +• `Optional` **position**: `"bottom"` \| `"top-end"` \| `"top"` \| `"top-start"` \| `"left"` \| `"right"` \| `"auto"` + +popover position override specified by container (not client)? + +#### Inherited from + +[TextWithIconWidgetOptions](kui_shell_plugin_client_common.TextWithIconWidgetOptions.md).[position](kui_shell_plugin_client_common.TextWithIconWidgetOptions.md#position) + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L31) + +--- + +### text + +• **text**: `string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:36](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L36) + +--- + +### textOnclick + +• `Optional` **textOnclick**: `string` \| () => `void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:42](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L42) + +--- + +### title + +• `Optional` **title**: `string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L39) + +--- + +### viewLevel + +• **viewLevel**: [`ViewLevel`](../modules/kui_shell_plugin_client_common.md#viewlevel) + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L37) diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.InvolvedObject.md b/docs/api/interfaces/kui_shell_plugin_kubectl.InvolvedObject.md new file mode 100644 index 00000000000..78d5eb80f2e --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.InvolvedObject.md @@ -0,0 +1,35 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / InvolvedObject + +# Interface: InvolvedObject + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).InvolvedObject + +Trait that defines an involvedObject, e.g. for Events + +## Table of contents + +### Properties + +- [involvedObject](kui_shell_plugin_kubectl.InvolvedObject.md#involvedobject) + +## Properties + +### involvedObject + +• **involvedObject**: `Object` + +#### Type declaration + +| Name | Type | +| :----------------- | :------- | +| `apiVersion` | `string` | +| `fieldPath?` | `string` | +| `kind` | `string` | +| `name` | `string` | +| `namespace` | `string` | +| `resourceVersion?` | `string` | +| `uid?` | `string` | + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:468](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L468) diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.Job.md b/docs/api/interfaces/kui_shell_plugin_kubectl.Job.md new file mode 100644 index 00000000000..5c3d7efa61f --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.Job.md @@ -0,0 +1,307 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / Job + +# Interface: Job + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).Job + +Kubernetes Job resource type + +## Hierarchy + +- [`KubeResource`](../modules/kui_shell_plugin_kubectl.md#kuberesource) + + ↳ **`Job`** + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_plugin_kubectl.Job.md#apiversion) +- [content](kui_shell_plugin_kubectl.Job.md#content) +- [contentType](kui_shell_plugin_kubectl.Job.md#contenttype) +- [isKubeResource](kui_shell_plugin_kubectl.Job.md#iskuberesource) +- [isSimulacrum](kui_shell_plugin_kubectl.Job.md#issimulacrum) +- [kind](kui_shell_plugin_kubectl.Job.md#kind) +- [kuiRawData](kui_shell_plugin_kubectl.Job.md#kuirawdata) +- [metadata](kui_shell_plugin_kubectl.Job.md#metadata) +- [nameHash](kui_shell_plugin_kubectl.Job.md#namehash) +- [onclick](kui_shell_plugin_kubectl.Job.md#onclick) +- [originatingCommand](kui_shell_plugin_kubectl.Job.md#originatingcommand) +- [presentation](kui_shell_plugin_kubectl.Job.md#presentation) +- [prettyName](kui_shell_plugin_kubectl.Job.md#prettyname) +- [spec](kui_shell_plugin_kubectl.Job.md#spec) +- [status](kui_shell_plugin_kubectl.Job.md#status) +- [toolbarText](kui_shell_plugin_kubectl.Job.md#toolbartext) +- [version](kui_shell_plugin_kubectl.Job.md#version) + +## Properties + +### apiVersion + +• **apiVersion**: `"batch/v1"` + +#### Overrides + +KubeResource.apiVersion + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:375](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L375) + +--- + +### content + +• `Optional` **content**: `void` + +#### Inherited from + +KubeResource.content + +#### Defined in + +packages/core/mdist/models/entity.d.ts:51 + +--- + +### contentType + +• `Optional` **contentType**: `string` + +#### Inherited from + +KubeResource.contentType + +#### Defined in + +packages/core/mdist/models/entity.d.ts:52 + +--- + +### isKubeResource + +• **isKubeResource**: `true` + +#### Inherited from + +KubeResource.isKubeResource + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:205](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L205) + +--- + +### isSimulacrum + +• `Optional` **isSimulacrum**: `boolean` + +#### Inherited from + +KubeResource.isSimulacrum + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:204](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L204) + +--- + +### kind + +• **kind**: `"Job"` + +#### Overrides + +KubeResource.kind + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:376](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L376) + +--- + +### kuiRawData + +• `Optional` **kuiRawData**: `string` + +#### Inherited from + +KubeResource.kuiRawData + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:182](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L182) + +--- + +### metadata + +• `Optional` **metadata**: { `creationTimestamp?`: `string` ; `generation?`: `string` ; `labels?`: `Record`<`string`, `string`\> ; `name`: `string` ; `namespace?`: `string` } & `Partial`<`WithOwnerReferences`\> & `Partial`<`WithResourceVersion`\> & { `annotations?`: `object` ; `creationTimestamp?`: `string` ; `generateName?`: `string` ; `generation?`: `string` ; `labels?`: { [key: string]: `string`; } ; `name`: `string` ; `namespace?`: `string` ; `uid?`: `string` } + +#### Inherited from + +KubeResource.metadata + +#### Defined in + +packages/core/mdist/models/entity.d.ts:24 + +--- + +### nameHash + +• `Optional` **nameHash**: `string` + +#### Inherited from + +KubeResource.nameHash + +#### Defined in + +packages/core/mdist/models/entity.d.ts:43 + +--- + +### onclick + +• `Optional` **onclick**: `Object` + +family of onclick handlers + +#### Type declaration + +| Name | Type | +| :----------- | :------- | +| `kind?` | `string` | +| `name?` | `string` | +| `nameHash?` | `string` | +| `namespace?` | `string` | + +#### Inherited from + +KubeResource.onclick + +#### Defined in + +packages/core/mdist/models/entity.d.ts:45 + +--- + +### originatingCommand + +• **originatingCommand**: `EvaluatorArgs`<[`KubeOptions`](kui_shell_plugin_kubectl.KubeOptions.md)\> + +#### Inherited from + +KubeResource.originatingCommand + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:203](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L203) + +--- + +### presentation + +• `Optional` **presentation**: `Presentation` + +#### Inherited from + +KubeResource.presentation + +#### Defined in + +packages/core/mdist/models/entity.d.ts:54 + +--- + +### prettyName + +• `Optional` **prettyName**: `string` + +name hash, e.g. the hash part of auto-generated names, or an openwhisk activation id + +#### Inherited from + +KubeResource.prettyName + +#### Defined in + +packages/core/mdist/models/entity.d.ts:42 + +--- + +### spec + +• **spec**: `Object` + +#### Type declaration + +| Name | Type | +| :------------- | :----------------------------- | +| `backoffLimit` | `number` | +| `completions` | `number` | +| `parallelism` | `number` | +| `selector` | `Selector` | +| `template` | `ContainerTemplate`<`Object`\> | + +#### Overrides + +KubeResource.spec + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:377](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L377) + +--- + +### status + +• **status**: `Object` + +#### Type declaration + +| Name | Type | +| :--------------- | :------------------------------------------------------------------------- | +| `completionTime` | `string` | +| `conditions` | [`KubeStatusCondition`](kui_shell_plugin_kubectl.KubeStatusCondition.md)[] | +| `startTime` | `string` | +| `succeeded` | `number` | + +#### Overrides + +KubeResource.status + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:387](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L387) + +--- + +### toolbarText + +• `Optional` **toolbarText**: `ToolbarText` + +#### Inherited from + +KubeResource.toolbarText + +#### Defined in + +packages/core/mdist/models/entity.d.ts:53 + +--- + +### version + +• `Optional` **version**: `string` + +optional designation of resource version + +#### Inherited from + +KubeResource.version + +#### Defined in + +packages/core/mdist/models/entity.d.ts:40 diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.KubeContext.md b/docs/api/interfaces/kui_shell_plugin_kubectl.KubeContext.md new file mode 100644 index 00000000000..71bbdec74a9 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.KubeContext.md @@ -0,0 +1,296 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / KubeContext + +# Interface: KubeContext + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).KubeContext + +Kubernetes context + +## Hierarchy + +- [`KubeResource`](../modules/kui_shell_plugin_kubectl.md#kuberesource) + + ↳ **`KubeContext`** + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_plugin_kubectl.KubeContext.md#apiversion) +- [content](kui_shell_plugin_kubectl.KubeContext.md#content) +- [contentType](kui_shell_plugin_kubectl.KubeContext.md#contenttype) +- [isKubeResource](kui_shell_plugin_kubectl.KubeContext.md#iskuberesource) +- [isSimulacrum](kui_shell_plugin_kubectl.KubeContext.md#issimulacrum) +- [kind](kui_shell_plugin_kubectl.KubeContext.md#kind) +- [kuiRawData](kui_shell_plugin_kubectl.KubeContext.md#kuirawdata) +- [metadata](kui_shell_plugin_kubectl.KubeContext.md#metadata) +- [nameHash](kui_shell_plugin_kubectl.KubeContext.md#namehash) +- [onclick](kui_shell_plugin_kubectl.KubeContext.md#onclick) +- [originatingCommand](kui_shell_plugin_kubectl.KubeContext.md#originatingcommand) +- [presentation](kui_shell_plugin_kubectl.KubeContext.md#presentation) +- [prettyName](kui_shell_plugin_kubectl.KubeContext.md#prettyname) +- [spec](kui_shell_plugin_kubectl.KubeContext.md#spec) +- [status](kui_shell_plugin_kubectl.KubeContext.md#status) +- [toolbarText](kui_shell_plugin_kubectl.KubeContext.md#toolbartext) +- [version](kui_shell_plugin_kubectl.KubeContext.md#version) + +## Properties + +### apiVersion + +• **apiVersion**: `"github.com/kui-shell/plugin-kubectl/v1alpha1"` + +#### Overrides + +KubeResource.apiVersion + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:626](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L626) + +--- + +### content + +• `Optional` **content**: `void` + +#### Inherited from + +KubeResource.content + +#### Defined in + +packages/core/mdist/models/entity.d.ts:51 + +--- + +### contentType + +• `Optional` **contentType**: `string` + +#### Inherited from + +KubeResource.contentType + +#### Defined in + +packages/core/mdist/models/entity.d.ts:52 + +--- + +### isKubeResource + +• **isKubeResource**: `true` + +#### Inherited from + +KubeResource.isKubeResource + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:205](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L205) + +--- + +### isSimulacrum + +• `Optional` **isSimulacrum**: `boolean` + +#### Inherited from + +KubeResource.isSimulacrum + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:204](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L204) + +--- + +### kind + +• **kind**: `"Context"` + +#### Overrides + +KubeResource.kind + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:627](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L627) + +--- + +### kuiRawData + +• `Optional` **kuiRawData**: `string` + +#### Inherited from + +KubeResource.kuiRawData + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:182](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L182) + +--- + +### metadata + +• `Optional` **metadata**: { `creationTimestamp?`: `string` ; `generation?`: `string` ; `labels?`: `Record`<`string`, `string`\> ; `name`: `string` ; `namespace?`: `string` } & `Partial`<`WithOwnerReferences`\> & `Partial`<`WithResourceVersion`\> & { `annotations?`: `object` ; `creationTimestamp?`: `string` ; `generateName?`: `string` ; `generation?`: `string` ; `labels?`: { [key: string]: `string`; } ; `name`: `string` ; `namespace?`: `string` ; `uid?`: `string` } + +#### Inherited from + +KubeResource.metadata + +#### Defined in + +packages/core/mdist/models/entity.d.ts:24 + +--- + +### nameHash + +• `Optional` **nameHash**: `string` + +#### Inherited from + +KubeResource.nameHash + +#### Defined in + +packages/core/mdist/models/entity.d.ts:43 + +--- + +### onclick + +• `Optional` **onclick**: `Object` + +family of onclick handlers + +#### Type declaration + +| Name | Type | +| :----------- | :------- | +| `kind?` | `string` | +| `name?` | `string` | +| `nameHash?` | `string` | +| `namespace?` | `string` | + +#### Inherited from + +KubeResource.onclick + +#### Defined in + +packages/core/mdist/models/entity.d.ts:45 + +--- + +### originatingCommand + +• **originatingCommand**: `EvaluatorArgs`<[`KubeOptions`](kui_shell_plugin_kubectl.KubeOptions.md)\> + +#### Inherited from + +KubeResource.originatingCommand + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:203](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L203) + +--- + +### presentation + +• `Optional` **presentation**: `Presentation` + +#### Inherited from + +KubeResource.presentation + +#### Defined in + +packages/core/mdist/models/entity.d.ts:54 + +--- + +### prettyName + +• `Optional` **prettyName**: `string` + +name hash, e.g. the hash part of auto-generated names, or an openwhisk activation id + +#### Inherited from + +KubeResource.prettyName + +#### Defined in + +packages/core/mdist/models/entity.d.ts:42 + +--- + +### spec + +• **spec**: `Object` + +#### Type declaration + +| Name | Type | +| :---------- | :-------- | +| `cluster` | `string` | +| `isCurrent` | `boolean` | +| `user` | `string` | + +#### Overrides + +KubeResource.spec + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:628](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L628) + +--- + +### status + +• `Optional` **status**: [`KubeStatus`](kui_shell_plugin_kubectl.KubeStatus.md) + +#### Inherited from + +KubeResource.status + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:199](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L199) + +--- + +### toolbarText + +• `Optional` **toolbarText**: `ToolbarText` + +#### Inherited from + +KubeResource.toolbarText + +#### Defined in + +packages/core/mdist/models/entity.d.ts:53 + +--- + +### version + +• `Optional` **version**: `string` + +optional designation of resource version + +#### Inherited from + +KubeResource.version + +#### Defined in + +packages/core/mdist/models/entity.d.ts:40 diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.KubeItems.md b/docs/api/interfaces/kui_shell_plugin_kubectl.KubeItems.md new file mode 100644 index 00000000000..bbf41475380 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.KubeItems.md @@ -0,0 +1,305 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / KubeItems + +# Interface: KubeItems + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).KubeItems + +e.g. `kubectl get pods -o json` will return a kind: items + +## Type parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Item` | extends [`KubeResource`](../modules/kui_shell_plugin_kubectl.md#kuberesource)[`KubeResource`](../modules/kui_shell_plugin_kubectl.md#kuberesource) | + +## Hierarchy + +- [`KubeResource`](../modules/kui_shell_plugin_kubectl.md#kuberesource) + + ↳ **`KubeItems`** + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_plugin_kubectl.KubeItems.md#apiversion) +- [content](kui_shell_plugin_kubectl.KubeItems.md#content) +- [contentType](kui_shell_plugin_kubectl.KubeItems.md#contenttype) +- [isKubeResource](kui_shell_plugin_kubectl.KubeItems.md#iskuberesource) +- [isSimulacrum](kui_shell_plugin_kubectl.KubeItems.md#issimulacrum) +- [items](kui_shell_plugin_kubectl.KubeItems.md#items) +- [kind](kui_shell_plugin_kubectl.KubeItems.md#kind) +- [kuiRawData](kui_shell_plugin_kubectl.KubeItems.md#kuirawdata) +- [metadata](kui_shell_plugin_kubectl.KubeItems.md#metadata) +- [nameHash](kui_shell_plugin_kubectl.KubeItems.md#namehash) +- [onclick](kui_shell_plugin_kubectl.KubeItems.md#onclick) +- [originatingCommand](kui_shell_plugin_kubectl.KubeItems.md#originatingcommand) +- [presentation](kui_shell_plugin_kubectl.KubeItems.md#presentation) +- [prettyName](kui_shell_plugin_kubectl.KubeItems.md#prettyname) +- [spec](kui_shell_plugin_kubectl.KubeItems.md#spec) +- [status](kui_shell_plugin_kubectl.KubeItems.md#status) +- [toolbarText](kui_shell_plugin_kubectl.KubeItems.md#toolbartext) +- [version](kui_shell_plugin_kubectl.KubeItems.md#version) + +## Properties + +### apiVersion + +• **apiVersion**: `"v1"` + +#### Overrides + +KubeResource.apiVersion + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:539](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L539) + +--- + +### content + +• `Optional` **content**: `void` + +#### Inherited from + +KubeResource.content + +#### Defined in + +packages/core/mdist/models/entity.d.ts:51 + +--- + +### contentType + +• `Optional` **contentType**: `string` + +#### Inherited from + +KubeResource.contentType + +#### Defined in + +packages/core/mdist/models/entity.d.ts:52 + +--- + +### isKubeResource + +• **isKubeResource**: `true` + +#### Inherited from + +KubeResource.isKubeResource + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:205](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L205) + +--- + +### isSimulacrum + +• `Optional` **isSimulacrum**: `boolean` + +#### Inherited from + +KubeResource.isSimulacrum + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:204](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L204) + +--- + +### items + +• **items**: `Item`[] + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:541](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L541) + +--- + +### kind + +• **kind**: `"List"` + +#### Overrides + +KubeResource.kind + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:540](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L540) + +--- + +### kuiRawData + +• `Optional` **kuiRawData**: `string` + +#### Inherited from + +KubeResource.kuiRawData + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:182](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L182) + +--- + +### metadata + +• `Optional` **metadata**: { `creationTimestamp?`: `string` ; `generation?`: `string` ; `labels?`: `Record`<`string`, `string`\> ; `name`: `string` ; `namespace?`: `string` } & `Partial`<`WithOwnerReferences`\> & `Partial`<`WithResourceVersion`\> & { `annotations?`: `object` ; `creationTimestamp?`: `string` ; `generateName?`: `string` ; `generation?`: `string` ; `labels?`: { [key: string]: `string`; } ; `name`: `string` ; `namespace?`: `string` ; `uid?`: `string` } + +#### Inherited from + +KubeResource.metadata + +#### Defined in + +packages/core/mdist/models/entity.d.ts:24 + +--- + +### nameHash + +• `Optional` **nameHash**: `string` + +#### Inherited from + +KubeResource.nameHash + +#### Defined in + +packages/core/mdist/models/entity.d.ts:43 + +--- + +### onclick + +• `Optional` **onclick**: `Object` + +family of onclick handlers + +#### Type declaration + +| Name | Type | +| :----------- | :------- | +| `kind?` | `string` | +| `name?` | `string` | +| `nameHash?` | `string` | +| `namespace?` | `string` | + +#### Inherited from + +KubeResource.onclick + +#### Defined in + +packages/core/mdist/models/entity.d.ts:45 + +--- + +### originatingCommand + +• **originatingCommand**: `EvaluatorArgs`<[`KubeOptions`](kui_shell_plugin_kubectl.KubeOptions.md)\> + +#### Inherited from + +KubeResource.originatingCommand + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:203](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L203) + +--- + +### presentation + +• `Optional` **presentation**: `Presentation` + +#### Inherited from + +KubeResource.presentation + +#### Defined in + +packages/core/mdist/models/entity.d.ts:54 + +--- + +### prettyName + +• `Optional` **prettyName**: `string` + +name hash, e.g. the hash part of auto-generated names, or an openwhisk activation id + +#### Inherited from + +KubeResource.prettyName + +#### Defined in + +packages/core/mdist/models/entity.d.ts:42 + +--- + +### spec + +• `Optional` **spec**: `any` + +#### Inherited from + +KubeResource.spec + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:200](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L200) + +--- + +### status + +• `Optional` **status**: [`KubeStatus`](kui_shell_plugin_kubectl.KubeStatus.md) + +#### Inherited from + +KubeResource.status + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:199](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L199) + +--- + +### toolbarText + +• `Optional` **toolbarText**: `ToolbarText` + +#### Inherited from + +KubeResource.toolbarText + +#### Defined in + +packages/core/mdist/models/entity.d.ts:53 + +--- + +### version + +• `Optional` **version**: `string` + +optional designation of resource version + +#### Inherited from + +KubeResource.version + +#### Defined in + +packages/core/mdist/models/entity.d.ts:40 diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.KubeOptions.md b/docs/api/interfaces/kui_shell_plugin_kubectl.KubeOptions.md new file mode 100644 index 00000000000..00e07ca8ab0 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.KubeOptions.md @@ -0,0 +1,341 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / KubeOptions + +# Interface: KubeOptions + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).KubeOptions + +An incomplete set of kubectl options + +## Hierarchy + +- `ParsedOptions` + + ↳ **`KubeOptions`** + +## Table of contents + +### Properties + +- [A](kui_shell_plugin_kubectl.KubeOptions.md#a) +- [\_](kui_shell_plugin_kubectl.KubeOptions.md#_) +- [all-namespaces](kui_shell_plugin_kubectl.KubeOptions.md#all-namespaces) +- [c](kui_shell_plugin_kubectl.KubeOptions.md#c) +- [cluster](kui_shell_plugin_kubectl.KubeOptions.md#cluster) +- [container](kui_shell_plugin_kubectl.KubeOptions.md#container) +- [context](kui_shell_plugin_kubectl.KubeOptions.md#context) +- [dry-run](kui_shell_plugin_kubectl.KubeOptions.md#dry-run) +- [f](kui_shell_plugin_kubectl.KubeOptions.md#f) +- [filename](kui_shell_plugin_kubectl.KubeOptions.md#filename) +- [h](kui_shell_plugin_kubectl.KubeOptions.md#h) +- [help](kui_shell_plugin_kubectl.KubeOptions.md#help) +- [k](kui_shell_plugin_kubectl.KubeOptions.md#k) +- [kubeconfig](kui_shell_plugin_kubectl.KubeOptions.md#kubeconfig) +- [kustomize](kui_shell_plugin_kubectl.KubeOptions.md#kustomize) +- [l](kui_shell_plugin_kubectl.KubeOptions.md#l) +- [label](kui_shell_plugin_kubectl.KubeOptions.md#label) +- [limit](kui_shell_plugin_kubectl.KubeOptions.md#limit) +- [n](kui_shell_plugin_kubectl.KubeOptions.md#n) +- [namespace](kui_shell_plugin_kubectl.KubeOptions.md#namespace) +- [o](kui_shell_plugin_kubectl.KubeOptions.md#o) +- [output](kui_shell_plugin_kubectl.KubeOptions.md#output) +- [p](kui_shell_plugin_kubectl.KubeOptions.md#p) +- [previous](kui_shell_plugin_kubectl.KubeOptions.md#previous) +- [sort-by](kui_shell_plugin_kubectl.KubeOptions.md#sort-by) +- [w](kui_shell_plugin_kubectl.KubeOptions.md#w) +- [wait](kui_shell_plugin_kubectl.KubeOptions.md#wait) +- [watch](kui_shell_plugin_kubectl.KubeOptions.md#watch) +- [watch-only](kui_shell_plugin_kubectl.KubeOptions.md#watch-only) + +## Properties + +### A + +• `Optional` **A**: `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:273](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L273) + +--- + +### \_ + +• `Optional` **\_**: `string`[] + +#### Inherited from + +ParsedOptions.\_ + +#### Defined in + +packages/core/mdist/models/command.d.ts:79 + +--- + +### all-namespaces + +• `Optional` **all-namespaces**: `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:274](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L274) + +--- + +### c + +• `Optional` **c**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:285](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L285) + +--- + +### cluster + +• `Optional` **cluster**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:276](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L276) + +--- + +### container + +• `Optional` **container**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:286](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L286) + +--- + +### context + +• `Optional` **context**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:277](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L277) + +--- + +### dry-run + +• `Optional` **dry-run**: `string` \| `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:280](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L280) + +--- + +### f + +• `Optional` **f**: `string` \| `string`[] + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:303](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L303) + +--- + +### filename + +• `Optional` **filename**: `string` \| `string`[] + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:304](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L304) + +--- + +### h + +• `Optional` **h**: `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:309](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L309) + +--- + +### help + +• `Optional` **help**: `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:310](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L310) + +--- + +### k + +• `Optional` **k**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:306](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L306) + +--- + +### kubeconfig + +• `Optional` **kubeconfig**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:278](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L278) + +--- + +### kustomize + +• `Optional` **kustomize**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:307](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L307) + +--- + +### l + +• `Optional` **l**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:300](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L300) + +--- + +### label + +• `Optional` **label**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:301](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L301) + +--- + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:312](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L312) + +--- + +### n + +• `Optional` **n**: `string` \| `string`[] + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:282](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L282) + +--- + +### namespace + +• `Optional` **namespace**: `string` \| `string`[] + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:283](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L283) + +--- + +### o + +• `Optional` **o**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:288](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L288) + +--- + +### output + +• `Optional` **output**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:289](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L289) + +--- + +### p + +• `Optional` **p**: `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:297](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L297) + +--- + +### previous + +• `Optional` **previous**: `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:298](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L298) + +--- + +### sort-by + +• `Optional` **sort-by**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:314](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L314) + +--- + +### w + +• `Optional` **w**: `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:291](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L291) + +--- + +### wait + +• `Optional` **wait**: `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:295](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L295) + +--- + +### watch + +• `Optional` **watch**: `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:292](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L292) + +--- + +### watch-only + +• `Optional` **watch-only**: `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:293](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L293) diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.KubeStatus.md b/docs/api/interfaces/kui_shell_plugin_kubectl.KubeStatus.md new file mode 100644 index 00000000000..1565e6e8d38 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.KubeStatus.md @@ -0,0 +1,164 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / KubeStatus + +# Interface: KubeStatus + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).KubeStatus + +## Table of contents + +### Properties + +- [availableReplicas](kui_shell_plugin_kubectl.KubeStatus.md#availablereplicas) +- [completionTime](kui_shell_plugin_kubectl.KubeStatus.md#completiontime) +- [conditions](kui_shell_plugin_kubectl.KubeStatus.md#conditions) +- [loadBalancer](kui_shell_plugin_kubectl.KubeStatus.md#loadbalancer) +- [message](kui_shell_plugin_kubectl.KubeStatus.md#message) +- [phase](kui_shell_plugin_kubectl.KubeStatus.md#phase) +- [podName](kui_shell_plugin_kubectl.KubeStatus.md#podname) +- [qosClass](kui_shell_plugin_kubectl.KubeStatus.md#qosclass) +- [readyReplicas](kui_shell_plugin_kubectl.KubeStatus.md#readyreplicas) +- [replicas](kui_shell_plugin_kubectl.KubeStatus.md#replicas) +- [startTime](kui_shell_plugin_kubectl.KubeStatus.md#starttime) +- [state](kui_shell_plugin_kubectl.KubeStatus.md#state) +- [unavailableReplicas](kui_shell_plugin_kubectl.KubeStatus.md#unavailablereplicas) +- [updatedReplicas](kui_shell_plugin_kubectl.KubeStatus.md#updatedreplicas) + +## Properties + +### availableReplicas + +• `Optional` **availableReplicas**: `number` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L55) + +--- + +### completionTime + +• `Optional` **completionTime**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L49) + +--- + +### conditions + +• `Optional` **conditions**: [`KubeStatusCondition`](kui_shell_plugin_kubectl.KubeStatusCondition.md)[] + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:59](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L59) + +--- + +### loadBalancer + +• `Optional` **loadBalancer**: `KubeLoadBalancer` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L58) + +--- + +### message + +• `Optional` **message**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L46) + +--- + +### phase + +• `Optional` **phase**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:50](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L50) + +--- + +### podName + +• `Optional` **podName**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L51) + +--- + +### qosClass + +• `Optional` **qosClass**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:52](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L52) + +--- + +### readyReplicas + +• `Optional` **readyReplicas**: `number` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:54](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L54) + +--- + +### replicas + +• `Optional` **replicas**: `number` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:53](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L53) + +--- + +### startTime + +• `Optional` **startTime**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L48) + +--- + +### state + +• `Optional` **state**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L47) + +--- + +### unavailableReplicas + +• `Optional` **unavailableReplicas**: `number` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L56) + +--- + +### updatedReplicas + +• `Optional` **updatedReplicas**: `number` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:57](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L57) diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.KubeStatusCondition.md b/docs/api/interfaces/kui_shell_plugin_kubectl.KubeStatusCondition.md new file mode 100644 index 00000000000..9238ee55eab --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.KubeStatusCondition.md @@ -0,0 +1,98 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / KubeStatusCondition + +# Interface: KubeStatusCondition + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).KubeStatusCondition + +## Table of contents + +### Properties + +- [lastProbeTime](kui_shell_plugin_kubectl.KubeStatusCondition.md#lastprobetime) +- [lastTransitionTime](kui_shell_plugin_kubectl.KubeStatusCondition.md#lasttransitiontime) +- [lastUpdateTime](kui_shell_plugin_kubectl.KubeStatusCondition.md#lastupdatetime) +- [message](kui_shell_plugin_kubectl.KubeStatusCondition.md#message) +- [phase](kui_shell_plugin_kubectl.KubeStatusCondition.md#phase) +- [reason](kui_shell_plugin_kubectl.KubeStatusCondition.md#reason) +- [status](kui_shell_plugin_kubectl.KubeStatusCondition.md#status) +- [type](kui_shell_plugin_kubectl.KubeStatusCondition.md#type) + +## Properties + +### lastProbeTime + +• `Optional` **lastProbeTime**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L23) + +--- + +### lastTransitionTime + +• **lastTransitionTime**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L25) + +--- + +### lastUpdateTime + +• **lastUpdateTime**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L24) + +--- + +### message + +• **message**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L28) + +--- + +### phase + +• `Optional` **phase**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L30) + +--- + +### reason + +• `Optional` **reason**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L27) + +--- + +### status + +• **status**: `string` \| `boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L26) + +--- + +### type + +• `Optional` **type**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L29) diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.Pod.md b/docs/api/interfaces/kui_shell_plugin_kubectl.Pod.md new file mode 100644 index 00000000000..c58321d307e --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.Pod.md @@ -0,0 +1,286 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / Pod + +# Interface: Pod + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).Pod + +## Hierarchy + +- [`KubeResource`](../modules/kui_shell_plugin_kubectl.md#kuberesource)<`PodStatus`\> + + ↳ **`Pod`** + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_plugin_kubectl.Pod.md#apiversion) +- [content](kui_shell_plugin_kubectl.Pod.md#content) +- [contentType](kui_shell_plugin_kubectl.Pod.md#contenttype) +- [isKubeResource](kui_shell_plugin_kubectl.Pod.md#iskuberesource) +- [isSimulacrum](kui_shell_plugin_kubectl.Pod.md#issimulacrum) +- [kind](kui_shell_plugin_kubectl.Pod.md#kind) +- [kuiRawData](kui_shell_plugin_kubectl.Pod.md#kuirawdata) +- [metadata](kui_shell_plugin_kubectl.Pod.md#metadata) +- [nameHash](kui_shell_plugin_kubectl.Pod.md#namehash) +- [onclick](kui_shell_plugin_kubectl.Pod.md#onclick) +- [originatingCommand](kui_shell_plugin_kubectl.Pod.md#originatingcommand) +- [presentation](kui_shell_plugin_kubectl.Pod.md#presentation) +- [prettyName](kui_shell_plugin_kubectl.Pod.md#prettyname) +- [spec](kui_shell_plugin_kubectl.Pod.md#spec) +- [status](kui_shell_plugin_kubectl.Pod.md#status) +- [toolbarText](kui_shell_plugin_kubectl.Pod.md#toolbartext) +- [version](kui_shell_plugin_kubectl.Pod.md#version) + +## Properties + +### apiVersion + +• **apiVersion**: `"v1"` + +#### Overrides + +KubeResource.apiVersion + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:321](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L321) + +--- + +### content + +• `Optional` **content**: `void` + +#### Inherited from + +KubeResource.content + +#### Defined in + +packages/core/mdist/models/entity.d.ts:51 + +--- + +### contentType + +• `Optional` **contentType**: `string` + +#### Inherited from + +KubeResource.contentType + +#### Defined in + +packages/core/mdist/models/entity.d.ts:52 + +--- + +### isKubeResource + +• **isKubeResource**: `true` + +#### Inherited from + +KubeResource.isKubeResource + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:205](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L205) + +--- + +### isSimulacrum + +• `Optional` **isSimulacrum**: `boolean` + +#### Inherited from + +KubeResource.isSimulacrum + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:204](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L204) + +--- + +### kind + +• **kind**: `"Pod"` + +#### Overrides + +KubeResource.kind + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:322](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L322) + +--- + +### kuiRawData + +• `Optional` **kuiRawData**: `string` + +#### Inherited from + +KubeResource.kuiRawData + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:182](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L182) + +--- + +### metadata + +• `Optional` **metadata**: { `creationTimestamp?`: `string` ; `generation?`: `string` ; `labels?`: `Record`<`string`, `string`\> ; `name`: `string` ; `namespace?`: `string` } & `Partial`<`WithOwnerReferences`\> & `Partial`<`WithResourceVersion`\> & { `annotations?`: `object` ; `creationTimestamp?`: `string` ; `generateName?`: `string` ; `generation?`: `string` ; `labels?`: { [key: string]: `string`; } ; `name`: `string` ; `namespace?`: `string` ; `uid?`: `string` } + +#### Inherited from + +KubeResource.metadata + +#### Defined in + +packages/core/mdist/models/entity.d.ts:24 + +--- + +### nameHash + +• `Optional` **nameHash**: `string` + +#### Inherited from + +KubeResource.nameHash + +#### Defined in + +packages/core/mdist/models/entity.d.ts:43 + +--- + +### onclick + +• `Optional` **onclick**: `Object` + +family of onclick handlers + +#### Type declaration + +| Name | Type | +| :----------- | :------- | +| `kind?` | `string` | +| `name?` | `string` | +| `nameHash?` | `string` | +| `namespace?` | `string` | + +#### Inherited from + +KubeResource.onclick + +#### Defined in + +packages/core/mdist/models/entity.d.ts:45 + +--- + +### originatingCommand + +• **originatingCommand**: `EvaluatorArgs`<[`KubeOptions`](kui_shell_plugin_kubectl.KubeOptions.md)\> + +#### Inherited from + +KubeResource.originatingCommand + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:203](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L203) + +--- + +### presentation + +• `Optional` **presentation**: `Presentation` + +#### Inherited from + +KubeResource.presentation + +#### Defined in + +packages/core/mdist/models/entity.d.ts:54 + +--- + +### prettyName + +• `Optional` **prettyName**: `string` + +name hash, e.g. the hash part of auto-generated names, or an openwhisk activation id + +#### Inherited from + +KubeResource.prettyName + +#### Defined in + +packages/core/mdist/models/entity.d.ts:42 + +--- + +### spec + +• **spec**: [`PodLikeSpec`](kui_shell_plugin_kubectl.PodLikeSpec.md) & { `containers`: `ContainerSpec`[] ; `nodeName`: `string` ; `nominatedNodeName?`: `string` ; `readinessGates?`: { `conditionType`: `string` }[] } + +#### Overrides + +KubeResource.spec + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:323](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L323) + +--- + +### status + +• `Optional` **status**: `PodStatus` + +#### Inherited from + +KubeResource.status + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:199](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L199) + +--- + +### toolbarText + +• `Optional` **toolbarText**: `ToolbarText` + +#### Inherited from + +KubeResource.toolbarText + +#### Defined in + +packages/core/mdist/models/entity.d.ts:53 + +--- + +### version + +• `Optional` **version**: `string` + +optional designation of resource version + +#### Inherited from + +KubeResource.version + +#### Defined in + +packages/core/mdist/models/entity.d.ts:40 diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.PodLikeSpec.md b/docs/api/interfaces/kui_shell_plugin_kubectl.PodLikeSpec.md new file mode 100644 index 00000000000..018c70de405 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.PodLikeSpec.md @@ -0,0 +1,21 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / PodLikeSpec + +# Interface: PodLikeSpec + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).PodLikeSpec + +## Table of contents + +### Properties + +- [\_podName](kui_shell_plugin_kubectl.PodLikeSpec.md#_podname) + +## Properties + +### \_podName + +• **\_podName**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:318](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L318) diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.PodList.md b/docs/api/interfaces/kui_shell_plugin_kubectl.PodList.md new file mode 100644 index 00000000000..1968bab272e --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.PodList.md @@ -0,0 +1,297 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / PodList + +# Interface: PodList + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).PodList + +## Hierarchy + +- [`KubeResource`](../modules/kui_shell_plugin_kubectl.md#kuberesource) + + ↳ **`PodList`** + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_plugin_kubectl.PodList.md#apiversion) +- [content](kui_shell_plugin_kubectl.PodList.md#content) +- [contentType](kui_shell_plugin_kubectl.PodList.md#contenttype) +- [isKubeResource](kui_shell_plugin_kubectl.PodList.md#iskuberesource) +- [isSimulacrum](kui_shell_plugin_kubectl.PodList.md#issimulacrum) +- [items](kui_shell_plugin_kubectl.PodList.md#items) +- [kind](kui_shell_plugin_kubectl.PodList.md#kind) +- [kuiRawData](kui_shell_plugin_kubectl.PodList.md#kuirawdata) +- [metadata](kui_shell_plugin_kubectl.PodList.md#metadata) +- [nameHash](kui_shell_plugin_kubectl.PodList.md#namehash) +- [onclick](kui_shell_plugin_kubectl.PodList.md#onclick) +- [originatingCommand](kui_shell_plugin_kubectl.PodList.md#originatingcommand) +- [presentation](kui_shell_plugin_kubectl.PodList.md#presentation) +- [prettyName](kui_shell_plugin_kubectl.PodList.md#prettyname) +- [spec](kui_shell_plugin_kubectl.PodList.md#spec) +- [status](kui_shell_plugin_kubectl.PodList.md#status) +- [toolbarText](kui_shell_plugin_kubectl.PodList.md#toolbartext) +- [version](kui_shell_plugin_kubectl.PodList.md#version) + +## Properties + +### apiVersion + +• **apiVersion**: `"v1"` + +#### Overrides + +KubeResource.apiVersion + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:547](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L547) + +--- + +### content + +• `Optional` **content**: `void` + +#### Inherited from + +KubeResource.content + +#### Defined in + +packages/core/mdist/models/entity.d.ts:51 + +--- + +### contentType + +• `Optional` **contentType**: `string` + +#### Inherited from + +KubeResource.contentType + +#### Defined in + +packages/core/mdist/models/entity.d.ts:52 + +--- + +### isKubeResource + +• **isKubeResource**: `true` + +#### Inherited from + +KubeResource.isKubeResource + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:205](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L205) + +--- + +### isSimulacrum + +• `Optional` **isSimulacrum**: `boolean` + +#### Inherited from + +KubeResource.isSimulacrum + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:204](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L204) + +--- + +### items + +• **items**: [`KubePartial`](../modules/kui_shell_plugin_kubectl.md#kubepartial)<[`Pod`](kui_shell_plugin_kubectl.Pod.md)\>[] + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:549](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L549) + +--- + +### kind + +• **kind**: `"PodList"` + +#### Overrides + +KubeResource.kind + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:548](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L548) + +--- + +### kuiRawData + +• `Optional` **kuiRawData**: `string` + +#### Inherited from + +KubeResource.kuiRawData + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:182](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L182) + +--- + +### metadata + +• `Optional` **metadata**: { `creationTimestamp?`: `string` ; `generation?`: `string` ; `labels?`: `Record`<`string`, `string`\> ; `name`: `string` ; `namespace?`: `string` } & `Partial`<`WithOwnerReferences`\> & `Partial`<`WithResourceVersion`\> & { `annotations?`: `object` ; `creationTimestamp?`: `string` ; `generateName?`: `string` ; `generation?`: `string` ; `labels?`: { [key: string]: `string`; } ; `name`: `string` ; `namespace?`: `string` ; `uid?`: `string` } + +#### Inherited from + +KubeResource.metadata + +#### Defined in + +packages/core/mdist/models/entity.d.ts:24 + +--- + +### nameHash + +• `Optional` **nameHash**: `string` + +#### Inherited from + +KubeResource.nameHash + +#### Defined in + +packages/core/mdist/models/entity.d.ts:43 + +--- + +### onclick + +• `Optional` **onclick**: `Object` + +family of onclick handlers + +#### Type declaration + +| Name | Type | +| :----------- | :------- | +| `kind?` | `string` | +| `name?` | `string` | +| `nameHash?` | `string` | +| `namespace?` | `string` | + +#### Inherited from + +KubeResource.onclick + +#### Defined in + +packages/core/mdist/models/entity.d.ts:45 + +--- + +### originatingCommand + +• **originatingCommand**: `EvaluatorArgs`<[`KubeOptions`](kui_shell_plugin_kubectl.KubeOptions.md)\> + +#### Inherited from + +KubeResource.originatingCommand + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:203](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L203) + +--- + +### presentation + +• `Optional` **presentation**: `Presentation` + +#### Inherited from + +KubeResource.presentation + +#### Defined in + +packages/core/mdist/models/entity.d.ts:54 + +--- + +### prettyName + +• `Optional` **prettyName**: `string` + +name hash, e.g. the hash part of auto-generated names, or an openwhisk activation id + +#### Inherited from + +KubeResource.prettyName + +#### Defined in + +packages/core/mdist/models/entity.d.ts:42 + +--- + +### spec + +• `Optional` **spec**: `any` + +#### Inherited from + +KubeResource.spec + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:200](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L200) + +--- + +### status + +• `Optional` **status**: [`KubeStatus`](kui_shell_plugin_kubectl.KubeStatus.md) + +#### Inherited from + +KubeResource.status + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:199](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L199) + +--- + +### toolbarText + +• `Optional` **toolbarText**: `ToolbarText` + +#### Inherited from + +KubeResource.toolbarText + +#### Defined in + +packages/core/mdist/models/entity.d.ts:53 + +--- + +### version + +• `Optional` **version**: `string` + +optional designation of resource version + +#### Inherited from + +KubeResource.version + +#### Defined in + +packages/core/mdist/models/entity.d.ts:40 diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.Resource.md b/docs/api/interfaces/kui_shell_plugin_kubectl.Resource.md new file mode 100644 index 00000000000..82178aaa7e2 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.Resource.md @@ -0,0 +1,60 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / Resource + +# Interface: Resource + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).Resource + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------- | +| `T` | [`KubeResource`](../modules/kui_shell_plugin_kubectl.md#kuberesource) | + +## Table of contents + +### Properties + +- [filepathForDrilldown](kui_shell_plugin_kubectl.Resource.md#filepathfordrilldown) +- [kind](kui_shell_plugin_kubectl.Resource.md#kind) +- [name](kui_shell_plugin_kubectl.Resource.md#name) +- [resource](kui_shell_plugin_kubectl.Resource.md#resource) + +## Properties + +### filepathForDrilldown + +• `Optional` **filepathForDrilldown**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:636](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L636) + +--- + +### kind + +• `Optional` **kind**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:637](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L637) + +--- + +### name + +• `Optional` **name**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:638](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L638) + +--- + +### resource + +• **resource**: `T` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:639](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L639) diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.Secret.md b/docs/api/interfaces/kui_shell_plugin_kubectl.Secret.md new file mode 100644 index 00000000000..727807fb3f6 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.Secret.md @@ -0,0 +1,316 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / Secret + +# Interface: Secret + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).Secret + +Kubernetes Secret + +## Type parameters + +| Name | Type | +| :--- | :------------------------- | +| `T` | `Record`<`string`, `any`\> | + +## Hierarchy + +- [`KubeResource`](../modules/kui_shell_plugin_kubectl.md#kuberesource) + + ↳ **`Secret`** + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_plugin_kubectl.Secret.md#apiversion) +- [content](kui_shell_plugin_kubectl.Secret.md#content) +- [contentType](kui_shell_plugin_kubectl.Secret.md#contenttype) +- [data](kui_shell_plugin_kubectl.Secret.md#data) +- [isKubeResource](kui_shell_plugin_kubectl.Secret.md#iskuberesource) +- [isSimulacrum](kui_shell_plugin_kubectl.Secret.md#issimulacrum) +- [kind](kui_shell_plugin_kubectl.Secret.md#kind) +- [kuiRawData](kui_shell_plugin_kubectl.Secret.md#kuirawdata) +- [metadata](kui_shell_plugin_kubectl.Secret.md#metadata) +- [nameHash](kui_shell_plugin_kubectl.Secret.md#namehash) +- [onclick](kui_shell_plugin_kubectl.Secret.md#onclick) +- [originatingCommand](kui_shell_plugin_kubectl.Secret.md#originatingcommand) +- [presentation](kui_shell_plugin_kubectl.Secret.md#presentation) +- [prettyName](kui_shell_plugin_kubectl.Secret.md#prettyname) +- [spec](kui_shell_plugin_kubectl.Secret.md#spec) +- [status](kui_shell_plugin_kubectl.Secret.md#status) +- [toolbarText](kui_shell_plugin_kubectl.Secret.md#toolbartext) +- [type](kui_shell_plugin_kubectl.Secret.md#type) +- [version](kui_shell_plugin_kubectl.Secret.md#version) + +## Properties + +### apiVersion + +• **apiVersion**: `"v1"` + +#### Overrides + +KubeResource.apiVersion + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:754](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L754) + +--- + +### content + +• `Optional` **content**: `void` + +#### Inherited from + +KubeResource.content + +#### Defined in + +packages/core/mdist/models/entity.d.ts:51 + +--- + +### contentType + +• `Optional` **contentType**: `string` + +#### Inherited from + +KubeResource.contentType + +#### Defined in + +packages/core/mdist/models/entity.d.ts:52 + +--- + +### data + +• **data**: `T` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:757](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L757) + +--- + +### isKubeResource + +• **isKubeResource**: `true` + +#### Inherited from + +KubeResource.isKubeResource + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:205](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L205) + +--- + +### isSimulacrum + +• `Optional` **isSimulacrum**: `boolean` + +#### Inherited from + +KubeResource.isSimulacrum + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:204](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L204) + +--- + +### kind + +• **kind**: `"Secret"` + +#### Overrides + +KubeResource.kind + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:755](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L755) + +--- + +### kuiRawData + +• `Optional` **kuiRawData**: `string` + +#### Inherited from + +KubeResource.kuiRawData + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:182](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L182) + +--- + +### metadata + +• `Optional` **metadata**: { `creationTimestamp?`: `string` ; `generation?`: `string` ; `labels?`: `Record`<`string`, `string`\> ; `name`: `string` ; `namespace?`: `string` } & `Partial`<`WithOwnerReferences`\> & `Partial`<`WithResourceVersion`\> & { `annotations?`: `object` ; `creationTimestamp?`: `string` ; `generateName?`: `string` ; `generation?`: `string` ; `labels?`: { [key: string]: `string`; } ; `name`: `string` ; `namespace?`: `string` ; `uid?`: `string` } + +#### Inherited from + +KubeResource.metadata + +#### Defined in + +packages/core/mdist/models/entity.d.ts:24 + +--- + +### nameHash + +• `Optional` **nameHash**: `string` + +#### Inherited from + +KubeResource.nameHash + +#### Defined in + +packages/core/mdist/models/entity.d.ts:43 + +--- + +### onclick + +• `Optional` **onclick**: `Object` + +family of onclick handlers + +#### Type declaration + +| Name | Type | +| :----------- | :------- | +| `kind?` | `string` | +| `name?` | `string` | +| `nameHash?` | `string` | +| `namespace?` | `string` | + +#### Inherited from + +KubeResource.onclick + +#### Defined in + +packages/core/mdist/models/entity.d.ts:45 + +--- + +### originatingCommand + +• **originatingCommand**: `EvaluatorArgs`<[`KubeOptions`](kui_shell_plugin_kubectl.KubeOptions.md)\> + +#### Inherited from + +KubeResource.originatingCommand + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:203](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L203) + +--- + +### presentation + +• `Optional` **presentation**: `Presentation` + +#### Inherited from + +KubeResource.presentation + +#### Defined in + +packages/core/mdist/models/entity.d.ts:54 + +--- + +### prettyName + +• `Optional` **prettyName**: `string` + +name hash, e.g. the hash part of auto-generated names, or an openwhisk activation id + +#### Inherited from + +KubeResource.prettyName + +#### Defined in + +packages/core/mdist/models/entity.d.ts:42 + +--- + +### spec + +• `Optional` **spec**: `any` + +#### Inherited from + +KubeResource.spec + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:200](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L200) + +--- + +### status + +• `Optional` **status**: [`KubeStatus`](kui_shell_plugin_kubectl.KubeStatus.md) + +#### Inherited from + +KubeResource.status + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:199](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L199) + +--- + +### toolbarText + +• `Optional` **toolbarText**: `ToolbarText` + +#### Inherited from + +KubeResource.toolbarText + +#### Defined in + +packages/core/mdist/models/entity.d.ts:53 + +--- + +### type + +• **type**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:756](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L756) + +--- + +### version + +• `Optional` **version**: `string` + +optional designation of resource version + +#### Inherited from + +KubeResource.version + +#### Defined in + +packages/core/mdist/models/entity.d.ts:40 diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.WithRawData.md b/docs/api/interfaces/kui_shell_plugin_kubectl.WithRawData.md new file mode 100644 index 00000000000..917da679f58 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.WithRawData.md @@ -0,0 +1,223 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / WithRawData + +# Interface: WithRawData + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).WithRawData + +## Type parameters + +| Name | Type | +| :-------- | :----- | +| `Content` | `void` | + +## Hierarchy + +- `ResourceWithMetadata`<`Content`\> + + ↳ **`WithRawData`** + +## Table of contents + +### Properties + +- [apiVersion](kui_shell_plugin_kubectl.WithRawData.md#apiversion) +- [content](kui_shell_plugin_kubectl.WithRawData.md#content) +- [contentType](kui_shell_plugin_kubectl.WithRawData.md#contenttype) +- [kind](kui_shell_plugin_kubectl.WithRawData.md#kind) +- [kuiRawData](kui_shell_plugin_kubectl.WithRawData.md#kuirawdata) +- [metadata](kui_shell_plugin_kubectl.WithRawData.md#metadata) +- [nameHash](kui_shell_plugin_kubectl.WithRawData.md#namehash) +- [onclick](kui_shell_plugin_kubectl.WithRawData.md#onclick) +- [presentation](kui_shell_plugin_kubectl.WithRawData.md#presentation) +- [prettyName](kui_shell_plugin_kubectl.WithRawData.md#prettyname) +- [toolbarText](kui_shell_plugin_kubectl.WithRawData.md#toolbartext) +- [version](kui_shell_plugin_kubectl.WithRawData.md#version) + +## Properties + +### apiVersion + +• `Optional` **apiVersion**: `string` + +#### Inherited from + +ResourceWithMetadata.apiVersion + +#### Defined in + +packages/core/mdist/models/entity.d.ts:38 + +--- + +### content + +• `Optional` **content**: `Content` + +#### Inherited from + +ResourceWithMetadata.content + +#### Defined in + +packages/core/mdist/models/entity.d.ts:51 + +--- + +### contentType + +• `Optional` **contentType**: `string` + +#### Inherited from + +ResourceWithMetadata.contentType + +#### Defined in + +packages/core/mdist/models/entity.d.ts:52 + +--- + +### kind + +• `Optional` **kind**: `string` + +#### Inherited from + +ResourceWithMetadata.kind + +#### Defined in + +packages/core/mdist/models/entity.d.ts:23 + +--- + +### kuiRawData + +• `Optional` **kuiRawData**: `string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:182](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L182) + +--- + +### metadata + +• `Optional` **metadata**: `Object` + +#### Type declaration + +| Name | Type | +| :------------------- | :---------------------------- | +| `creationTimestamp?` | `string` | +| `generation?` | `string` | +| `labels?` | `Record`<`string`, `string`\> | +| `name` | `string` | +| `namespace?` | `string` | + +#### Inherited from + +ResourceWithMetadata.metadata + +#### Defined in + +packages/core/mdist/models/entity.d.ts:24 + +--- + +### nameHash + +• `Optional` **nameHash**: `string` + +#### Inherited from + +ResourceWithMetadata.nameHash + +#### Defined in + +packages/core/mdist/models/entity.d.ts:43 + +--- + +### onclick + +• `Optional` **onclick**: `Object` + +family of onclick handlers + +#### Type declaration + +| Name | Type | +| :----------- | :------- | +| `kind?` | `string` | +| `name?` | `string` | +| `nameHash?` | `string` | +| `namespace?` | `string` | + +#### Inherited from + +ResourceWithMetadata.onclick + +#### Defined in + +packages/core/mdist/models/entity.d.ts:45 + +--- + +### presentation + +• `Optional` **presentation**: `Presentation` + +#### Inherited from + +ResourceWithMetadata.presentation + +#### Defined in + +packages/core/mdist/models/entity.d.ts:54 + +--- + +### prettyName + +• `Optional` **prettyName**: `string` + +name hash, e.g. the hash part of auto-generated names, or an openwhisk activation id + +#### Inherited from + +ResourceWithMetadata.prettyName + +#### Defined in + +packages/core/mdist/models/entity.d.ts:42 + +--- + +### toolbarText + +• `Optional` **toolbarText**: `ToolbarText` + +#### Inherited from + +ResourceWithMetadata.toolbarText + +#### Defined in + +packages/core/mdist/models/entity.d.ts:53 + +--- + +### version + +• `Optional` **version**: `string` + +optional designation of resource version + +#### Inherited from + +ResourceWithMetadata.version + +#### Defined in + +packages/core/mdist/models/entity.d.ts:40 diff --git a/docs/api/interfaces/kui_shell_plugin_kubectl.WithSummary.md b/docs/api/interfaces/kui_shell_plugin_kubectl.WithSummary.md new file mode 100644 index 00000000000..40bf3d34c80 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_kubectl.WithSummary.md @@ -0,0 +1,28 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md) / WithSummary + +# Interface: WithSummary + +[@kui-shell/plugin-kubectl](../modules/kui_shell_plugin_kubectl.md).WithSummary + +## Table of contents + +### Properties + +- [summary](kui_shell_plugin_kubectl.WithSummary.md#summary) + +## Properties + +### summary + +• **summary**: `Object` + +#### Type declaration + +| Name | Type | +| :------------- | :---------------------------- | +| `content` | `string` | +| `contentType?` | `"yaml"` \| `"text/markdown"` | + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:226](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L226) diff --git a/docs/api/interfaces/kui_shell_plugin_s3.MinioConfig.md b/docs/api/interfaces/kui_shell_plugin_s3.MinioConfig.md new file mode 100644 index 00000000000..464a4585188 --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_s3.MinioConfig.md @@ -0,0 +1,32 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-s3](../modules/kui_shell_plugin_s3.md) / MinioConfig + +# Interface: MinioConfig + +[@kui-shell/plugin-s3](../modules/kui_shell_plugin_s3.md).MinioConfig + +## Table of contents + +### Properties + +- [aliases](kui_shell_plugin_s3.MinioConfig.md#aliases) +- [version](kui_shell_plugin_s3.MinioConfig.md#version) + +## Properties + +### aliases + +• **aliases**: `Record`<`string`, `Object`\> + +#### Defined in + +[plugins/plugin-s3/src/providers/MinioConfig.ts:19](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/providers/MinioConfig.ts#L19) + +--- + +### version + +• **version**: `string` + +#### Defined in + +[plugins/plugin-s3/src/providers/MinioConfig.ts:18](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/providers/MinioConfig.ts#L18) diff --git a/docs/api/interfaces/kui_shell_plugin_s3.Mount.md b/docs/api/interfaces/kui_shell_plugin_s3.Mount.md new file mode 100644 index 00000000000..27949206b0a --- /dev/null +++ b/docs/api/interfaces/kui_shell_plugin_s3.Mount.md @@ -0,0 +1,76 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/plugin-s3](../modules/kui_shell_plugin_s3.md) / Mount + +# Interface: Mount + +[@kui-shell/plugin-s3](../modules/kui_shell_plugin_s3.md).Mount + +## Table of contents + +### Properties + +- [error](kui_shell_plugin_s3.Mount.md#error) +- [isDefault](kui_shell_plugin_s3.Mount.md#isdefault) +- [isMounted](kui_shell_plugin_s3.Mount.md#ismounted) +- [mountPath](kui_shell_plugin_s3.Mount.md#mountpath) +- [provider](kui_shell_plugin_s3.Mount.md#provider) +- [publicOnly](kui_shell_plugin_s3.Mount.md#publiconly) + +## Properties + +### error + +• `Optional` **error**: `Error` + +#### Defined in + +[plugins/plugin-s3/src/vfs/responders.ts:33](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/vfs/responders.ts#L33) + +--- + +### isDefault + +• `Optional` **isDefault**: `boolean` + +#### Defined in + +[plugins/plugin-s3/src/vfs/responders.ts:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/vfs/responders.ts#L34) + +--- + +### isMounted + +• **isMounted**: `boolean` + +#### Defined in + +[plugins/plugin-s3/src/vfs/responders.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/vfs/responders.ts#L31) + +--- + +### mountPath + +• **mountPath**: `string` + +#### Defined in + +[plugins/plugin-s3/src/vfs/responders.ts:32](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/vfs/responders.ts#L32) + +--- + +### provider + +• **provider**: `string` + +#### Defined in + +[plugins/plugin-s3/src/vfs/responders.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/vfs/responders.ts#L30) + +--- + +### publicOnly + +• **publicOnly**: `boolean` + +#### Defined in + +[plugins/plugin-s3/src/vfs/responders.ts:35](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/vfs/responders.ts#L35) diff --git a/docs/api/interfaces/kui_shell_test.Common.BeforeOptions.md b/docs/api/interfaces/kui_shell_test.Common.BeforeOptions.md new file mode 100644 index 00000000000..ea70d8b9a0a --- /dev/null +++ b/docs/api/interfaces/kui_shell_test.Common.BeforeOptions.md @@ -0,0 +1,76 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](../modules/kui_shell_test.md) / [Common](../modules/kui_shell_test.Common.md) / BeforeOptions + +# Interface: BeforeOptions + +[@kui-shell/test](../modules/kui_shell_test.md).[Common](../modules/kui_shell_test.Common.md).BeforeOptions + +## Table of contents + +### Properties + +- [noApp](kui_shell_test.Common.BeforeOptions.md#noapp) +- [noProxySessionWait](kui_shell_test.Common.BeforeOptions.md#noproxysessionwait) +- [popup](kui_shell_test.Common.BeforeOptions.md#popup) + +### Methods + +- [afterStart](kui_shell_test.Common.BeforeOptions.md#afterstart) +- [beforeStart](kui_shell_test.Common.BeforeOptions.md#beforestart) + +## Properties + +### noApp + +• `Optional` **noApp**: `boolean` + +#### Defined in + +[packages/test/src/api/common.ts:277](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L277) + +--- + +### noProxySessionWait + +• `Optional` **noProxySessionWait**: `boolean` + +#### Defined in + +[packages/test/src/api/common.ts:279](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L279) + +--- + +### popup + +• `Optional` **popup**: `string`[] + +#### Defined in + +[packages/test/src/api/common.ts:278](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L278) + +## Methods + +### afterStart + +▸ `Optional` **afterStart**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/common.ts:280](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L280) + +--- + +### beforeStart + +▸ `Optional` **beforeStart**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/common.ts:281](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L281) diff --git a/docs/api/interfaces/kui_shell_test.Common.ISuite.md b/docs/api/interfaces/kui_shell_test.Common.ISuite.md new file mode 100644 index 00000000000..7b745c59d00 --- /dev/null +++ b/docs/api/interfaces/kui_shell_test.Common.ISuite.md @@ -0,0 +1,2901 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](../modules/kui_shell_test.md) / [Common](../modules/kui_shell_test.Common.md) / ISuite + +# Interface: ISuite + +[@kui-shell/test](../modules/kui_shell_test.md).[Common](../modules/kui_shell_test.Common.md).ISuite + +## Hierarchy + +- `Suite` + + ↳ **`ISuite`** + +## Table of contents + +### Properties + +- [\_kuiDestroyAfter](kui_shell_test.Common.ISuite.md#_kuidestroyafter) +- [app](kui_shell_test.Common.ISuite.md#app) +- [ctx](kui_shell_test.Common.ISuite.md#ctx) +- [delayed](kui_shell_test.Common.ISuite.md#delayed) +- [file](kui_shell_test.Common.ISuite.md#file) +- [parent](kui_shell_test.Common.ISuite.md#parent) +- [pending](kui_shell_test.Common.ISuite.md#pending) +- [root](kui_shell_test.Common.ISuite.md#root) +- [suites](kui_shell_test.Common.ISuite.md#suites) +- [tests](kui_shell_test.Common.ISuite.md#tests) +- [title](kui_shell_test.Common.ISuite.md#title) + +### Methods + +- [\_createHook](kui_shell_test.Common.ISuite.md#_createhook) +- [addListener](kui_shell_test.Common.ISuite.md#addlistener) +- [addSuite](kui_shell_test.Common.ISuite.md#addsuite) +- [addTest](kui_shell_test.Common.ISuite.md#addtest) +- [afterAll](kui_shell_test.Common.ISuite.md#afterall) +- [afterEach](kui_shell_test.Common.ISuite.md#aftereach) +- [bail](kui_shell_test.Common.ISuite.md#bail) +- [beforeAll](kui_shell_test.Common.ISuite.md#beforeall) +- [beforeEach](kui_shell_test.Common.ISuite.md#beforeeach) +- [clone](kui_shell_test.Common.ISuite.md#clone) +- [dispose](kui_shell_test.Common.ISuite.md#dispose) +- [eachTest](kui_shell_test.Common.ISuite.md#eachtest) +- [emit](kui_shell_test.Common.ISuite.md#emit) +- [eventNames](kui_shell_test.Common.ISuite.md#eventnames) +- [fullTitle](kui_shell_test.Common.ISuite.md#fulltitle) +- [getMaxListeners](kui_shell_test.Common.ISuite.md#getmaxlisteners) +- [isPending](kui_shell_test.Common.ISuite.md#ispending) +- [listenerCount](kui_shell_test.Common.ISuite.md#listenercount) +- [listeners](kui_shell_test.Common.ISuite.md#listeners) +- [off](kui_shell_test.Common.ISuite.md#off) +- [on](kui_shell_test.Common.ISuite.md#on) +- [once](kui_shell_test.Common.ISuite.md#once) +- [prependListener](kui_shell_test.Common.ISuite.md#prependlistener) +- [prependOnceListener](kui_shell_test.Common.ISuite.md#prependoncelistener) +- [rawListeners](kui_shell_test.Common.ISuite.md#rawlisteners) +- [removeAllListeners](kui_shell_test.Common.ISuite.md#removealllisteners) +- [removeListener](kui_shell_test.Common.ISuite.md#removelistener) +- [retries](kui_shell_test.Common.ISuite.md#retries) +- [run](kui_shell_test.Common.ISuite.md#run) +- [setMaxListeners](kui_shell_test.Common.ISuite.md#setmaxlisteners) +- [slow](kui_shell_test.Common.ISuite.md#slow) +- [timeout](kui_shell_test.Common.ISuite.md#timeout) +- [titlePath](kui_shell_test.Common.ISuite.md#titlepath) +- [total](kui_shell_test.Common.ISuite.md#total) + +## Properties + +### \_kuiDestroyAfter + +• `Optional` **\_kuiDestroyAfter**: `boolean` + +#### Defined in + +[packages/test/src/api/common.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L44) + +--- + +### app + +• **app**: `Application` + +#### Defined in + +[packages/test/src/api/common.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L43) + +--- + +### ctx + +• **ctx**: `Context` + +#### Inherited from + +Suite.ctx + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1766 + +--- + +### delayed + +• **delayed**: `boolean` + +#### Inherited from + +Suite.delayed + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1772 + +--- + +### file + +• `Optional` **file**: `string` + +#### Inherited from + +Suite.file + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1770 + +--- + +### parent + +• **parent**: `Suite` + +#### Inherited from + +Suite.parent + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1773 + +--- + +### pending + +• **pending**: `boolean` + +#### Inherited from + +Suite.pending + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1769 + +--- + +### root + +• **root**: `boolean` + +#### Inherited from + +Suite.root + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1771 + +--- + +### suites + +• **suites**: `Suite`[] + +#### Inherited from + +Suite.suites + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1767 + +--- + +### tests + +• **tests**: `Test`[] + +#### Inherited from + +Suite.tests + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1768 + +--- + +### title + +• **title**: `string` + +#### Inherited from + +Suite.title + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1774 + +## Methods + +### \_createHook + +▸ `Protected` **\_createHook**(`title`, `fn?`): `Hook` + +Generic hook-creator. + +#### Parameters + +| Name | Type | +| :------ | :-------------------- | +| `title` | `string` | +| `fn?` | `Func` \| `AsyncFunc` | + +#### Returns + +`Hook` + +#### Inherited from + +Suite.\_createHook + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2029 + +--- + +### addListener + +▸ **addListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2036 + +▸ **addListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2047 + +▸ **addListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2058 + +▸ **addListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2069 + +▸ **addListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------- | +| `event` | `"suite"` | +| `listener` | (`suite`: `Suite`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2080 + +▸ **addListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"test"` | +| `listener` | (`test`: `Test`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2091 + +▸ **addListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------- | +| `event` | `"run"` | +| `listener` | () => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2102 + +▸ **addListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"pre-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2113 + +▸ **addListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------- | +| `event` | `"require"` | +| `listener` | (`module`: `any`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2124 + +▸ **addListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"post-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2135 + +▸ **addListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2146 + +--- + +### addSuite + +▸ **addSuite**(`suite`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Add a test `suite`. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#addSuite + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `suite` | `Suite` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addSuite + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1972 + +--- + +### addTest + +▸ **addTest**(`test`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Add a `test` to this suite. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#addTest + +#### Parameters + +| Name | Type | +| :----- | :----- | +| `test` | `Test` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.addTest + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1979 + +--- + +### afterAll + +▸ **afterAll**(`fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` after running tests. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#afterAll + +#### Parameters + +| Name | Type | +| :---- | :----- | +| `fn?` | `Func` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.afterAll + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1888 + +▸ **afterAll**(`fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` after running tests. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#afterAll + +#### Parameters + +| Name | Type | +| :---- | :---------- | +| `fn?` | `AsyncFunc` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.afterAll + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1895 + +▸ **afterAll**(`title`, `fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` after running tests. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#afterAll + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `title` | `string` | +| `fn?` | `Func` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.afterAll + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1902 + +▸ **afterAll**(`title`, `fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` after running tests. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#afterAll + +#### Parameters + +| Name | Type | +| :------ | :---------- | +| `title` | `string` | +| `fn?` | `AsyncFunc` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.afterAll + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1909 + +--- + +### afterEach + +▸ **afterEach**(`fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` after each test case. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#afterEach + +#### Parameters + +| Name | Type | +| :---- | :----- | +| `fn?` | `Func` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.afterEach + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1944 + +▸ **afterEach**(`fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` after each test case. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#afterEach + +#### Parameters + +| Name | Type | +| :---- | :---------- | +| `fn?` | `AsyncFunc` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.afterEach + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1951 + +▸ **afterEach**(`title`, `fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` after each test case. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#afterEach + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `title` | `string` | +| `fn?` | `Func` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.afterEach + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1958 + +▸ **afterEach**(`title`, `fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` after each test case. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#afterEach + +#### Parameters + +| Name | Type | +| :------ | :---------- | +| `title` | `string` | +| `fn?` | `AsyncFunc` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.afterEach + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1965 + +--- + +### bail + +▸ **bail**(): `boolean` + +Get whether to bail after first error. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#bail + +#### Returns + +`boolean` + +#### Inherited from + +Suite.bail + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1839 + +▸ **bail**(`bail`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Set whether to bail after first error. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#bail + +#### Parameters + +| Name | Type | +| :----- | :-------- | +| `bail` | `boolean` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.bail + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1846 + +--- + +### beforeAll + +▸ **beforeAll**(`fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` before running tests. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#beforeAll + +#### Parameters + +| Name | Type | +| :---- | :----- | +| `fn?` | `Func` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.beforeAll + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1860 + +▸ **beforeAll**(`fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` before running tests. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#beforeAll + +#### Parameters + +| Name | Type | +| :---- | :---------- | +| `fn?` | `AsyncFunc` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.beforeAll + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1867 + +▸ **beforeAll**(`title`, `fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` before running tests. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#beforeAll + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `title` | `string` | +| `fn?` | `Func` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.beforeAll + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1874 + +▸ **beforeAll**(`title`, `fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` before running tests. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#beforeAll + +#### Parameters + +| Name | Type | +| :------ | :---------- | +| `title` | `string` | +| `fn?` | `AsyncFunc` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.beforeAll + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1881 + +--- + +### beforeEach + +▸ **beforeEach**(`fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` before each test case. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#beforeEach + +#### Parameters + +| Name | Type | +| :---- | :----- | +| `fn?` | `Func` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.beforeEach + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1916 + +▸ **beforeEach**(`fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` before each test case. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#beforeEach + +#### Parameters + +| Name | Type | +| :---- | :---------- | +| `fn?` | `AsyncFunc` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.beforeEach + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1923 + +▸ **beforeEach**(`title`, `fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` before each test case. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#beforeEach + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `title` | `string` | +| `fn?` | `Func` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.beforeEach + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1930 + +▸ **beforeEach**(`title`, `fn?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Run `fn(test[, done])` before each test case. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#beforeEach + +#### Parameters + +| Name | Type | +| :------ | :---------- | +| `title` | `string` | +| `fn?` | `AsyncFunc` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.beforeEach + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1937 + +--- + +### clone + +▸ **clone**(): `Suite` + +Return a clone of this `Suite`. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#clone + +#### Returns + +`Suite` + +#### Inherited from + +Suite.clone + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1790 + +--- + +### dispose + +▸ **dispose**(): `void` + +Cleans all references from this suite and all child suites. + +https://mochajs.org/api/suite#dispose + +#### Returns + +`void` + +#### Inherited from + +Suite.dispose + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1986 + +--- + +### eachTest + +▸ **eachTest**(`fn`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Iterates through each suite recursively to find all tests. Applies a +function in the format `fn(test)`. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#eachTest + +#### Parameters + +| Name | Type | +| :--- | :------------------------- | +| `fn` | (`test`: `Test`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.eachTest + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2017 + +--- + +### emit + +▸ **emit**(`name`, `hook`): `boolean` + +#### Parameters + +| Name | Type | +| :----- | :------------ | +| `name` | `"beforeAll"` | +| `hook` | `Hook` | + +#### Returns + +`boolean` + +#### Inherited from + +Suite.emit + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2040 + +▸ **emit**(`name`, `hook`): `boolean` + +#### Parameters + +| Name | Type | +| :----- | :----------- | +| `name` | `"afterAll"` | +| `hook` | `Hook` | + +#### Returns + +`boolean` + +#### Inherited from + +Suite.emit + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2051 + +▸ **emit**(`name`, `hook`): `boolean` + +#### Parameters + +| Name | Type | +| :----- | :------------- | +| `name` | `"beforeEach"` | +| `hook` | `Hook` | + +#### Returns + +`boolean` + +#### Inherited from + +Suite.emit + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2062 + +▸ **emit**(`name`, `hook`): `boolean` + +#### Parameters + +| Name | Type | +| :----- | :------------ | +| `name` | `"afterEach"` | +| `hook` | `Hook` | + +#### Returns + +`boolean` + +#### Inherited from + +Suite.emit + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2073 + +▸ **emit**(`name`, `suite`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :-------- | +| `name` | `"suite"` | +| `suite` | `Suite` | + +#### Returns + +`boolean` + +#### Inherited from + +Suite.emit + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2084 + +▸ **emit**(`name`, `test`): `boolean` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `name` | `"test"` | +| `test` | `Test` | + +#### Returns + +`boolean` + +#### Inherited from + +Suite.emit + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2095 + +▸ **emit**(`name`): `boolean` + +#### Parameters + +| Name | Type | +| :----- | :------ | +| `name` | `"run"` | + +#### Returns + +`boolean` + +#### Inherited from + +Suite.emit + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2106 + +▸ **emit**(`name`, `context`, `file`, `mocha`): `boolean` + +#### Parameters + +| Name | Type | +| :-------- | :-------------- | +| `name` | `"pre-require"` | +| `context` | `MochaGlobals` | +| `file` | `string` | +| `mocha` | `Mocha` | + +#### Returns + +`boolean` + +#### Inherited from + +Suite.emit + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2117 + +▸ **emit**(`name`, `module`, `file`, `mocha`): `boolean` + +#### Parameters + +| Name | Type | +| :------- | :---------- | +| `name` | `"require"` | +| `module` | `any` | +| `file` | `string` | +| `mocha` | `Mocha` | + +#### Returns + +`boolean` + +#### Inherited from + +Suite.emit + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2128 + +▸ **emit**(`name`, `context`, `file`, `mocha`): `boolean` + +#### Parameters + +| Name | Type | +| :-------- | :--------------- | +| `name` | `"post-require"` | +| `context` | `MochaGlobals` | +| `file` | `string` | +| `mocha` | `Mocha` | + +#### Returns + +`boolean` + +#### Inherited from + +Suite.emit + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2139 + +▸ **emit**(`name`, ...`args`): `boolean` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `name` | `string` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Inherited from + +Suite.emit + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2150 + +--- + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +#### Returns + +(`string` \| `symbol`)[] + +#### Inherited from + +Suite.eventNames + +#### Defined in + +node_modules/@types/node/globals.d.ts:633 + +--- + +### fullTitle + +▸ **fullTitle**(): `string` + +Return the full title generated by recursively concatenating the parent's +full title. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#.Suite#fullTitle + +#### Returns + +`string` + +#### Inherited from + +Suite.fullTitle + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1994 + +--- + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +#### Returns + +`number` + +#### Inherited from + +Suite.getMaxListeners + +#### Defined in + +node_modules/@types/node/globals.d.ts:625 + +--- + +### isPending + +▸ **isPending**(): `boolean` + +Check if this suite or its parent suite is marked as pending. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#isPending + +#### Returns + +`boolean` + +#### Inherited from + +Suite.isPending + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1853 + +--- + +### listenerCount + +▸ **listenerCount**(`type`): `number` + +#### Parameters + +| Name | Type | +| :----- | :------------------- | +| `type` | `string` \| `symbol` | + +#### Returns + +`number` + +#### Inherited from + +Suite.listenerCount + +#### Defined in + +node_modules/@types/node/globals.d.ts:629 + +--- + +### listeners + +▸ **listeners**(`event`): `Function`[] + +#### Parameters + +| Name | Type | +| :------ | :------------------- | +| `event` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Inherited from + +Suite.listeners + +#### Defined in + +node_modules/@types/node/globals.d.ts:626 + +--- + +### off + +▸ **off**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.off + +#### Defined in + +node_modules/@types/node/globals.d.ts:622 + +--- + +### on + +▸ **on**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.on + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2034 + +▸ **on**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.on + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2045 + +▸ **on**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.on + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2056 + +▸ **on**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.on + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2067 + +▸ **on**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------- | +| `event` | `"suite"` | +| `listener` | (`suite`: `Suite`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.on + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2078 + +▸ **on**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"test"` | +| `listener` | (`test`: `Test`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.on + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2089 + +▸ **on**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------- | +| `event` | `"run"` | +| `listener` | () => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.on + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2100 + +▸ **on**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"pre-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.on + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2111 + +▸ **on**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------- | +| `event` | `"require"` | +| `listener` | (`module`: `any`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.on + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2122 + +▸ **on**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"post-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.on + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2133 + +▸ **on**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.on + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2144 + +--- + +### once + +▸ **once**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.once + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2035 + +▸ **once**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.once + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2046 + +▸ **once**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.once + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2057 + +▸ **once**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.once + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2068 + +▸ **once**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------- | +| `event` | `"suite"` | +| `listener` | (`suite`: `Suite`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.once + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2079 + +▸ **once**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"test"` | +| `listener` | (`test`: `Test`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.once + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2090 + +▸ **once**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------- | +| `event` | `"run"` | +| `listener` | () => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.once + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2101 + +▸ **once**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"pre-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.once + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2112 + +▸ **once**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------- | +| `event` | `"require"` | +| `listener` | (`module`: `any`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.once + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2123 + +▸ **once**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"post-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.once + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2134 + +▸ **once**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.once + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2145 + +--- + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2038 + +▸ **prependListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2049 + +▸ **prependListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2060 + +▸ **prependListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2071 + +▸ **prependListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------- | +| `event` | `"suite"` | +| `listener` | (`suite`: `Suite`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2082 + +▸ **prependListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"test"` | +| `listener` | (`test`: `Test`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2093 + +▸ **prependListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------- | +| `event` | `"run"` | +| `listener` | () => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2104 + +▸ **prependListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"pre-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2115 + +▸ **prependListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------- | +| `event` | `"require"` | +| `listener` | (`module`: `any`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2126 + +▸ **prependListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"post-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2137 + +▸ **prependListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2148 + +--- + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependOnceListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2039 + +▸ **prependOnceListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependOnceListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2050 + +▸ **prependOnceListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependOnceListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2061 + +▸ **prependOnceListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependOnceListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2072 + +▸ **prependOnceListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------- | +| `event` | `"suite"` | +| `listener` | (`suite`: `Suite`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependOnceListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2083 + +▸ **prependOnceListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"test"` | +| `listener` | (`test`: `Test`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependOnceListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2094 + +▸ **prependOnceListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------- | +| `event` | `"run"` | +| `listener` | () => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependOnceListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2105 + +▸ **prependOnceListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"pre-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependOnceListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2116 + +▸ **prependOnceListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------- | +| `event` | `"require"` | +| `listener` | (`module`: `any`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependOnceListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2127 + +▸ **prependOnceListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"post-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependOnceListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2138 + +▸ **prependOnceListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.prependOnceListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2149 + +--- + +### rawListeners + +▸ **rawListeners**(`event`): `Function`[] + +#### Parameters + +| Name | Type | +| :------ | :------------------- | +| `event` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +#### Inherited from + +Suite.rawListeners + +#### Defined in + +node_modules/@types/node/globals.d.ts:627 + +--- + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :------- | :------------------- | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeAllListeners + +#### Defined in + +node_modules/@types/node/globals.d.ts:623 + +--- + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2037 + +▸ **removeListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterAll"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2048 + +▸ **removeListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"beforeEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2059 + +▸ **removeListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"afterEach"` | +| `listener` | (`hook`: `Hook`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2070 + +▸ **removeListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------- | +| `event` | `"suite"` | +| `listener` | (`suite`: `Suite`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2081 + +▸ **removeListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `event` | `"test"` | +| `listener` | (`test`: `Test`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2092 + +▸ **removeListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------- | +| `event` | `"run"` | +| `listener` | () => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2103 + +▸ **removeListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"pre-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2114 + +▸ **removeListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------- | +| `event` | `"require"` | +| `listener` | (`module`: `any`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2125 + +▸ **removeListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `event` | `"post-require"` | +| `listener` | (`context`: `MochaGlobals`, `file`: `string`, `mocha`: `Mocha`) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2136 + +▸ **removeListener**(`event`, `listener`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------- | +| `event` | `string` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.removeListener + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2147 + +--- + +### retries + +▸ **retries**(): `number` + +Get number of times to retry a failed test. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#retries + +#### Returns + +`number` + +#### Inherited from + +Suite.retries + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1811 + +▸ **retries**(`n`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Set number of times to retry a failed test. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#retries + +#### Parameters + +| Name | Type | +| :--- | :------------------- | +| `n` | `string` \| `number` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.retries + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1818 + +--- + +### run + +▸ **run**(): `void` + +This will run the root suite if we happen to be running in delayed mode. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#run + +#### Returns + +`void` + +#### Inherited from + +Suite.run + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2024 + +--- + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `n` | `number` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.setMaxListeners + +#### Defined in + +node_modules/@types/node/globals.d.ts:624 + +--- + +### slow + +▸ **slow**(): `number` + +Get slow `ms`. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#slow + +#### Returns + +`number` + +#### Inherited from + +Suite.slow + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1825 + +▸ **slow**(`ms`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Set slow `ms` or short-hand such as "2s". + +**`see`** https://mochajs.org/api/Mocha.Suite.html#slow + +#### Parameters + +| Name | Type | +| :--- | :------------------- | +| `ms` | `string` \| `number` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.slow + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1832 + +--- + +### timeout + +▸ **timeout**(): `number` + +Get timeout `ms`. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#timeout + +#### Returns + +`number` + +#### Inherited from + +Suite.timeout + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1797 + +▸ **timeout**(`ms`): [`ISuite`](kui_shell_test.Common.ISuite.md) + +Set timeout `ms` or short-hand such as "2s". + +**`see`** https://mochajs.org/api/Mocha.Suite.html#timeout + +#### Parameters + +| Name | Type | +| :--- | :------------------- | +| `ms` | `string` \| `number` | + +#### Returns + +[`ISuite`](kui_shell_test.Common.ISuite.md) + +#### Inherited from + +Suite.timeout + +#### Defined in + +node_modules/@types/mocha/index.d.ts:1804 + +--- + +### titlePath + +▸ **titlePath**(): `string`[] + +Return the title path generated by recursively concatenating the parent's +title path. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#.Suite#titlePath + +#### Returns + +`string`[] + +#### Inherited from + +Suite.titlePath + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2002 + +--- + +### total + +▸ **total**(): `number` + +Return the total number of tests. + +**`see`** https://mochajs.org/api/Mocha.Suite.html#.Suite#total + +#### Returns + +`number` + +#### Inherited from + +Suite.total + +#### Defined in + +node_modules/@types/mocha/index.d.ts:2009 diff --git a/docs/api/interfaces/kui_shell_test.ReplExpect.AppAndCount.md b/docs/api/interfaces/kui_shell_test.ReplExpect.AppAndCount.md new file mode 100644 index 00000000000..1d5e2bcd901 --- /dev/null +++ b/docs/api/interfaces/kui_shell_test.ReplExpect.AppAndCount.md @@ -0,0 +1,43 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](../modules/kui_shell_test.md) / [ReplExpect](../modules/kui_shell_test.ReplExpect.md) / AppAndCount + +# Interface: AppAndCount + +[@kui-shell/test](../modules/kui_shell_test.md).[ReplExpect](../modules/kui_shell_test.ReplExpect.md).AppAndCount + +## Table of contents + +### Properties + +- [app](kui_shell_test.ReplExpect.AppAndCount.md#app) +- [count](kui_shell_test.ReplExpect.AppAndCount.md#count) +- [splitIndex](kui_shell_test.ReplExpect.AppAndCount.md#splitindex) + +## Properties + +### app + +• **app**: `Application` + +#### Defined in + +[packages/test/src/api/repl-expect.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L26) + +--- + +### count + +• **count**: `number` + +#### Defined in + +[packages/test/src/api/repl-expect.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L27) + +--- + +### splitIndex + +• `Optional` **splitIndex**: `number` + +#### Defined in + +[packages/test/src/api/repl-expect.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L28) diff --git a/docs/api/interfaces/kui_shell_test.Util.AppAndCount.md b/docs/api/interfaces/kui_shell_test.Util.AppAndCount.md new file mode 100644 index 00000000000..fa3268cedaa --- /dev/null +++ b/docs/api/interfaces/kui_shell_test.Util.AppAndCount.md @@ -0,0 +1,43 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](../modules/kui_shell_test.md) / [Util](../modules/kui_shell_test.Util.md) / AppAndCount + +# Interface: AppAndCount + +[@kui-shell/test](../modules/kui_shell_test.md).[Util](../modules/kui_shell_test.Util.md).AppAndCount + +## Table of contents + +### Properties + +- [app](kui_shell_test.Util.AppAndCount.md#app) +- [count](kui_shell_test.Util.AppAndCount.md#count) +- [splitIndex](kui_shell_test.Util.AppAndCount.md#splitindex) + +## Properties + +### app + +• **app**: `Application` + +#### Defined in + +[packages/test/src/api/util.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L30) + +--- + +### count + +• **count**: `number` + +#### Defined in + +[packages/test/src/api/util.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L31) + +--- + +### splitIndex + +• `Optional` **splitIndex**: `number` + +#### Defined in + +[packages/test/src/api/util.ts:32](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L32) diff --git a/docs/api/modules/kui_shell_core.Events.md b/docs/api/modules/kui_shell_core.Events.md new file mode 100644 index 00000000000..cf0696e5993 --- /dev/null +++ b/docs/api/modules/kui_shell_core.Events.md @@ -0,0 +1,194 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](kui_shell_core.md) / Events + +# Namespace: Events + +[@kui-shell/core](kui_shell_core.md).Events + +## Table of contents + +### Interfaces + +- [NewTabRequestEvent](../interfaces/kui_shell_core.Events.NewTabRequestEvent.md) + +### Type aliases + +- [SnapshotRequestEvent](kui_shell_core.Events.md#snapshotrequestevent) +- [StatusStripeChangeEvent](kui_shell_core.Events.md#statusstripechangeevent) +- [TabLayoutChangeEvent](kui_shell_core.Events.md#tablayoutchangeevent) + +### Variables + +- [eventBus](kui_shell_core.Events.md#eventbus) +- [eventChannelUnsafe](kui_shell_core.Events.md#eventchannelunsafe) + +### Functions + +- [unwireToStandardEvents](kui_shell_core.Events.md#unwiretostandardevents) +- [unwireToTabEvents](kui_shell_core.Events.md#unwiretotabevents) +- [wireToStandardEvents](kui_shell_core.Events.md#wiretostandardevents) +- [wireToTabEvents](kui_shell_core.Events.md#wiretotabevents) + +## Type aliases + +### SnapshotRequestEvent + +Ƭ **SnapshotRequestEvent**: `Object` + +#### Type declaration + +| Name | Type | +| :---------------------- | :--------------------------------------------------------------------------------------------- | +| `opts?` | `Object` | +| `opts.description?` | `string` | +| `opts.name?` | `string` | +| `opts.preferReExecute?` | `boolean` | +| `opts.shallow?` | `boolean` | +| `cb` | (`snapshot`: `Buffer`) => `void` | +| `filter?` | (`evt`: [`CommandStartEvent`](../interfaces/kui_shell_core.CommandStartEvent.md)) => `boolean` | + +#### Defined in + +[packages/core/src/core/events.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/events.ts#L39) + +--- + +### StatusStripeChangeEvent + +Ƭ **StatusStripeChangeEvent**: `Object` + +#### Type declaration + +| Name | Type | +| :--------- | :----------------------------------------------- | +| `message?` | `string` | +| `type` | `"default"` \| `"blue"` \| `"yellow"` \| `"red"` | + +#### Defined in + +[packages/core/src/core/events.ts:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/events.ts#L34) + +--- + +### TabLayoutChangeEvent + +Ƭ **TabLayoutChangeEvent**: `Object` + +#### Type declaration + +| Name | Type | +| :-------------------- | :-------- | +| `isSidecarNowHidden` | `boolean` | +| `isWidthConstrained?` | `boolean` | + +#### Defined in + +[packages/core/src/core/events.ts:50](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/events.ts#L50) + +## Variables + +### eventBus + +• **eventBus**: `EventBus` + +#### Defined in + +[packages/core/src/core/events.ts:396](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/events.ts#L396) + +--- + +### eventChannelUnsafe + +• **eventChannelUnsafe**: `EventEmitter` + +#### Defined in + +[packages/core/src/core/events.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/events.ts#L29) + +## Functions + +### unwireToStandardEvents + +▸ **unwireToStandardEvents**(`listener`): `void` + +Unhook + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------------------------------------------------------- | +| `listener` | (`tab?`: `number` \| [`Tab`](../interfaces/kui_shell_core.Tab.md)) => `void` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/events.ts:433](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/events.ts#L433) + +--- + +### unwireToTabEvents + +▸ **unwireToTabEvents**(`listener`): `void` + +Unhook + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------------------------------------------------------- | +| `listener` | (`tab?`: `number` \| [`Tab`](../interfaces/kui_shell_core.Tab.md)) => `void` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/events.ts:412](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/events.ts#L412) + +--- + +### wireToStandardEvents + +▸ **wireToStandardEvents**(`listener`): `void` + +Hook an event listener up to the family of standard user +interaction events. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------------------------------------------------------- | +| `listener` | (`tab?`: `number` \| [`Tab`](../interfaces/kui_shell_core.Tab.md)) => `void` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/events.ts:423](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/events.ts#L423) + +--- + +### wireToTabEvents + +▸ **wireToTabEvents**(`listener`): `void` + +Hook an event listener up to tab events. + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------------------------------------------------------- | +| `listener` | (`tab?`: `number` \| [`Tab`](../interfaces/kui_shell_core.Tab.md)) => `void` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/events.ts:402](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/events.ts#L402) diff --git a/docs/api/modules/kui_shell_core.md b/docs/api/modules/kui_shell_core.md new file mode 100644 index 00000000000..59ee3ad44c6 --- /dev/null +++ b/docs/api/modules/kui_shell_core.md @@ -0,0 +1,4243 @@ +[Kui API Documentation - v10.8.0](../README.md) / @kui-shell/core + +# Module: @kui-shell/core + +## Table of contents + +### Namespaces + +- [Events](kui_shell_core.Events.md) +- [pc](kui_shell_core.pc.md) + +### Enumerations + +- [CellShould](../enums/kui_shell_core.CellShould.md) +- [ExecType](../enums/kui_shell_core.ExecType.md) +- [Presentation](../enums/kui_shell_core.Presentation.md) +- [TableStyle](../enums/kui_shell_core.TableStyle.md) + +### Classes + +- [Cell](../classes/kui_shell_core.Cell.md) +- [DirectReplEval](../classes/kui_shell_core.DirectReplEval.md) +- [ElementMimic](../classes/kui_shell_core.ElementMimic.md) +- [HistoryModel](../classes/kui_shell_core.HistoryModel.md) +- [Icon](../classes/kui_shell_core.Icon.md) +- [Row](../classes/kui_shell_core.Row.md) +- [TabState](../classes/kui_shell_core.TabState.md) +- [Table](../classes/kui_shell_core.Table.md) +- [UsageError](../classes/kui_shell_core.UsageError.md) + +### Interfaces + +- [Abortable](../interfaces/kui_shell_core.Abortable.md) +- [Arguments](../interfaces/kui_shell_core.Arguments.md) +- [BadgeRegistration](../interfaces/kui_shell_core.BadgeRegistration.md) +- [BadgeSpec](../interfaces/kui_shell_core.BadgeSpec.md) +- [Block](../interfaces/kui_shell_core.Block.md) +- [Breadcrumb](../interfaces/kui_shell_core.Breadcrumb.md) +- [CodedError](../interfaces/kui_shell_core.CodedError.md) +- [CommandCompleteEvent](../interfaces/kui_shell_core.CommandCompleteEvent.md) +- [CommandLine](../interfaces/kui_shell_core.CommandLine.md) +- [CommandOptions](../interfaces/kui_shell_core.CommandOptions.md) +- [CommandStartEvent](../interfaces/kui_shell_core.CommandStartEvent.md) +- [DescriptionList](../interfaces/kui_shell_core.DescriptionList.md) +- [EditableSpec](../interfaces/kui_shell_core.EditableSpec.md) +- [Evaluator](../interfaces/kui_shell_core.Evaluator.md) +- [Event](../interfaces/kui_shell_core.Event.md) +- [ExecOptions](../interfaces/kui_shell_core.ExecOptions.md) +- [FlowControllable](../interfaces/kui_shell_core.FlowControllable.md) +- [HistoryLine](../interfaces/kui_shell_core.HistoryLine.md) +- [MetadataNamedResource](../interfaces/kui_shell_core.MetadataNamedResource.md) +- [ModeRegistration](../interfaces/kui_shell_core.ModeRegistration.md) +- [Notebook](../interfaces/kui_shell_core.Notebook.md) +- [ParsedOptions](../interfaces/kui_shell_core.ParsedOptions.md) +- [PreloadRegistrar](../interfaces/kui_shell_core.PreloadRegistrar.md) +- [REPL](../interfaces/kui_shell_core.REPL.md) +- [RadioTable](../interfaces/kui_shell_core.RadioTable.md) +- [RadioTableRow](../interfaces/kui_shell_core.RadioTableRow.md) +- [RawResponse](../interfaces/kui_shell_core.RawResponse.md) +- [Registrar](../interfaces/kui_shell_core.Registrar.md) +- [ReplEval](../interfaces/kui_shell_core.ReplEval.md) +- [Resizable](../interfaces/kui_shell_core.Resizable.md) +- [ResourceByReference](../interfaces/kui_shell_core.ResourceByReference.md) +- [ResourceWithMetadata](../interfaces/kui_shell_core.ResourceWithMetadata.md) +- [SaveError](../interfaces/kui_shell_core.SaveError.md) +- [ScalarContent](../interfaces/kui_shell_core.ScalarContent.md) +- [Selectable](../interfaces/kui_shell_core.Selectable.md) +- [SourceRef](../interfaces/kui_shell_core.SourceRef.md) +- [Split](../interfaces/kui_shell_core.Split.md) +- [StatusModel](../interfaces/kui_shell_core.StatusModel.md) +- [StatusModelItem](../interfaces/kui_shell_core.StatusModelItem.md) +- [StatusModelSection](../interfaces/kui_shell_core.StatusModelSection.md) +- [StatusModelTile](../interfaces/kui_shell_core.StatusModelTile.md) +- [StatusModelTileAction](../interfaces/kui_shell_core.StatusModelTileAction.md) +- [Tab](../interfaces/kui_shell_core.Tab.md) +- [TabCompletionSpec](../interfaces/kui_shell_core.TabCompletionSpec.md) +- [ThemeProperties](../interfaces/kui_shell_core.ThemeProperties.md) +- [ToolbarAlert](../interfaces/kui_shell_core.ToolbarAlert.md) +- [ToolbarText](../interfaces/kui_shell_core.ToolbarText.md) +- [UsageModel](../interfaces/kui_shell_core.UsageModel.md) +- [UsageRow](../interfaces/kui_shell_core.UsageRow.md) +- [WatchPusher](../interfaces/kui_shell_core.WatchPusher.md) +- [Watchable](../interfaces/kui_shell_core.Watchable.md) +- [Watcher](../interfaces/kui_shell_core.Watcher.md) +- [WithSourceReferences](../interfaces/kui_shell_core.WithSourceReferences.md) +- [XtermResponse](../interfaces/kui_shell_core.XtermResponse.md) +- [XtermResponseCell](../interfaces/kui_shell_core.XtermResponseCell.md) + +### Type aliases + +- [Badge](kui_shell_core.md#badge) +- [Button](kui_shell_core.md#button) +- [CapabilityRegistration](kui_shell_core.md#capabilityregistration) +- [CommandHandler](kui_shell_core.md#commandhandler) +- [CommandStringContent](kui_shell_core.md#commandstringcontent) +- [CommentaryResponse](kui_shell_core.md#commentaryresponse) +- [CompletionResponse](kui_shell_core.md#completionresponse) +- [Content](kui_shell_core.md#content) +- [Editable](kui_shell_core.md#editable) +- [ExecOptionsWithUUID](kui_shell_core.md#execoptionswithuuid) +- [FunctionThatProducesContent](kui_shell_core.md#functionthatproducescontent) +- [Job](kui_shell_core.md#job) +- [KResponse](kui_shell_core.md#kresponse) +- [Link](kui_shell_core.md#link) +- [Menu](kui_shell_core.md#menu) +- [MixedResponse](kui_shell_core.md#mixedresponse) +- [Mode](kui_shell_core.md#mode) +- [ModeDeclaration](kui_shell_core.md#modedeclaration) +- [ModeFilter](kui_shell_core.md#modefilter) +- [MultiModalMode](kui_shell_core.md#multimodalmode) +- [MultiModalResponse](kui_shell_core.md#multimodalresponse) +- [NavResponse](kui_shell_core.md#navresponse) +- [NewSplitRequest](kui_shell_core.md#newsplitrequest) +- [PluginRegistration](kui_shell_core.md#pluginregistration) +- [PreloadRegistration](kui_shell_core.md#preloadregistration) +- [PrettyUsageModel](kui_shell_core.md#prettyusagemodel) +- [RadioTableCell](kui_shell_core.md#radiotablecell) +- [ReactProvider](kui_shell_core.md#reactprovider) +- [ReactResponse](kui_shell_core.md#reactresponse) +- [ResourceByReferenceWithContent](kui_shell_core.md#resourcebyreferencewithcontent) +- [ResourceWithMetadataWithContent](kui_shell_core.md#resourcewithmetadatawithcontent) +- [ScalarResource](kui_shell_core.md#scalarresource) +- [ScalarResponse](kui_shell_core.md#scalarresponse) +- [SnapshottedEvent](kui_shell_core.md#snapshottedevent) +- [StatusModelStatus](kui_shell_core.md#statusmodelstatus) +- [Stream](kui_shell_core.md#stream) +- [Streamable](kui_shell_core.md#streamable) +- [StringContent](kui_shell_core.md#stringcontent) +- [StringDiffContent](kui_shell_core.md#stringdiffcontent) +- [SupportedStringContent](kui_shell_core.md#supportedstringcontent) +- [Suspendable](kui_shell_core.md#suspendable) +- [TabLayoutModificationResponse](kui_shell_core.md#tablayoutmodificationresponse) +- [Theme](kui_shell_core.md#theme) +- [ToolbarProps](kui_shell_core.md#toolbarprops) +- [ViewTransformer](kui_shell_core.md#viewtransformer) + +### Properties + +- [Store](kui_shell_core.md#store) +- [SymbolTable](kui_shell_core.md#symboltable) +- [boot](kui_shell_core.md#boot) +- [encodeComponent](kui_shell_core.md#encodecomponent) +- [i18n](kui_shell_core.md#i18n) + +### Variables + +- [KeyCodes](kui_shell_core.md#keycodes) +- [badgeRegistrar](kui_shell_core.md#badgeregistrar) + +### Functions + +- [History](kui_shell_core.md#history) +- [\_split](kui_shell_core.md#_split) +- [addRelevantModes](kui_shell_core.md#addrelevantmodes) +- [aggregateStatusModelStatus](kui_shell_core.md#aggregatestatusmodelstatus) +- [assertHasProxy](kui_shell_core.md#asserthasproxy) +- [assertInSandbox](kui_shell_core.md#assertinsandbox) +- [assertLocalAccess](kui_shell_core.md#assertlocalaccess) +- [bootIntoSandbox](kui_shell_core.md#bootintosandbox) +- [cellShouldHaveBadge](kui_shell_core.md#cellshouldhavebadge) +- [commandsOfferedByPlugin](kui_shell_core.md#commandsofferedbyplugin) +- [cwd](kui_shell_core.md#cwd) +- [disableInputQueueing](kui_shell_core.md#disableinputqueueing) +- [doCancel](kui_shell_core.md#docancel) +- [doEval](kui_shell_core.md#doeval) +- [empty](kui_shell_core.md#empty) +- [executeSequentially](kui_shell_core.md#executesequentially) +- [expandHomeDir](kui_shell_core.md#expandhomedir) +- [fallbackCWD](kui_shell_core.md#fallbackcwd) +- [findCompletions](kui_shell_core.md#findcompletions) +- [findFile](kui_shell_core.md#findfile) +- [findFileWithViewer](kui_shell_core.md#findfilewithviewer) +- [findThemeByName](kui_shell_core.md#findthemebyname) +- [flatten](kui_shell_core.md#flatten) +- [getAuthValue](kui_shell_core.md#getauthvalue) +- [getCurrentTab](kui_shell_core.md#getcurrenttab) +- [getDefaultTheme](kui_shell_core.md#getdefaulttheme) +- [getOrSetPreference](kui_shell_core.md#getorsetpreference) +- [getPersistedThemeChoice](kui_shell_core.md#getpersistedthemechoice) +- [getPreference](kui_shell_core.md#getpreference) +- [getPrimaryTabId](kui_shell_core.md#getprimarytabid) +- [getTab](kui_shell_core.md#gettab) +- [getTabId](kui_shell_core.md#gettabid) +- [getValidCredentials](kui_shell_core.md#getvalidcredentials) +- [hasContent](kui_shell_core.md#hascontent) +- [hasDisplayName](kui_shell_core.md#hasdisplayname) +- [hasProxy](kui_shell_core.md#hasproxy) +- [hasSourceReferences](kui_shell_core.md#hassourcereferences) +- [hideReplayOutput](kui_shell_core.md#hidereplayoutput) +- [i18nFromMap](kui_shell_core.md#i18nfrommap) +- [inBrowser](kui_shell_core.md#inbrowser) +- [inElectron](kui_shell_core.md#inelectron) +- [inProxy](kui_shell_core.md#inproxy) +- [inSandbox](kui_shell_core.md#insandbox) +- [initializeSession](kui_shell_core.md#initializesession) +- [internalBeCarefulExec](kui_shell_core.md#internalbecarefulexec) +- [internalBeCarefulPExec](kui_shell_core.md#internalbecarefulpexec) +- [is404](kui_shell_core.md#is404) +- [is404or409](kui_shell_core.md#is404or409) +- [is409](kui_shell_core.md#is409) +- [isAbortableResponse](kui_shell_core.md#isabortableresponse) +- [isButton](kui_shell_core.md#isbutton) +- [isCodedError](kui_shell_core.md#iscodederror) +- [isCommandHandlerWithEvents](kui_shell_core.md#iscommandhandlerwithevents) +- [isCommandStringContent](kui_shell_core.md#iscommandstringcontent) +- [isCommentaryResponse](kui_shell_core.md#iscommentaryresponse) +- [isCommentarySectionBreak](kui_shell_core.md#iscommentarysectionbreak) +- [isCursorMovement](kui_shell_core.md#iscursormovement) +- [isDescriptionList](kui_shell_core.md#isdescriptionlist) +- [isExecutableClient](kui_shell_core.md#isexecutableclient) +- [isFunctionContent](kui_shell_core.md#isfunctioncontent) +- [isHTML](kui_shell_core.md#ishtml) +- [isHeadless](kui_shell_core.md#isheadless) +- [isLink](kui_shell_core.md#islink) +- [isLinkWithCommand](kui_shell_core.md#islinkwithcommand) +- [isLinkWithHref](kui_shell_core.md#islinkwithhref) +- [isMarkdownResponse](kui_shell_core.md#ismarkdownresponse) +- [isMessageWithCode](kui_shell_core.md#ismessagewithcode) +- [isMessageWithUsageModel](kui_shell_core.md#ismessagewithusagemodel) +- [isMixedResponse](kui_shell_core.md#ismixedresponse) +- [isMultiModalResponse](kui_shell_core.md#ismultimodalresponse) +- [isNavResponse](kui_shell_core.md#isnavresponse) +- [isNewSplitRequest](kui_shell_core.md#isnewsplitrequest) +- [isNotebook](kui_shell_core.md#isnotebook) +- [isOfflineClient](kui_shell_core.md#isofflineclient) +- [isPopup](kui_shell_core.md#ispopup) +- [isPromise](kui_shell_core.md#ispromise) +- [isRadioTable](kui_shell_core.md#isradiotable) +- [isRandomErrorResponse1](kui_shell_core.md#israndomerrorresponse1) +- [isRandomErrorResponse2](kui_shell_core.md#israndomerrorresponse2) +- [isReactProvider](kui_shell_core.md#isreactprovider) +- [isReactResponse](kui_shell_core.md#isreactresponse) +- [isReadOnlyClient](kui_shell_core.md#isreadonlyclient) +- [isResizable](kui_shell_core.md#isresizable) +- [isResourceByReference](kui_shell_core.md#isresourcebyreference) +- [isResourceWithMetadata](kui_shell_core.md#isresourcewithmetadata) +- [isScalarContent](kui_shell_core.md#isscalarcontent) +- [isScalarResponse](kui_shell_core.md#isscalarresponse) +- [isSpecialDirectory](kui_shell_core.md#isspecialdirectory) +- [isStatusModel](kui_shell_core.md#isstatusmodel) +- [isStringDiffContent](kui_shell_core.md#isstringdiffcontent) +- [isStringResponse](kui_shell_core.md#isstringresponse) +- [isStringWithOptionalContentType](kui_shell_core.md#isstringwithoptionalcontenttype) +- [isSupportedContentType](kui_shell_core.md#issupportedcontenttype) +- [isSupportedToolbarTextType](kui_shell_core.md#issupportedtoolbartexttype) +- [isSuspendable](kui_shell_core.md#issuspendable) +- [isTabLayoutModificationResponse](kui_shell_core.md#istablayoutmodificationresponse) +- [isTable](kui_shell_core.md#istable) +- [isTableWithCount](kui_shell_core.md#istablewithcount) +- [isTableWithTimestamp](kui_shell_core.md#istablewithtimestamp) +- [isTopLevelTab](kui_shell_core.md#istopleveltab) +- [isUsageError](kui_shell_core.md#isusageerror) +- [isViewButton](kui_shell_core.md#isviewbutton) +- [isWatchable](kui_shell_core.md#iswatchable) +- [isXtermErrorResponse](kui_shell_core.md#isxtermerrorresponse) +- [isXtermResponse](kui_shell_core.md#isxtermresponse) +- [maybeKuiLink](kui_shell_core.md#maybekuilink) +- [offQuit](kui_shell_core.md#offquit) +- [onQuit](kui_shell_core.md#onquit) +- [pexecInCurrentTab](kui_shell_core.md#pexecincurrenttab) +- [pluginUserHome](kui_shell_core.md#pluginuserhome) +- [prettyPrintBytes](kui_shell_core.md#prettyprintbytes) +- [prettyPrintTime](kui_shell_core.md#prettyprinttime) +- [promiseEach](kui_shell_core.md#promiseeach) +- [radioTableAddHint](kui_shell_core.md#radiotableaddhint) +- [radioTableCellToString](kui_shell_core.md#radiotablecelltostring) +- [radioTableHintsAsCss](kui_shell_core.md#radiotablehintsascss) +- [registerBadge](kui_shell_core.md#registerbadge) +- [registerMode](kui_shell_core.md#registermode) +- [registerModeWhen](kui_shell_core.md#registermodewhen) +- [registerTabCompletionEnumerator](kui_shell_core.md#registertabcompletionenumerator) +- [registerTabState](kui_shell_core.md#registertabstate) +- [renderUsage](kui_shell_core.md#renderusage) +- [resetToDefaultTheme](kui_shell_core.md#resettodefaulttheme) +- [sameRow](kui_shell_core.md#samerow) +- [sameTab](kui_shell_core.md#sametab) +- [setEvaluatorImpl](kui_shell_core.md#setevaluatorimpl) +- [setHasAuth](kui_shell_core.md#sethasauth) +- [setPreference](kui_shell_core.md#setpreference) +- [split](kui_shell_core.md#split) +- [splitFor](kui_shell_core.md#splitfor) +- [splitIntoPipeStages](kui_shell_core.md#splitintopipestages) +- [switchToTheme](kui_shell_core.md#switchtotheme) +- [teeToFile](kui_shell_core.md#teetofile) +- [tellMain](kui_shell_core.md#tellmain) +- [typeahead](kui_shell_core.md#typeahead) +- [uiThemes](kui_shell_core.md#uithemes) +- [unparse](kui_shell_core.md#unparse) +- [userDataDir](kui_shell_core.md#userdatadir) +- [withLanguage](kui_shell_core.md#withlanguage) + +## Type aliases + +### Badge + +Ƭ **Badge**: `string` \| [`BadgeSpec`](../interfaces/kui_shell_core.BadgeSpec.md) \| `Element` + +#### Defined in + +[packages/core/src/webapp/views/registrar/badges.ts:35](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/badges.ts#L35) + +--- + +### Button + +Ƭ **Button**<`T`\>: `DrilldownButton`<`T`\> \| `ViewButton`<`T`\> + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------- | +| `T` | [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md) | + +#### Defined in + +[packages/core/src/models/mmr/types.ts:142](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/types.ts#L142) + +--- + +### CapabilityRegistration + +Ƭ **CapabilityRegistration**: (`registrar`: [`PreloadRegistrar`](../interfaces/kui_shell_core.PreloadRegistrar.md)) => `void` \| `Promise`<`void`\> + +#### Type declaration + +▸ (`registrar`): `void` \| `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :---------- | :--------------------------------------------------------------------- | +| `registrar` | [`PreloadRegistrar`](../interfaces/kui_shell_core.PreloadRegistrar.md) | + +##### Returns + +`void` \| `Promise`<`void`\> + +#### Defined in + +[packages/core/src/models/plugin.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/plugin.ts#L43) + +--- + +### CommandHandler + +Ƭ **CommandHandler**<`T`, `O`\>: (`args`: [`Arguments`](../interfaces/kui_shell_core.Arguments.md)<`O`\>) => `T` \| `Promise`<`T`\> + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------- | +| `T` | extends [`KResponse`](kui_shell_core.md#kresponse) | +| `O` | extends [`ParsedOptions`](../interfaces/kui_shell_core.ParsedOptions.md) | + +#### Type declaration + +▸ (`args`): `T` \| `Promise`<`T`\> + +base command handler + +##### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------- | +| `args` | [`Arguments`](../interfaces/kui_shell_core.Arguments.md)<`O`\> | + +##### Returns + +`T` \| `Promise`<`T`\> + +#### Defined in + +[packages/core/src/models/command.ts:215](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L215) + +--- + +### CommandStringContent + +Ƭ **CommandStringContent**: `WithOptionalContentType`<[`SupportedStringContent`](kui_shell_core.md#supportedstringcontent)\> & { `contentFrom`: `string` } + +`Content` as `CommandStringContent` will be executed via a +REPL.qexec; the command is assumed to return either +`ScalarRersource` or `ScalarContent`. + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:173](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L173) + +--- + +### CommentaryResponse + +Ƭ **CommentaryResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :--------------- | :--------------------------------------------- | +| `apiVersion` | `"kui-shell/v1"` | +| `kind` | `"CommentaryResponse"` | +| `props` | `Object` | +| `props.baseUrl?` | `string` | +| `props.children` | `string` | +| `props.repl?` | [`REPL`](../interfaces/kui_shell_core.REPL.md) | +| `props.title?` | `string` | + +#### Defined in + +[packages/core/src/models/CommentaryResponse.ts:20](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CommentaryResponse.ts#L20) + +--- + +### CompletionResponse + +Ƭ **CompletionResponse**: `string` \| { `addSpace?`: `boolean` ; `completion`: `string` ; `docs?`: `string` ; `label?`: `string` } + +#### Defined in + +[packages/core/src/repl/tab-completion.ts:38](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/tab-completion.ts#L38) + +--- + +### Content + +Ƭ **Content**<`T`\>: [`ScalarContent`](../interfaces/kui_shell_core.ScalarContent.md) \| [`StringContent`](kui_shell_core.md#stringcontent) \| [`StringDiffContent`](kui_shell_core.md#stringdiffcontent) \| `FunctionContent`<`T`\> \| [`CommandStringContent`](kui_shell_core.md#commandstringcontent) \| [`ReactProvider`](kui_shell_core.md#reactprovider) + +The classes of supported `Content` are: + +- `ScalarContent`: such as pre-formatted HTML, or or `Table` model +- `StringContent`: a string with an optional `contentType` +- `FunctionContent`: a function that takes a `T` and produces `ScalarContent` +- `CommandStringContent`: a string to be executed as a Kui command, and producing `ScalarContent` + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `T` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)[`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md) | + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:196](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L196) + +--- + +### Editable + +Ƭ **Editable**: `Object` + +The Resource trait + +#### Type declaration + +| Name | Type | +| :----- | :------------------------------------------------------------- | +| `spec` | [`EditableSpec`](../interfaces/kui_shell_core.EditableSpec.md) | + +#### Defined in + +[packages/core/src/models/editable.ts:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/editable.ts#L46) + +--- + +### ExecOptionsWithUUID + +Ƭ **ExecOptionsWithUUID**: `Exclude`<[`ExecOptions`](../interfaces/kui_shell_core.ExecOptions.md), `"execUUID"`\> & `Required`<`Pick`<[`ExecOptions`](../interfaces/kui_shell_core.ExecOptions.md), `"execUUID"`\>\> + +Transform the `execUUID` field of `ExecOptions` to be required. + +#### Defined in + +[packages/core/src/models/execOptions.ts:109](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L109) + +--- + +### FunctionThatProducesContent + +Ƭ **FunctionThatProducesContent**<`T`\>: (`tab`: [`Tab`](../interfaces/kui_shell_core.Tab.md), `entity`: `T`, `args`: { `argsForMode?`: [`Arguments`](../interfaces/kui_shell_core.Arguments.md) ; `argvNoOptions`: `string`[] ; `parsedOptions`: [`ParsedOptions`](../interfaces/kui_shell_core.ParsedOptions.md) }) => [`ReactProvider`](kui_shell_core.md#reactprovider) \| [`ScalarResource`](kui_shell_core.md#scalarresource) \| [`ScalarContent`](../interfaces/kui_shell_core.ScalarContent.md) \| `Promise`<[`ScalarResource`](kui_shell_core.md#scalarresource) \| [`ScalarContent`](../interfaces/kui_shell_core.ScalarContent.md) \| [`ReactProvider`](kui_shell_core.md#reactprovider)\> \| [`CommandStringContent`](kui_shell_core.md#commandstringcontent) + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `T` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)[`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md) | + +#### Type declaration + +▸ (`tab`, `entity`, `args`): [`ReactProvider`](kui_shell_core.md#reactprovider) \| [`ScalarResource`](kui_shell_core.md#scalarresource) \| [`ScalarContent`](../interfaces/kui_shell_core.ScalarContent.md) \| `Promise`<[`ScalarResource`](kui_shell_core.md#scalarresource) \| [`ScalarContent`](../interfaces/kui_shell_core.ScalarContent.md) \| [`ReactProvider`](kui_shell_core.md#reactprovider)\> \| [`CommandStringContent`](kui_shell_core.md#commandstringcontent) + +`Content` as `FunctionThatProducesContent` is a function that +takes a `T` and produces either a resource or some { content, +contentType } wrapper. + +##### Parameters + +| Name | Type | +| :------------------- | :--------------------------------------------------------------- | +| `tab` | [`Tab`](../interfaces/kui_shell_core.Tab.md) | +| `entity` | `T` | +| `args` | `Object` | +| `args.argsForMode?` | [`Arguments`](../interfaces/kui_shell_core.Arguments.md) | +| `args.argvNoOptions` | `string`[] | +| `args.parsedOptions` | [`ParsedOptions`](../interfaces/kui_shell_core.ParsedOptions.md) | + +##### Returns + +[`ReactProvider`](kui_shell_core.md#reactprovider) \| [`ScalarResource`](kui_shell_core.md#scalarresource) \| [`ScalarContent`](../interfaces/kui_shell_core.ScalarContent.md) \| `Promise`<[`ScalarResource`](kui_shell_core.md#scalarresource) \| [`ScalarContent`](../interfaces/kui_shell_core.ScalarContent.md) \| [`ReactProvider`](kui_shell_core.md#reactprovider)\> \| [`CommandStringContent`](kui_shell_core.md#commandstringcontent) + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:141](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L141) + +--- + +### Job + +Ƭ **Job**: [`Abortable`](../interfaces/kui_shell_core.Abortable.md) & [`FlowControllable`](../interfaces/kui_shell_core.FlowControllable.md) & `Partial`<[`Resizable`](../interfaces/kui_shell_core.Resizable.md)\> + +#### Defined in + +[packages/core/src/core/jobs/job.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/job.ts#L44) + +--- + +### KResponse + +Ƭ **KResponse**<`Content`\>: `Entity`<`Content`\> + +A command `KResponse` can be any supported `Entity` type + +#### Type parameters + +| Name | Type | +| :-------- | :------------------- | +| `Content` | extends ` any``any ` | + +#### Defined in + +[packages/core/src/models/command.ts:32](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L32) + +--- + +### Link + +Ƭ **Link**: `Label` & `Command` \| `Href` + +#### Defined in + +[packages/core/src/models/NavResponse.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/NavResponse.ts#L44) + +--- + +### Menu + +Ƭ **Menu**: `Label` & `MenuItems` + +#### Defined in + +[packages/core/src/models/NavResponse.ts:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/NavResponse.ts#L37) + +--- + +### MixedResponse + +Ƭ **MixedResponse**: `MixedResponsePart`[] + +#### Defined in + +[packages/core/src/models/entity.ts:159](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L159) + +--- + +### Mode + +Ƭ **Mode**<`T`\>: [`MultiModalMode`](kui_shell_core.md#multimodalmode)<`T`\> \| [`Button`](kui_shell_core.md#button)<`T`\> + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------- | +| `T` | [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md) | + +#### Defined in + +[packages/core/src/models/mmr/types.ts:75](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/types.ts#L75) + +--- + +### ModeDeclaration + +Ƭ **ModeDeclaration**<`Resource`\>: [`Mode`](kui_shell_core.md#mode) + +#### Type parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md) | + +#### Defined in + +[packages/core/src/webapp/views/registrar/modes.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/modes.ts#L29) + +--- + +### ModeFilter + +Ƭ **ModeFilter**<`Resource`\>: (`resource`: `Resource`) => `boolean` + +#### Type parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md) | + +#### Type declaration + +▸ (`resource`): `boolean` + +##### Parameters + +| Name | Type | +| :--------- | :--------- | +| `resource` | `Resource` | + +##### Returns + +`boolean` + +#### Defined in + +[packages/core/src/webapp/views/registrar/modes.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/modes.ts#L27) + +--- + +### MultiModalMode + +Ƭ **MultiModalMode**<`T`\>: `Label` & `ModeTraits` & `VisibilityTraits` & [`Content`](kui_shell_core.md#content)<`T`\> + +A `Mode` is a `Label` plus some `Content` and `ModeTraits` + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------- | +| `T` | [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md) | + +#### Defined in + +[packages/core/src/models/mmr/types.ts:81](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/types.ts#L81) + +--- + +### MultiModalResponse + +Ƭ **MultiModalResponse**<`Resource`\>: `Resource` & `View`<`Resource`\> + +A `MultiModalResponse` has all the fields of a class of `Resource` +plus a way to `View` those resources. + +#### Type parameters + +| Name | Type | +| :--------- | :----------------------------------------------------------------------------- | +| `Resource` | [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md) | + +#### Defined in + +[packages/core/src/models/mmr/types.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/types.ts#L31) + +--- + +### NavResponse + +Ƭ **NavResponse**: `Object` + +A `NavResponse` is a collection of `MultiModalResponse` with menu navigation + +#### Type declaration + +| Name | Type | +| :------------- | :----------------------------------------------------------- | +| `apiVersion` | `"kui-shell/v1"` | +| `breadcrumbs?` | [`Breadcrumb`](../interfaces/kui_shell_core.Breadcrumb.md)[] | +| `kind` | `"NavResponse"` | +| `links?` | [`Link`](kui_shell_core.md#link)[] | +| `menus` | [`Menu`](kui_shell_core.md#menu)[] | + +#### Defined in + +[packages/core/src/models/NavResponse.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/NavResponse.ts#L29) + +--- + +### NewSplitRequest + +Ƭ **NewSplitRequest**: `Object` + +#### Type declaration + +| Name | Type | +| :----------------------- | :------------------------------------------------ | +| `modification` | `"NewSplit"` | +| `options?` | `Object` | +| `options.cmdline?` | `string` | +| `options.if?` | `string` | +| `options.ifnot?` | `string` | +| `options.index?` | `number` | +| `options.inverseColors?` | `boolean` | +| `options.position?` | `"default"` \| `"left-strip"` \| `"bottom-strip"` | +| `options.swap?` | `Object` | +| `options.swap.a` | `number` | +| `options.swap.b` | `number` | + +#### Defined in + +[packages/core/src/models/TabLayoutModificationResponse.ts:32](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/TabLayoutModificationResponse.ts#L32) + +--- + +### PluginRegistration + +Ƭ **PluginRegistration**: (`commandTree`: [`Registrar`](../interfaces/kui_shell_core.Registrar.md), `options?`: { `usage`: `PrescanUsage` }) => `KuiPlugin` + +#### Type declaration + +▸ (`commandTree`, `options?`): `KuiPlugin` + +##### Parameters + +| Name | Type | +| :-------------- | :------------------------------------------------------- | +| `commandTree` | [`Registrar`](../interfaces/kui_shell_core.Registrar.md) | +| `options?` | `Object` | +| `options.usage` | `PrescanUsage` | + +##### Returns + +`KuiPlugin` + +#### Defined in + +[packages/core/src/models/plugin.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/plugin.ts#L26) + +--- + +### PreloadRegistration + +Ƭ **PreloadRegistration**: (`registrar`: [`PreloadRegistrar`](../interfaces/kui_shell_core.PreloadRegistrar.md)) => `Promise`<`void` \| `void`[]\> + +#### Type declaration + +▸ (`registrar`): `Promise`<`void` \| `void`[]\> + +##### Parameters + +| Name | Type | +| :---------- | :--------------------------------------------------------------------- | +| `registrar` | [`PreloadRegistrar`](../interfaces/kui_shell_core.PreloadRegistrar.md) | + +##### Returns + +`Promise`<`void` \| `void`[]\> + +#### Defined in + +[packages/core/src/models/plugin.ts:41](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/plugin.ts#L41) + +--- + +### PrettyUsageModel + +Ƭ **PrettyUsageModel**: `Object` + +#### Type declaration + +| Name | Type | +| :---------- | :---------- | +| `examples?` | `Example`[] | +| `intro?` | `string` | +| `options?` | `Option`[] | +| `related?` | `Related`[] | +| `title` | `Title` | +| `usages` | `Usage`[] | + +#### Defined in + +[packages/core/src/core/usage/types.ts:36](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage/types.ts#L36) + +--- + +### RadioTableCell + +Ƭ **RadioTableCell**: `string` \| { `hints?`: [`CellShould`](../enums/kui_shell_core.CellShould.md) \| [`CellShould`](../enums/kui_shell_core.CellShould.md)[] ; `key?`: `string` ; `title?`: `string` ; `value`: `string` } + +#### Defined in + +[packages/core/src/models/RadioTable.ts:87](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L87) + +--- + +### ReactProvider + +Ƭ **ReactProvider**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :--------------------------------------------------------------------------------------------------------------------------------- | +| `react` | (`props`: [`ToolbarProps`](kui_shell_core.md#toolbarprops)) => `ReactElement`<`any`, `string` \| `JSXElementConstructor`<`any`\>\> | + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:42](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L42) + +--- + +### ReactResponse + +Ƭ **ReactResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :---------- | +| `react` | `ReactNode` | + +#### Defined in + +[packages/core/src/models/entity.ts:140](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L140) + +--- + +### ResourceByReferenceWithContent + +Ƭ **ResourceByReferenceWithContent**<`T`\>: [`ResourceByReference`](../interfaces/kui_shell_core.ResourceByReference.md)<`T`\> + +#### Type parameters + +| Name | Type | +| :--- | :------------------- | +| `T` | extends ` any``any ` | + +#### Defined in + +[packages/core/src/models/entity.ts:112](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L112) + +--- + +### ResourceWithMetadataWithContent + +Ƭ **ResourceWithMetadataWithContent**<`T`\>: [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`T`\> + +#### Type parameters + +| Name | Type | +| :--- | :------------------- | +| `T` | extends ` any``any ` | + +#### Defined in + +[packages/core/src/models/entity.ts:87](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L87) + +--- + +### ScalarResource + +Ƭ **ScalarResource**: `string` \| `HTMLElement` \| [`Table`](../classes/kui_shell_core.Table.md) \| [`DescriptionList`](../interfaces/kui_shell_core.DescriptionList.md) + +A `ScalarResource` is Any kind of resource that is directly +represented, as opposed to being implicitly represented by a +function call. + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L34) + +--- + +### ScalarResponse + +Ƭ **ScalarResponse**<`RowType`\>: `SimpleEntity` \| [`Table`](../classes/kui_shell_core.Table.md)<`RowType`\> & `Partial`<[`WithSourceReferences`](../interfaces/kui_shell_core.WithSourceReferences.md)\> \| [`MixedResponse`](kui_shell_core.md#mixedresponse) \| [`CommentaryResponse`](kui_shell_core.md#commentaryresponse) \| [`TabLayoutModificationResponse`](kui_shell_core.md#tablayoutmodificationresponse) \| [`XtermResponse`](../interfaces/kui_shell_core.XtermResponse.md) \| [`StatusModel`](../interfaces/kui_shell_core.StatusModel.md) \| `RandomErrorResponse1` \| `RandomErrorResponse2` + +This type covers all responses with no complex internal structure +that views may wish to interpret into fancier views. + +#### Type parameters + +| Name | Type | +| :-------- | :----------------------------------------------------------------------------------------- | +| `RowType` | extends [`Row`](../classes/kui_shell_core.Row.md)[`Row`](../classes/kui_shell_core.Row.md) | + +#### Defined in + +[packages/core/src/models/entity.ts:208](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L208) + +--- + +### SnapshottedEvent + +Ƭ **SnapshottedEvent**<`E`\>: `Omit`<`E`, `"tab"`\> & { `tab`: `E`[`"tab"`][``"uuid"``] } + +In order to snapshot an event, we'll need to remember just the tab uuid + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `E` | extends [`CommandStartEvent`](../interfaces/kui_shell_core.CommandStartEvent.md) \| [`CommandCompleteEvent`](../interfaces/kui_shell_core.CommandCompleteEvent.md) | + +#### Defined in + +[packages/core/src/repl/events.ts:68](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L68) + +--- + +### StatusModelStatus + +Ƭ **StatusModelStatus**: `"success"` \| `"in-progress"` \| `"warning"` \| `"error"` \| `"unknown"` + +#### Defined in + +[packages/core/src/models/StatusModel.ts:19](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L19) + +--- + +### Stream + +Ƭ **Stream**: (`response`: [`Streamable`](kui_shell_core.md#streamable)) => `void` \| `Promise`<`void`\> + +#### Type declaration + +▸ (`response`): `void` \| `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :--------- | :------------------------------------------- | +| `response` | [`Streamable`](kui_shell_core.md#streamable) | + +##### Returns + +`void` \| `Promise`<`void`\> + +#### Defined in + +[packages/core/src/models/streamable.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/streamable.ts#L22) + +--- + +### Streamable + +Ƭ **Streamable**: [`ScalarResponse`](kui_shell_core.md#scalarresponse) + +#### Defined in + +[packages/core/src/models/streamable.ts:19](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/streamable.ts#L19) + +--- + +### StringContent + +Ƭ **StringContent**<`ContentType`\>: [`ScalarContent`](../interfaces/kui_shell_core.ScalarContent.md)<`string`\> & `WithOptionalContentType`<`ContentType`\> & `Partial`<[`Editable`](kui_shell_core.md#editable)\> + +Special case of `ScalarContent` for strings; string content may +optionally provide a `contentType`. + +#### Type parameters + +| Name | Type | +| :------------ | :------------------------------------------------------------------- | +| `ContentType` | [`SupportedStringContent`](kui_shell_core.md#supportedstringcontent) | + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:95](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L95) + +--- + +### StringDiffContent + +Ƭ **StringDiffContent**<`ContentType`\>: `Object` + +Compare 2 `StringContent` + +#### Type parameters + +| Name | Type | +| :------------ | :------------------------------------------------------------------- | +| `ContentType` | [`SupportedStringContent`](kui_shell_core.md#supportedstringcontent) | + +#### Type declaration + +| Name | Type | +| :------------ | :------------ | +| `content` | `Object` | +| `content.a` | `string` | +| `content.b` | `string` | +| `contentType` | `ContentType` | + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:114](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L114) + +--- + +### SupportedStringContent + +Ƭ **SupportedStringContent**: `"yaml"` \| `"text/markdown"` \| `"text/html"` \| `"json"` \| `"shell"` \| `"text/plain"` + +Supported String content types + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:69](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L69) + +--- + +### Suspendable + +Ƭ **Suspendable**: `Omit`<[`FlowControllable`](../interfaces/kui_shell_core.FlowControllable.md), `"write"`\> + +#### Defined in + +[packages/core/src/core/jobs/job.ts:35](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/job.ts#L35) + +--- + +### TabLayoutModificationResponse + +Ƭ **TabLayoutModificationResponse**<`Request`\>: `Object` + +If your controller wants to manipulate the tab layout, this is your +response type! + +#### Type parameters + +| Name | Type | +| :-------- | :--------------------------------------------------- | +| `Request` | extends ` ModificationRequest``ModificationRequest ` | + +#### Type declaration + +| Name | Type | +| :----------- | :--------------------------------------- | +| `apiVersion` | `"kui-shell/v1"` | +| `kind` | `"TabLayoutModificationResponse"` | +| `spec` | `Request` & { `ok`: `MarkdownResponse` } | + +#### Defined in + +[packages/core/src/models/TabLayoutModificationResponse.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/TabLayoutModificationResponse.ts#L24) + +--- + +### Theme + +Ƭ **Theme**: [`ThemeProperties`](../interfaces/kui_shell_core.ThemeProperties.md) & { `apiVersion?`: `ThemeApiVersion` ; `attrs?`: `string`[] ; `css`: `string` \| `string`[] ; `description?`: `string` ; `lightweight?`: `boolean` ; `name`: `string` ; `style`: `"light"` \| `"dark"` } + +#### Defined in + +[packages/core/src/webapp/themes/Theme.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/themes/Theme.ts#L29) + +--- + +### ToolbarProps + +Ƭ **ToolbarProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `willUpdateToolbar?` | (`toolbarText`: [`ToolbarText`](../interfaces/kui_shell_core.ToolbarText.md), `extraButtons?`: [`Button`](kui_shell_core.md#button)<[`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\>[], `extraButtonsOverride?`: `boolean`) => `void` | + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L39) + +--- + +### ViewTransformer + +Ƭ **ViewTransformer**<`T`, `O`\>: (`args`: [`Arguments`](../interfaces/kui_shell_core.Arguments.md)<`O`\>, `response`: `T`) => `Promise`<`T`\> \| `void` \| `Promise`<`void`\> + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------- | +| `T` | extends [`KResponse`](kui_shell_core.md#kresponse) | +| `O` | extends [`ParsedOptions`](../interfaces/kui_shell_core.ParsedOptions.md) | + +#### Type declaration + +▸ (`args`, `response`): `Promise`<`T`\> \| `void` \| `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------- | +| `args` | [`Arguments`](../interfaces/kui_shell_core.Arguments.md)<`O`\> | +| `response` | `T` | + +##### Returns + +`Promise`<`T`\> \| `void` \| `Promise`<`void`\> + +#### Defined in + +[packages/core/src/models/command.ts:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L48) + +## Properties + +### Store + +• **Store**: () => `LocalStorage` + +#### Type declaration + +▸ (): `LocalStorage` + +This shim allows clients to define a localStorage scheme, if they +cannot provide window.localStorage. + +##### Returns + +`LocalStorage` + +--- + +### SymbolTable + +• **SymbolTable**: `SymbolTable` + +--- + +### boot + +• **boot**: (`client`: `ClientRender`) => `Promise`<`void`\> + +#### Type declaration + +▸ (`client`): `Promise`<`void`\> + +Usage: clients will invoke this with their main renderer. + +For reference, the HTML template is to be found in +../../../templates/index.ejs. This template is in turn managed by +packages/webpack/webpack.config.js. + +##### Parameters + +| Name | Type | +| :------- | :------------- | +| `client` | `ClientRender` | + +##### Returns + +`Promise`<`void`\> + +--- + +### encodeComponent + +• **encodeComponent**: (`component`: `string` \| `number` \| `boolean`, `quote`: `string`) => `string` + +#### Type declaration + +▸ (`component`, `quote?`): `string` + +Add quotes if the argument needs it; compare to encodeURIComponent + +##### Parameters + +| Name | Type | Default value | +| :---------- | :-------------------------------- | :------------ | +| `component` | `string` \| `number` \| `boolean` | `undefined` | +| `quote` | `string` | `'"'` | + +##### Returns + +`string` + +--- + +### i18n + +• **i18n**: (`plugin`: `string`, `namespace`: `string`) => (`key`: `string`, ...`parameters`: (`string` \| `number`)[]) => `string` + +#### Type declaration + +▸ (`plugin`, `namespace?`): (`key`: `string`, ...`parameters`: (`string` \| `number`)[]) => `string` + +##### Parameters + +| Name | Type | Default value | +| :---------- | :------- | :------------ | +| `plugin` | `string` | `undefined` | +| `namespace` | `string` | `'resources'` | + +##### Returns + +`fn` + +▸ (`key`, ...`parameters`): `string` + +##### Parameters + +| Name | Type | +| :-------------- | :----------------------- | +| `key` | `string` | +| `...parameters` | (`string` \| `number`)[] | + +##### Returns + +`string` + +## Variables + +### KeyCodes + +• **KeyCodes**: `Object` + +#### Type declaration + +| Name | Type | +| :------------ | :------- | +| `A` | `number` | +| `B` | `number` | +| `BACKSPACE` | `number` | +| `C` | `number` | +| `D` | `number` | +| `DOWN` | `number` | +| `E` | `number` | +| `END` | `number` | +| `ENTER` | `number` | +| `ESCAPE` | `number` | +| `F` | `number` | +| `HOME` | `number` | +| `K` | `number` | +| `L` | `number` | +| `LEFT_ARROW` | `number` | +| `N` | `number` | +| `P` | `number` | +| `PAGEDOWN` | `number` | +| `PAGEUP` | `number` | +| `R` | `number` | +| `RIGHT_ARROW` | `number` | +| `T` | `number` | +| `TAB` | `number` | +| `U` | `number` | +| `UP` | `number` | + +#### Defined in + +[packages/core/src/webapp/keys.ts:17](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/keys.ts#L17) + +--- + +### badgeRegistrar + +• **badgeRegistrar**: [`BadgeRegistration`](../interfaces/kui_shell_core.BadgeRegistration.md)<[`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)\>[] = `[]` + +registered badge handlers + +#### Defined in + +[packages/core/src/webapp/views/registrar/badges.ts:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/badges.ts#L48) + +## Functions + +### History + +▸ **History**(`tab`): [`HistoryModel`](../classes/kui_shell_core.HistoryModel.md) + +#### Parameters + +| Name | Type | +| :---- | :------------------------------------------------------- | +| `tab` | `string` \| [`Tab`](../interfaces/kui_shell_core.Tab.md) | + +#### Returns + +[`HistoryModel`](../classes/kui_shell_core.HistoryModel.md) + +#### Defined in + +[packages/core/src/index.ts:107](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/index.ts#L107) + +--- + +### \_split + +▸ `Const` **\_split**(`str`, `removeOuterQuotes?`, `returnIndices?`, `removeInlineOuterQuotes?`, `splitBy?`, `startIdx?`, `endIdx?`): `string`[] \| [`Split`](../interfaces/kui_shell_core.Split.md) + +#### Parameters + +| Name | Type | Default value | +| :------------------------ | :-------- | :------------ | +| `str` | `string` | `undefined` | +| `removeOuterQuotes` | `boolean` | `true` | +| `returnIndices` | `boolean` | `false` | +| `removeInlineOuterQuotes` | `boolean` | `false` | +| `splitBy` | `string` | `' '` | +| `startIdx` | `number` | `0` | +| `endIdx` | `number` | `str.length` | + +#### Returns + +`string`[] \| [`Split`](../interfaces/kui_shell_core.Split.md) + +#### Defined in + +[packages/core/src/repl/split.ts:61](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/split.ts#L61) + +--- + +### addRelevantModes + +▸ **addRelevantModes**<`Resource`\>(`tab`, `modes`, `command`, `resource`): `void` + +Apply all registered modes that are relevant to the given resource +to the given modes model + +#### Type parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`, `Resource`\> | + +#### Parameters + +| Name | Type | +| :------------------ | :--------------------------------------------------------------------------------------------------------------------------- | +| `tab` | [`Tab`](../interfaces/kui_shell_core.Tab.md) | +| `modes` | [`Mode`](kui_shell_core.md#mode)<[`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\>[] | +| `command` | `string` | +| `resource` | `Object` | +| `resource.resource` | `Resource` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/views/registrar/modes.ts:66](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/modes.ts#L66) + +--- + +### aggregateStatusModelStatus + +▸ **aggregateStatusModelStatus**(`tile`): `Promise`<[`StatusModelStatus`](kui_shell_core.md#statusmodelstatus)\> + +Roll up the status of the LineItems + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------- | +| `tile` | [`StatusModelTile`](../interfaces/kui_shell_core.StatusModelTile.md) | + +#### Returns + +`Promise`<[`StatusModelStatus`](kui_shell_core.md#statusmodelstatus)\> + +#### Defined in + +[packages/core/src/models/StatusModel.ts:130](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L130) + +--- + +### assertHasProxy + +▸ `Const` **assertHasProxy**(): `void` + +Assert that Kui is supported by a remote proxy + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/capabilities.ts:105](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L105) + +--- + +### assertInSandbox + +▸ **assertInSandbox**(): `void` + +Yes, we are running in a sandbox + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/capabilities.ts:121](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L121) + +--- + +### assertLocalAccess + +▸ `Const` **assertLocalAccess**(): `void` + +Assert that we have local access, even if the default behavior +would indicate otherwise + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/capabilities.ts:192](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L192) + +--- + +### bootIntoSandbox + +▸ **bootIntoSandbox**(): `Promise`<`void`\> + +For booting into an external browser sandbox, such as codesandbox.io + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/webapp/bootstrap/boot.ts:103](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/bootstrap/boot.ts#L103) + +--- + +### cellShouldHaveBadge + +▸ **cellShouldHaveBadge**(`cell`): `void` \| [`CellShould`](../enums/kui_shell_core.CellShould.md) + +Should the cell be rendered with a traffic light badge? + +#### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------- | +| `cell` | [`RadioTableCell`](kui_shell_core.md#radiotablecell) | + +#### Returns + +`void` \| [`CellShould`](../enums/kui_shell_core.CellShould.md) + +#### Defined in + +[packages/core/src/models/RadioTable.ts:63](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L63) + +--- + +### commandsOfferedByPlugin + +▸ `Const` **commandsOfferedByPlugin**(`plugin?`): `Promise`<[`Table`](../classes/kui_shell_core.Table.md)<[`Row`](../classes/kui_shell_core.Row.md)\>\> + +Render the commands provided by a given plugin + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `plugin?` | `string` | + +#### Returns + +`Promise`<[`Table`](../classes/kui_shell_core.Table.md)<[`Row`](../classes/kui_shell_core.Row.md)\>\> + +#### Defined in + +[packages/core/src/api/plugins.ts:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/api/plugins.ts#L46) + +--- + +### cwd + +▸ `Const` **cwd**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/util/home.ts:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/home.ts#L49) + +--- + +### disableInputQueueing + +▸ `Const` **disableInputQueueing**(`tab`): `string` + +#### Parameters + +| Name | Type | +| :---- | :------------------------------------------- | +| `tab` | [`Tab`](../interfaces/kui_shell_core.Tab.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/webapp/queueing.ts:60](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/queueing.ts#L60) + +--- + +### doCancel + +▸ **doCancel**(`tab`, `block`, `valueTypedSoFar`): `void` + +#### Parameters + +| Name | Type | +| :---------------- | :----------------------------------------------- | +| `tab` | [`Tab`](../interfaces/kui_shell_core.Tab.md) | +| `block` | [`Block`](../interfaces/kui_shell_core.Block.md) | +| `valueTypedSoFar` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/cancel.ts:33](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/cancel.ts#L33) + +--- + +### doEval + +▸ `Const` **doEval**(`_tab`, `block`, `command`, `execUUID?`): `Promise`<[`KResponse`](kui_shell_core.md#kresponse)<`any`\> \| [`CodedError`](../interfaces/kui_shell_core.CodedError.md)<`number`\>\> + +User hit enter in the REPL + +#### Parameters + +| Name | Type | Description | +| :---------- | :----------------------------------------------- | :----------------------- | +| `_tab` | [`Tab`](../interfaces/kui_shell_core.Tab.md) | - | +| `block` | [`Block`](../interfaces/kui_shell_core.Block.md) | - | +| `command` | `string` | - | +| `execUUID?` | `string` | for command re-execution | + +#### Returns + +`Promise`<[`KResponse`](kui_shell_core.md#kresponse)<`any`\> \| [`CodedError`](../interfaces/kui_shell_core.CodedError.md)<`number`\>\> + +#### Defined in + +[packages/core/src/repl/exec.ts:603](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/exec.ts#L603) + +--- + +### empty + +▸ `Const` **empty**(`node`): `void` + +Clean out the given DOM node + +#### Parameters + +| Name | Type | +| :----- | :----- | +| `node` | `Node` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/util/dom.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/util/dom.ts#L21) + +--- + +### executeSequentially + +▸ **executeSequentially**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/api/client.ts:78](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/api/client.ts#L78) + +--- + +### expandHomeDir + +▸ `Const` **expandHomeDir**(`path`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `path` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/util/home.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/home.ts#L24) + +--- + +### fallbackCWD + +▸ **fallbackCWD**(`cwd?`): `string` + +In case of error, e.g. removed CWD, this is our fallback plan + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `cwd?` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/util/home.ts:41](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/home.ts#L41) + +--- + +### findCompletions + +▸ **findCompletions**(`tab`, `commandLine`, `spec`): `Promise`<[`CompletionResponse`](kui_shell_core.md#completionresponse)[]\> + +Consult each registered enumerator to see what it has to offer in +the way of completions. Pick the one with highest priority, or the +first to register in the case of a tie-breaker. + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `tab` | `Object` | +| `tab.REPL` | [`REPL`](../interfaces/kui_shell_core.REPL.md) | +| `commandLine` | `Omit`<[`CommandLine`](../interfaces/kui_shell_core.CommandLine.md)<[`ParsedOptions`](../interfaces/kui_shell_core.ParsedOptions.md)\>, `"pipeStages"` \| `"pipeStagesNoOptions"`\> | +| `spec` | [`TabCompletionSpec`](../interfaces/kui_shell_core.TabCompletionSpec.md) | + +#### Returns + +`Promise`<[`CompletionResponse`](kui_shell_core.md#completionresponse)[]\> + +#### Defined in + +[packages/core/src/repl/tab-completion.ts:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/tab-completion.ts#L70) + +--- + +### findFile + +▸ `Const` **findFile**(`filepath`, `keepRelative?`): `string` + +Resolve @ and ~ files + +#### Parameters + +| Name | Type | Description | +| :-------------------------- | :-------- | :------------- | +| `filepath` | `string` | - | +| `keepRelative` | `Object` | don't expand ~ | +| `keepRelative.keepRelative` | `boolean` | - | +| `keepRelative.safe` | `boolean` | - | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/find-file.ts:119](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/find-file.ts#L119) + +--- + +### findFileWithViewer + +▸ `Const` **findFileWithViewer**(`filepath`, `__namedParameters?`): `Object` + +Behaves like `findFile` with an extra call to `commandPrefix` + +#### Parameters + +| Name | Type | +| :------------------------------- | :-------- | +| `filepath` | `string` | +| `__namedParameters` | `Object` | +| `__namedParameters.keepRelative` | `boolean` | +| `__namedParameters.safe` | `boolean` | + +#### Returns + +`Object` + +| Name | Type | +| :--------- | :------- | +| `resolved` | `string` | +| `viewer?` | `string` | + +#### Defined in + +[packages/core/src/core/find-file.ts:72](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/find-file.ts#L72) + +--- + +### findThemeByName + +▸ **findThemeByName**(`name`): `Promise`<`Object`\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `name` | `string` | + +#### Returns + +`Promise`<`Object`\> + +the Theme model associated with the given theme name + +#### Defined in + +[packages/core/src/webapp/themes/find.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/themes/find.ts#L25) + +--- + +### flatten + +▸ **flatten**<`T`\>(`arrays`): `T`[] + +flatten an array of arrays + +#### Type parameters + +| Name | +| :--- | +| `T` | + +#### Parameters + +| Name | Type | +| :------- | :------ | +| `arrays` | `T`[][] | + +#### Returns + +`T`[] + +#### Defined in + +[packages/core/src/core/utility.ts:72](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/utility.ts#L72) + +--- + +### getAuthValue + +▸ `Const` **getAuthValue**(`provider`, `key`): `any` + +Retrieve the value for the given key for the auth model of the given provider + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `provider` | `string` | +| `key` | `string` | + +#### Returns + +`any` + +#### Defined in + +[packages/core/src/core/capabilities.ts:153](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L153) + +--- + +### getCurrentTab + +▸ `Const` **getCurrentTab**(): [`Tab`](../interfaces/kui_shell_core.Tab.md) + +#### Returns + +[`Tab`](../interfaces/kui_shell_core.Tab.md) + +#### Defined in + +[packages/core/src/webapp/tab.ts:77](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L77) + +--- + +### getDefaultTheme + +▸ **getDefaultTheme**(): `Promise`<`string`\> + +#### Returns + +`Promise`<`string`\> + +the name of the default theme + +#### Defined in + +[packages/core/src/webapp/themes/default.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/themes/default.ts#L27) + +--- + +### getOrSetPreference + +▸ **getOrSetPreference**(`key`, `defaultValue`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :------------------------------------------------- | +| `key` | `string` | +| `defaultValue` | `string` \| () => `string` \| `Promise`<`string`\> | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/core/src/core/userdata.ts:187](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/userdata.ts#L187) + +--- + +### getPersistedThemeChoice + +▸ `Const` **getPersistedThemeChoice**(): `Promise`<`string`\> + +Return the previously selected (and persisted) choice of theme + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/core/src/webapp/themes/persistence.ts:41](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/themes/persistence.ts#L41) + +--- + +### getPreference + +▸ `Const` **getPreference**(`key`): `Promise`<`string`\> + +Get a persisted preference + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `key` | `string` | + +#### Returns + +`Promise`<`string`\> + +the preference value + +#### Defined in + +[packages/core/src/core/userdata.ts:166](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/userdata.ts#L166) + +--- + +### getPrimaryTabId + +▸ **getPrimaryTabId**(`tab`): `string` + +#### Parameters + +| Name | Type | +| :---- | :-------------------------------------------------------------- | +| `tab` | `Pick`<[`Tab`](../interfaces/kui_shell_core.Tab.md), `"uuid"`\> | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/webapp/tab.ts:65](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L65) + +--- + +### getTab + +▸ `Const` **getTab**(`idx`): [`Tab`](../interfaces/kui_shell_core.Tab.md) + +#### Parameters + +| Name | Type | +| :---- | :------------------------------------------------------- | +| `idx` | `number` \| [`Tab`](../interfaces/kui_shell_core.Tab.md) | + +#### Returns + +[`Tab`](../interfaces/kui_shell_core.Tab.md) + +#### Defined in + +[packages/core/src/webapp/tab.ts:87](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L87) + +--- + +### getTabId + +▸ **getTabId**(`tab`): `string` + +Return the unique identifier for the given tab + +#### Parameters + +| Name | Type | +| :---- | :-------------------------------------------------------------- | +| `tab` | `Pick`<[`Tab`](../interfaces/kui_shell_core.Tab.md), `"uuid"`\> | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/webapp/tab.ts:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L51) + +--- + +### getValidCredentials + +▸ `Const` **getValidCredentials**(): `CredentialsMap` + +Return a map of all valid credentials + +#### Returns + +`CredentialsMap` + +#### Defined in + +[packages/core/src/core/capabilities.ts:162](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L162) + +--- + +### hasContent + +▸ **hasContent**<`T`\>(`resource`): resource is Content + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------------------------------------------------- | +| `T` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`, `T`\> | + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------------------------------------------------------------------------------------------------------------------------- | +| `resource` | [`ScalarResource`](kui_shell_core.md#scalarresource) \| [`Content`](kui_shell_core.md#content)<`T`\> \| [`Mode`](kui_shell_core.md#mode)<`T`\> | + +#### Returns + +resource is Content + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:204](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L204) + +--- + +### hasDisplayName + +▸ **hasDisplayName**(`resource`): resource is WithDisplayName + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------------------------------- | +| `resource` | [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\> | + +#### Returns + +resource is WithDisplayName + +#### Defined in + +[packages/core/src/models/entity.ts:100](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L100) + +--- + +### hasProxy + +▸ `Const` **hasProxy**(): `boolean` + +Is Kui supported by a remote proxy? + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/core/capabilities.ts:99](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L99) + +--- + +### hasSourceReferences + +▸ **hasSourceReferences**(`response`): response is Required + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------------------------------------------------------------- | +| `response` | `Partial`<[`WithSourceReferences`](../interfaces/kui_shell_core.WithSourceReferences.md)\> | + +#### Returns + +response is Required + +#### Defined in + +[packages/core/src/models/entity.ts:239](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L239) + +--- + +### hideReplayOutput + +▸ **hideReplayOutput**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/api/client.ts:68](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/api/client.ts#L68) + +--- + +### i18nFromMap + +▸ **i18nFromMap**(`map`): `string` + +#### Parameters + +| Name | Type | +| :---- | :---------------------------- | +| `map` | `Record`<`string`, `string`\> | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/util/i18n.ts:30](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/i18n.ts#L30) + +--- + +### inBrowser + +▸ `Const` **inBrowser**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/core/capabilities.ts:82](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L82) + +--- + +### inElectron + +▸ `Const` **inElectron**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/core/capabilities.ts:81](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L81) + +--- + +### inProxy + +▸ `Const` **inProxy**(): `boolean` + +Are we the Kui proxy? + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/core/capabilities.ts:113](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L113) + +--- + +### inSandbox + +▸ **inSandbox**(): `boolean` + +Are we running in a sandbox? + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/core/capabilities.ts:129](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L129) + +--- + +### initializeSession + +▸ **initializeSession**(`tab`): `Promise`<`void`\> + +Initialize the session for the given `Tab`. Await the response if +you need to block until all session initializers have completed. + +#### Parameters + +| Name | Type | +| :---- | :------------------------------------------- | +| `tab` | [`Tab`](../interfaces/kui_shell_core.Tab.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/session/init.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/session/init.ts#L28) + +--- + +### internalBeCarefulExec + +▸ `Const` **internalBeCarefulExec**(`commandUntrimmed`, `execOptions?`): `Promise`<[`KResponse`](kui_shell_core.md#kresponse)<`any`\> \| [`CodedError`](../interfaces/kui_shell_core.CodedError.md)<`number`\>\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------- | +| `commandUntrimmed` | `string` | +| `execOptions` | [`ExecOptions`](../interfaces/kui_shell_core.ExecOptions.md) | + +#### Returns + +`Promise`<[`KResponse`](kui_shell_core.md#kresponse)<`any`\> \| [`CodedError`](../interfaces/kui_shell_core.CodedError.md)<`number`\>\> + +#### Defined in + +[packages/core/src/repl/exec.ts:593](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/exec.ts#L593) + +--- + +### internalBeCarefulPExec + +▸ `Const` **internalBeCarefulPExec**<`T`\>(`command`, `execOptions?`): `Promise`<`T`\> + +Programmatic exec, as opposed to human typing and hitting enter + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------- | +| `T` | extends [`KResponse`](kui_shell_core.md#kresponse)<`any`\> | + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------------------------- | +| `command` | `string` | +| `execOptions?` | [`ExecOptions`](../interfaces/kui_shell_core.ExecOptions.md) | + +#### Returns + +`Promise`<`T`\> + +#### Defined in + +[packages/core/src/repl/exec.ts:689](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/exec.ts#L689) + +--- + +### is404 + +▸ **is404**<`Code`\>(`err`): err is CodedError<404\> + +#### Type parameters + +| Name | Type | +| :----- | :------- | +| `Code` | `number` | + +#### Parameters + +| Name | Type | +| :---- | :------------------------------ | +| `err` | `string` \| `object` \| `Error` | + +#### Returns + +err is CodedError<404\> + +#### Defined in + +[packages/core/src/models/errors.ts:33](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/errors.ts#L33) + +--- + +### is404or409 + +▸ **is404or409**<`Code`\>(`err`): err is CodedError<404 \| 409\> + +#### Type parameters + +| Name | Type | +| :----- | :------- | +| `Code` | `number` | + +#### Parameters + +| Name | Type | +| :---- | :------------------------------ | +| `err` | `string` \| `object` \| `Error` | + +#### Returns + +err is CodedError<404 \| 409\> + +#### Defined in + +[packages/core/src/models/errors.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/errors.ts#L43) + +--- + +### is409 + +▸ **is409**<`Code`\>(`err`): err is CodedError<409\> + +#### Type parameters + +| Name | Type | +| :----- | :------- | +| `Code` | `number` | + +#### Parameters + +| Name | Type | +| :---- | :------------------------------ | +| `err` | `string` \| `object` \| `Error` | + +#### Returns + +err is CodedError<409\> + +#### Defined in + +[packages/core/src/models/errors.ts:38](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/errors.ts#L38) + +--- + +### isAbortableResponse + +▸ **isAbortableResponse**(`entity`): entity is AbortableResponse\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +entity is AbortableResponse\> + +#### Defined in + +[packages/core/src/models/entity.ts:247](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L247) + +--- + +### isButton + +▸ **isButton**<`T`\>(`mode`): mode is Button + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `T` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`, `T`\>[`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\> | + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `mode` | [`Button`](kui_shell_core.md#button)<`T`\> \| [`Content`](kui_shell_core.md#content)<`T`\> \| [`MultiModalMode`](kui_shell_core.md#multimodalmode)<`T`\> | + +#### Returns + +mode is Button + +#### Defined in + +[packages/core/src/models/mmr/types.ts:144](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/types.ts#L144) + +--- + +### isCodedError + +▸ **isCodedError**<`Code`\>(`err`): err is CodedError + +#### Type parameters + +| Name | Type | +| :----- | :------- | +| `Code` | `number` | + +#### Parameters + +| Name | Type | +| :---- | :------------------------------ | +| `err` | `string` \| `object` \| `Error` | + +#### Returns + +err is CodedError + +#### Defined in + +[packages/core/src/models/errors.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/errors.ts#L28) + +--- + +### isCommandHandlerWithEvents + +▸ **isCommandHandlerWithEvents**<`T`, `O`\>(`evaluator`): evaluator is CommandHandlerWithEvents + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------- | +| `T` | extends [`KResponse`](kui_shell_core.md#kresponse)<`any`\> | +| `O` | extends [`ParsedOptions`](../interfaces/kui_shell_core.ParsedOptions.md) | + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------------------ | +| `evaluator` | [`Evaluator`](../interfaces/kui_shell_core.Evaluator.md)<`T`, `O`\> | + +#### Returns + +evaluator is CommandHandlerWithEvents + +#### Defined in + +[packages/core/src/models/command.ts:282](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/command.ts#L282) + +--- + +### isCommandStringContent + +▸ **isCommandStringContent**<`T`\>(`content`): content is CommandStringContent + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------------------------------------------------- | +| `T` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`, `T`\> | + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content` | [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\> \| [`ScalarResource`](kui_shell_core.md#scalarresource) \| [`Content`](kui_shell_core.md#content)<`T`\> \| [`Mode`](kui_shell_core.md#mode)<`T`\> | + +#### Returns + +content is CommandStringContent + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:177](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L177) + +--- + +### isCommentaryResponse + +▸ **isCommentaryResponse**(`entity`): entity is CommentaryResponse + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +entity is CommentaryResponse + +#### Defined in + +[packages/core/src/models/CommentaryResponse.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CommentaryResponse.ts#L39) + +--- + +### isCommentarySectionBreak + +▸ **isCommentarySectionBreak**(`entity`): `boolean` + +is this commentary reponse be able to treated as a section break + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/models/CommentaryResponse.ts:45](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CommentaryResponse.ts#L45) + +--- + +### isCursorMovement + +▸ `Const` **isCursorMovement**(`evt`): `boolean` + +does the given keycode correspond to a cursor movement? + +#### Parameters + +| Name | Type | +| :---- | :-------------- | +| `evt` | `KeyboardEvent` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/webapp/keys.ts:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/keys.ts#L48) + +--- + +### isDescriptionList + +▸ **isDescriptionList**(`content`): content is DescriptionList + +#### Parameters + +| Name | Type | +| :-------- | :--------------------------------------------------- | +| `content` | [`ScalarResource`](kui_shell_core.md#scalarresource) | + +#### Returns + +content is DescriptionList + +#### Defined in + +[packages/core/src/models/DescriptionList.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/DescriptionList.ts#L43) + +--- + +### isExecutableClient + +▸ **isExecutableClient**(): `boolean` + +Is the current client running in an executable mode? + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/api/client.ts:53](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/api/client.ts#L53) + +--- + +### isFunctionContent + +▸ **isFunctionContent**<`T`\>(`content`): content is FunctionContent + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `T` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`, `T`\>[`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\> | + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> \| [`Content`](kui_shell_core.md#content)<`T`\> \| [`Mode`](kui_shell_core.md#mode)<`T`\> | + +#### Returns + +content is FunctionContent + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:160](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L160) + +--- + +### isHTML + +▸ **isHTML**(`message`): message is HTMLElement + +#### Parameters + +| Name | Type | +| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `message` | `Node` \| `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> \| `MessageWithUsageModel` | + +#### Returns + +message is HTMLElement + +#### Defined in + +[packages/core/src/util/types.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/types.ts#L21) + +--- + +### isHeadless + +▸ `Const` **isHeadless**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/core/capabilities.ts:80](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L80) + +--- + +### isLink + +▸ **isLink**(`link`): link is Link + +#### Parameters + +| Name | Type | +| :----- | :------------------------------- | +| `link` | [`Link`](kui_shell_core.md#link) | + +#### Returns + +link is Link + +#### Defined in + +[packages/core/src/models/NavResponse.ts:54](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/NavResponse.ts#L54) + +--- + +### isLinkWithCommand + +▸ **isLinkWithCommand**(`link`): link is Label & Command + +#### Parameters + +| Name | Type | +| :----- | :------------------------------- | +| `link` | [`Link`](kui_shell_core.md#link) | + +#### Returns + +link is Label & Command + +#### Defined in + +[packages/core/src/models/NavResponse.ts:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/NavResponse.ts#L46) + +--- + +### isLinkWithHref + +▸ **isLinkWithHref**(`link`): link is Label & Href + +#### Parameters + +| Name | Type | +| :----- | :------------------------------- | +| `link` | [`Link`](kui_shell_core.md#link) | + +#### Returns + +link is Label & Href + +#### Defined in + +[packages/core/src/models/NavResponse.ts:50](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/NavResponse.ts#L50) + +--- + +### isMarkdownResponse + +▸ **isMarkdownResponse**(`entity`): entity is MarkdownResponse + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +entity is MarkdownResponse + +#### Defined in + +[packages/core/src/models/entity.ts:135](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L135) + +--- + +### isMessageWithCode + +▸ **isMessageWithCode**(`msg`): msg is MessageWithCode + +#### Parameters + +| Name | Type | +| :---- | :---------- | +| `msg` | `UsageLike` | + +#### Returns + +msg is MessageWithCode + +#### Defined in + +[packages/core/src/core/usage-error.ts:877](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L877) + +--- + +### isMessageWithUsageModel + +▸ **isMessageWithUsageModel**(`msg`): msg is MessageWithUsageModel + +#### Parameters + +| Name | Type | +| :---- | :---------- | +| `msg` | `UsageLike` | + +#### Returns + +msg is MessageWithUsageModel + +#### Defined in + +[packages/core/src/core/usage-error.ts:133](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L133) + +--- + +### isMixedResponse + +▸ **isMixedResponse**(`response`): response is MixedResponse + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `response` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +response is MixedResponse + +#### Defined in + +[packages/core/src/models/entity.ts:161](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L161) + +--- + +### isMultiModalResponse + +▸ **isMultiModalResponse**(`entity`): entity is MultiModalResponse\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +entity is MultiModalResponse\> + +#### Defined in + +[packages/core/src/models/mmr/is.ts:20](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/is.ts#L20) + +--- + +### isNavResponse + +▸ **isNavResponse**(`entity`): entity is NavResponse + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +entity is NavResponse + +#### Defined in + +[packages/core/src/models/NavResponse.ts:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/NavResponse.ts#L58) + +--- + +### isNewSplitRequest + +▸ **isNewSplitRequest**(`req`): req is TabLayoutModificationResponse + +#### Parameters + +| Name | Type | +| :---- | :------------------------------------------------------------------------------------------------------------------------------------------ | +| `req` | [`TabLayoutModificationResponse`](kui_shell_core.md#tablayoutmodificationresponse)<[`NewSplitRequest`](kui_shell_core.md#newsplitrequest)\> | + +#### Returns + +req is TabLayoutModificationResponse + +#### Defined in + +[packages/core/src/models/TabLayoutModificationResponse.ts:60](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/TabLayoutModificationResponse.ts#L60) + +--- + +### isNotebook + +▸ **isNotebook**(`raw`): raw is Notebook + +#### Parameters + +| Name | Type | +| :---- | :------------------------- | +| `raw` | `Record`<`string`, `any`\> | + +#### Returns + +raw is Notebook + +wether or not the given `raw` json is an instance of Notebook + +#### Defined in + +[packages/core/src/repl/events.ts:83](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/events.ts#L83) + +--- + +### isOfflineClient + +▸ **isOfflineClient**(): `boolean` + +Is the current client running in offline/disconnected mode? + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/api/client.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/api/client.ts#L21) + +--- + +### isPopup + +▸ `Const` **isPopup**(): `boolean` + +are we operating in popup mode? + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/webapp/popup-core.ts:18](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/popup-core.ts#L18) + +--- + +### isPromise + +▸ **isPromise**<`T`, `U`\>(`content`): content is Promise + +#### Type parameters + +| Name | +| :--- | +| `T` | +| `U` | + +#### Parameters + +| Name | Type | +| :-------- | :--------------------- | +| `content` | `U` \| `Promise`<`T`\> | + +#### Returns + +content is Promise + +#### Defined in + +[packages/core/src/util/types.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/types.ts#L25) + +--- + +### isRadioTable + +▸ **isRadioTable**(`response`): response is RadioTable + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------- | +| `response` | [`KResponse`](kui_shell_core.md#kresponse)<`any`\> | + +#### Returns + +response is RadioTable + +#### Defined in + +[packages/core/src/models/RadioTable.ts:100](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L100) + +--- + +### isRandomErrorResponse1 + +▸ **isRandomErrorResponse1**(`response`): response is RandomErrorResponse1 + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `response` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +response is RandomErrorResponse1 + +#### Defined in + +[packages/core/src/models/entity.ts:193](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L193) + +--- + +### isRandomErrorResponse2 + +▸ **isRandomErrorResponse2**(`response`): response is RandomErrorResponse2 + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `response` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +response is RandomErrorResponse2 + +#### Defined in + +[packages/core/src/models/entity.ts:198](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L198) + +--- + +### isReactProvider + +▸ **isReactProvider**(`entity`): entity is ReactProvider + +#### Parameters + +| Name | Type | +| :------- | :----------------------------------------------------------------------------------------------------- | +| `entity` | `ScalarLike`<[`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +entity is ReactProvider + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L43) + +--- + +### isReactResponse + +▸ **isReactResponse**(`entity`): entity is ReactResponse + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +entity is ReactResponse + +#### Defined in + +[packages/core/src/models/entity.ts:142](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L142) + +--- + +### isReadOnlyClient + +▸ **isReadOnlyClient**(): `boolean` + +Is the current client running in readonly mode? + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/api/client.ts:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/api/client.ts#L37) + +--- + +### isResizable + +▸ **isResizable**(`job`): job is Resizable + +#### Parameters + +| Name | Type | +| :---- | :------------------------------------------------------------------- | +| `job` | `Partial`<[`Resizable`](../interfaces/kui_shell_core.Resizable.md)\> | + +#### Returns + +job is Resizable + +#### Defined in + +[packages/core/src/core/jobs/job.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/job.ts#L25) + +--- + +### isResourceByReference + +▸ **isResourceByReference**<`T`\>(`spec`): spec is T + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------- | +| `T` | extends [`ResourceByReference`](../interfaces/kui_shell_core.ResourceByReference.md)<`void`, `T`\> | + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `spec` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> \| `T` \| [`ResourceWithMetadataWithContent`](kui_shell_core.md#resourcewithmetadatawithcontent)<`any`\> | + +#### Returns + +spec is T + +#### Defined in + +[packages/core/src/models/entity.ts:113](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L113) + +--- + +### isResourceWithMetadata + +▸ **isResourceWithMetadata**(`spec`): spec is ResourceWithMetadata + +#### Parameters + +| Name | Type | +| :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `spec` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +spec is ResourceWithMetadata + +#### Defined in + +[packages/core/src/models/entity.ts:89](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L89) + +--- + +### isScalarContent + +▸ **isScalarContent**<`T`\>(`entity`): entity is ScalarContent + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------------------------------------------------- | +| `T` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`, `T`\> | + +#### Parameters + +| Name | Type | +| :------- | :----------------- | +| `entity` | `ScalarLike`<`T`\> | + +#### Returns + +entity is ScalarContent + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L56) + +--- + +### isScalarResponse + +▸ **isScalarResponse**(`response`): response is ScalarResponse + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `response` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +response is ScalarResponse + +#### Defined in + +[packages/core/src/models/entity.ts:219](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/entity.ts#L219) + +--- + +### isSpecialDirectory + +▸ `Const` **isSpecialDirectory**(`filepath`): `boolean` + +Is this a special @ directory? + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `filepath` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/core/find-file.ts:66](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/find-file.ts#L66) + +--- + +### isStatusModel + +▸ **isStatusModel**(`entity`): entity is StatusModel + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +entity is StatusModel + +#### Defined in + +[packages/core/src/models/StatusModel.ts:67](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/StatusModel.ts#L67) + +--- + +### isStringDiffContent + +▸ **isStringDiffContent**<`T`\>(`entity`): entity is StringDiffContent + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------------------------------------------------- | +| `T` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`, `T`\> | + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> \| [`Content`](kui_shell_core.md#content)<`T`\> \| [`Mode`](kui_shell_core.md#mode)<`T`\> | + +#### Returns + +entity is StringDiffContent + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:122](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L122) + +--- + +### isStringResponse + +▸ **isStringResponse**(`response`): response is string + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------------------------------- | +| `response` | [`CompletionResponse`](kui_shell_core.md#completionresponse) | + +#### Returns + +response is string + +#### Defined in + +[packages/core/src/repl/tab-completion.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/tab-completion.ts#L39) + +--- + +### isStringWithOptionalContentType + +▸ **isStringWithOptionalContentType**<`T`\>(`entity`): entity is StringContent + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------------------------------------------------- | +| `T` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`, `T`\> | + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> \| [`Content`](kui_shell_core.md#content)<`T`\> \| [`Mode`](kui_shell_core.md#mode)<`T`\> | + +#### Returns + +entity is StringContent + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:99](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L99) + +--- + +### isSupportedContentType + +▸ **isSupportedContentType**(`contentType`): `boolean` + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `contentType` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/models/mmr/content-types.ts:71](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/content-types.ts#L71) + +--- + +### isSupportedToolbarTextType + +▸ **isSupportedToolbarTextType**(`type`): type is ToolbarTextType + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `type` | `string` | + +#### Returns + +type is ToolbarTextType + +#### Defined in + +[packages/core/src/webapp/views/toolbar-text.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/toolbar-text.ts#L24) + +--- + +### isSuspendable + +▸ **isSuspendable**(`watch`): () => `void` + +#### Parameters + +| Name | Type | +| :------ | :--------------------------------------------------------- | +| `watch` | `Partial`<[`Suspendable`](kui_shell_core.md#suspendable)\> | + +#### Returns + +`fn` + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +[packages/core/src/core/jobs/job.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/job.ts#L40) + +--- + +### isTabLayoutModificationResponse + +▸ **isTabLayoutModificationResponse**(`entity`): entity is TabLayoutModificationResponse + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +entity is TabLayoutModificationResponse + +#### Defined in + +[packages/core/src/models/TabLayoutModificationResponse.ts:66](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/TabLayoutModificationResponse.ts#L66) + +--- + +### isTable + +▸ **isTable**<`C`\>(`model`): model is Table + +#### Type parameters + +| Name | +| :--- | +| `C` | + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `model` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> \| [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`C`\> | + +#### Returns + +model is Table + +#### Defined in + +[packages/core/src/webapp/models/table.ts:230](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L230) + +--- + +### isTableWithCount + +▸ **isTableWithCount**(`table`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------------------------------------------------------------- | +| `table` | [`Table`](../classes/kui_shell_core.Table.md)<[`Row`](../classes/kui_shell_core.Row.md)\> | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:221](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L221) + +--- + +### isTableWithTimestamp + +▸ **isTableWithTimestamp**(`table`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------------------------------------------------------------- | +| `table` | [`Table`](../classes/kui_shell_core.Table.md)<[`Row`](../classes/kui_shell_core.Row.md)\> | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:217](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L217) + +--- + +### isTopLevelTab + +▸ **isTopLevelTab**(`tab`): `boolean` + +#### Parameters + +| Name | Type | +| :---- | :-------------------------------------------------------------- | +| `tab` | `Pick`<[`Tab`](../interfaces/kui_shell_core.Tab.md), `"uuid"`\> | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/webapp/tab.ts:69](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L69) + +--- + +### isUsageError + +▸ **isUsageError**(`error`): error is UsageErrorLike + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `error` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> \| `UsageErrorLike` | + +#### Returns + +error is UsageErrorLike + +#### Defined in + +[packages/core/src/core/usage-error.ts:935](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage-error.ts#L935) + +--- + +### isViewButton + +▸ **isViewButton**<`T`\>(`button`): button is ViewButton + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------- | +| `T` | [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\> | + +#### Parameters + +| Name | Type | +| :------- | :----------------------------------------- | +| `button` | [`Button`](kui_shell_core.md#button)<`T`\> | + +#### Returns + +button is ViewButton + +#### Defined in + +[packages/core/src/models/mmr/types.ts:138](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/mmr/types.ts#L138) + +--- + +### isWatchable + +▸ **isWatchable**(`model`): model is string & Watchable & number & Watchable & false & Watchable & true & Watchable & HTMLElement & Watchable & Error & Watchable & MarkdownResponse & Watchable & ReactResponse & Watchable & MixedResponse & Watchable & CommentaryResponse & Watchable & TabLayoutModificationResponse & Watchable & XtermResponse & Watchable & StatusModel & Watchable & RandomErrorResponse1 & Watchable & RandomErrorResponse2 & Watchable & Table & Partial & Watchable & Abortable & Object & Watchable & ResourceWithMetadata & Watchable & ResourceWithMetadata & View\> & Watchable & NavResponse & Watchable & RadioTable & Watchable & UsageModel & Watchable & RawResponse & Watchable & ResourceWithMetadata[] & Watchable + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `model` | `string` & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & `number` & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & `false` & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & `true` & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & `HTMLElement` & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & `Error` & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & `MarkdownResponse` & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`ReactResponse`](kui_shell_core.md#reactresponse) & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`MixedResponse`](kui_shell_core.md#mixedresponse) & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`CommentaryResponse`](kui_shell_core.md#commentaryresponse) & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`TabLayoutModificationResponse`](kui_shell_core.md#tablayoutmodificationresponse)<[`NewSplitRequest`](kui_shell_core.md#newsplitrequest)\> & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`XtermResponse`](../interfaces/kui_shell_core.XtermResponse.md) & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`StatusModel`](../interfaces/kui_shell_core.StatusModel.md) & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & `RandomErrorResponse1` & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & `RandomErrorResponse2` & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`Table`](../classes/kui_shell_core.Table.md)<[`Row`](../classes/kui_shell_core.Row.md)\> & `Partial`<[`WithSourceReferences`](../interfaces/kui_shell_core.WithSourceReferences.md)\> & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`Abortable`](../interfaces/kui_shell_core.Abortable.md) & { `response`: [`ScalarResponse`](kui_shell_core.md#scalarresponse)<[`Row`](../classes/kui_shell_core.Row.md)\> } & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\> & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\> & `View`<[`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`NavResponse`](kui_shell_core.md#navresponse) & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`RadioTable`](../interfaces/kui_shell_core.RadioTable.md) & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`UsageModel`](../interfaces/kui_shell_core.UsageModel.md) & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`RawResponse`](../interfaces/kui_shell_core.RawResponse.md)<`void`\> & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> & [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>[] & `Partial`<[`Watchable`](../interfaces/kui_shell_core.Watchable.md)\> | + +#### Returns + +model is string & Watchable & number & Watchable & false & Watchable & true & Watchable & HTMLElement & Watchable & Error & Watchable & MarkdownResponse & Watchable & ReactResponse & Watchable & MixedResponse & Watchable & CommentaryResponse & Watchable & TabLayoutModificationResponse & Watchable & XtermResponse & Watchable & StatusModel & Watchable & RandomErrorResponse1 & Watchable & RandomErrorResponse2 & Watchable & Table & Partial & Watchable & Abortable & Object & Watchable & ResourceWithMetadata & Watchable & ResourceWithMetadata & View\> & Watchable & NavResponse & Watchable & RadioTable & Watchable & UsageModel & Watchable & RawResponse & Watchable & ResourceWithMetadata[] & Watchable + +#### Defined in + +[packages/core/src/core/jobs/watchable.ts:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/jobs/watchable.ts#L70) + +--- + +### isXtermErrorResponse + +▸ **isXtermErrorResponse**(`entity`): `boolean` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/models/XtermResponse.ts:38](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/XtermResponse.ts#L38) + +--- + +### isXtermResponse + +▸ **isXtermResponse**(`entity`): entity is XtermResponse + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +entity is XtermResponse + +#### Defined in + +[packages/core/src/models/XtermResponse.ts:33](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/XtermResponse.ts#L33) + +--- + +### maybeKuiLink + +▸ **maybeKuiLink**(`link`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `link` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/models/CommentaryResponse.ts:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/CommentaryResponse.ts#L49) + +--- + +### offQuit + +▸ **offQuit**(`handler`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :----------- | +| `handler` | () => `void` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/api/window-events.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/api/window-events.ts#L47) + +--- + +### onQuit + +▸ **onQuit**(`handler`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :----------- | +| `handler` | () => `void` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/api/window-events.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/api/window-events.ts#L39) + +--- + +### pexecInCurrentTab + +▸ **pexecInCurrentTab**(`command`, `topLevelTab?`, `isInternalCallpath?`, `incognito?`): `Promise`<[`KResponse`](kui_shell_core.md#kresponse)<`any`\>\> + +Execute the given command in the current (or given) tab. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------- | :------------------------------------------- | :------------ | :------------------------------------------------------------------------ | +| `command` | `string` | `undefined` | - | +| `topLevelTab?` | [`Tab`](../interfaces/kui_shell_core.Tab.md) | `undefined` | - | +| `isInternalCallpath` | `boolean` | `false` | - | +| `incognito` | `boolean` | `false` | Execute the command quietly but do not display the result in the Terminal | + +#### Returns + +`Promise`<[`KResponse`](kui_shell_core.md#kresponse)<`any`\>\> + +#### Defined in + +[packages/core/src/webapp/tab.ts:124](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L124) + +--- + +### pluginUserHome + +▸ `Const` **pluginUserHome**(): `Promise`<`string`\> + +Home for user-installed plugins + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/core/src/api/plugins.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/api/plugins.ts#L55) + +--- + +### prettyPrintBytes + +▸ **prettyPrintBytes**(`_bytes`): `string` + +#### Parameters + +| Name | Type | +| :------- | :------------------- | +| `_bytes` | `string` \| `number` | + +#### Returns + +`string` + +pretty-printed bytes + +#### Defined in + +[packages/core/src/webapp/util/bytes.ts:18](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/util/bytes.ts#L18) + +--- + +### prettyPrintTime + +▸ `Const` **prettyPrintTime**(`timestamp`, `fmt?`, `previousTimestamp?`, `execOptions?`): `HTMLElement` + +Pretty print a timestamp + +#### Parameters + +| Name | Type | Default value | +| :------------------- | :----------------------------------------------- | :------------ | +| `timestamp` | `string` \| `number` \| `Date` | `undefined` | +| `fmt` | `"delta"` \| `"long"` \| `"short"` \| `"narrow"` | `'long'` | +| `previousTimestamp?` | `string` \| `number` \| `Date` | `undefined` | +| `execOptions` | `LanguageBearing` | `undefined` | + +#### Returns + +`HTMLElement` + +#### Defined in + +[packages/core/src/webapp/util/time.ts:36](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/util/time.ts#L36) + +--- + +### promiseEach + +▸ **promiseEach**<`T`, `R`\>(`arr`, `fn`): `Promise`<`R`[]\> + +Map a asynchronous function to an array sequentially from front to +back. + +#### Type parameters + +| Name | +| :--- | +| `T` | +| `R` | + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------- | +| `arr` | `T`[] | +| `fn` | (`t`: `T`, `idx`: `number`) => `R` \| `Promise`<`R`\> | + +#### Returns + +`Promise`<`R`[]\> + +#### Defined in + +[packages/core/src/util/async.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/async.ts#L22) + +--- + +### radioTableAddHint + +▸ **radioTableAddHint**(`row`, `cidx`, `newHints`): `void` + +Add the hint to the given RadioTableCell + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------------------------------------------- | +| `row` | [`RadioTableRow`](../interfaces/kui_shell_core.RadioTableRow.md) | +| `cidx` | `number` | +| `newHints` | [`CellShould`](../enums/kui_shell_core.CellShould.md)[] | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/RadioTable.ts:68](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L68) + +--- + +### radioTableCellToString + +▸ **radioTableCellToString**(`cell`, `useTitle?`): `string` + +Project the string value of the given `cell` + +#### Parameters + +| Name | Type | Default value | +| :--------- | :--------------------------------------------------- | :------------ | +| `cell` | [`RadioTableCell`](kui_shell_core.md#radiotablecell) | `undefined` | +| `useTitle` | `boolean` | `false` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/models/RadioTable.ts:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L58) + +--- + +### radioTableHintsAsCss + +▸ **radioTableHintsAsCss**(`cell`): `string` + +#### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------- | +| `cell` | [`RadioTableCell`](kui_shell_core.md#radiotablecell) | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/models/RadioTable.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/RadioTable.ts#L47) + +--- + +### registerBadge + +▸ **registerBadge**<`Resource`\>(`registration`): `void` + +Register a new badge + +#### Type parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`, `Resource`\> | + +#### Parameters + +| Name | Type | +| :------------- | :------------------------------------------------------------------------------------ | +| `registration` | [`BadgeRegistration`](../interfaces/kui_shell_core.BadgeRegistration.md)<`Resource`\> | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/views/registrar/badges.ts:54](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/badges.ts#L54) + +--- + +### registerMode + +▸ **registerMode**<`Resource`\>(`registration`): `void` + +Register a new mode + +#### Type parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`, `Resource`\> | + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------------------------------------------- | +| `registration` | [`ModeRegistration`](../interfaces/kui_shell_core.ModeRegistration.md)<`Resource`\> | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/views/registrar/modes.ts:50](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/modes.ts#L50) + +--- + +### registerModeWhen + +▸ `Const` **registerModeWhen**<`Resource`\>(`when`): (`mode`: [`ModeDeclaration`](kui_shell_core.md#modedeclaration)<`Resource`\>) => `void` + +#### Type parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------------------------------------------------- | +| `Resource` | extends [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`, `Resource`\> | + +#### Parameters + +| Name | Type | +| :----- | :-------------------------------------------------------- | +| `when` | [`ModeFilter`](kui_shell_core.md#modefilter)<`Resource`\> | + +#### Returns + +`fn` + +▸ (`mode`): `void` + +##### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------ | +| `mode` | [`ModeDeclaration`](kui_shell_core.md#modedeclaration)<`Resource`\> | + +##### Returns + +`void` + +#### Defined in + +[packages/core/src/webapp/views/registrar/modes.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/views/registrar/modes.ts#L55) + +--- + +### registerTabCompletionEnumerator + +▸ **registerTabCompletionEnumerator**(`enumerator`, `priority?`): `void` + +A plugin has offered a tab completion Enumerator + +#### Parameters + +| Name | Type | Default value | +| :----------- | :----------- | :------------ | +| `enumerator` | `Enumerator` | `undefined` | +| `priority` | `number` | `0` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/repl/tab-completion.ts:60](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/tab-completion.ts#L60) + +--- + +### registerTabState + +▸ **registerTabState**(`registration`): `void` + +#### Parameters + +| Name | Type | +| :------------- | :--------------------- | +| `registration` | `TabStateRegistration` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/models/tab-state.ts:38](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/tab-state.ts#L38) + +--- + +### renderUsage + +▸ **renderUsage**(`_`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------------------------------------------------------- | +| `_` | [`PrettyUsageModel`](kui_shell_core.md#prettyusagemodel) | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/usage/render-usage.ts:20](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage/render-usage.ts#L20) + +--- + +### resetToDefaultTheme + +▸ `Const` **resetToDefaultTheme**(): `Promise`<`boolean`\> + +Reset to the default theme + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/core/src/webapp/themes/persistence.ts:188](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/themes/persistence.ts#L188) + +--- + +### sameRow + +▸ **sameRow**(`A`, `B`): `boolean` + +Are the two Rows the same? + +#### Parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `A` | [`Row`](../classes/kui_shell_core.Row.md) | +| `B` | [`Row`](../classes/kui_shell_core.Row.md) | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/webapp/models/table.ts:238](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/models/table.ts#L238) + +--- + +### sameTab + +▸ `Const` **sameTab**(`tab1`, `tab2`): `boolean` + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------- | +| `tab1` | [`Tab`](../interfaces/kui_shell_core.Tab.md) | +| `tab2` | [`Tab`](../interfaces/kui_shell_core.Tab.md) | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/webapp/tab.ts:73](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L73) + +--- + +### setEvaluatorImpl + +▸ `Const` **setEvaluatorImpl**(`impl`): `void` + +#### Parameters + +| Name | Type | +| :----- | :----------------------------------------------------- | +| `impl` | [`ReplEval`](../interfaces/kui_shell_core.ReplEval.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/repl/exec.ts:74](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/exec.ts#L74) + +--- + +### setHasAuth + +▸ `Const` **setHasAuth**(`provider`, `creds`): `void` + +Yes, we have valid credentials to interface with the given +provider + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `provider` | `string` | +| `creds` | `object` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/core/capabilities.ts:138](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/capabilities.ts#L138) + +--- + +### setPreference + +▸ `Const` **setPreference**(`key`, `value`): `Promise`<`string`\> + +Set a persisted preference + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `key` | `string` | +| `value` | `string` | + +#### Returns + +`Promise`<`string`\> + +the preference value + +#### Defined in + +[packages/core/src/core/userdata.ts:179](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/userdata.ts#L179) + +--- + +### split + +▸ `Const` **split**(`str`, `removeOuterQuotes?`, `removeInlineOuterQuotes?`, `splitBy?`, `startIdx?`, `endIdx?`): `string`[] + +#### Parameters + +| Name | Type | Default value | +| :------------------------ | :-------- | :------------ | +| `str` | `string` | `undefined` | +| `removeOuterQuotes` | `boolean` | `true` | +| `removeInlineOuterQuotes` | `boolean` | `false` | +| `splitBy?` | `string` | `undefined` | +| `startIdx` | `number` | `0` | +| `endIdx` | `number` | `str.length` | + +#### Returns + +`string`[] + +#### Defined in + +[packages/core/src/repl/split.ts:193](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/split.ts#L193) + +--- + +### splitFor + +▸ **splitFor**(`topLevelTab`): [`Tab`](../interfaces/kui_shell_core.Tab.md) + +We need to find the instance of the Split that has a REPL controller + +- if given a `topLevelTab` that is already a Split, then we're "good to go" +- if we are given an actual top-level tab (i.e. not a split), then we need to find the first Split child of that given tab +- if we aren't given a tab as input, then we search from `document` + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------- | +| `topLevelTab` | [`Tab`](../interfaces/kui_shell_core.Tab.md) | + +#### Returns + +[`Tab`](../interfaces/kui_shell_core.Tab.md) + +#### Defined in + +[packages/core/src/webapp/tab.ts:104](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/tab.ts#L104) + +--- + +### splitIntoPipeStages + +▸ **splitIntoPipeStages**(`command`): [`CommandLine`](../interfaces/kui_shell_core.CommandLine.md)[``"pipeStages"``] + +Split a given `command` line into the stages of the pipeline + +e.g. if command=`a -- b c|d > e`, then +pipeStages=`{ prefix: 'a', stages: [['b','c'],'d'], redirect: 'e' }` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `command` | `string` | + +#### Returns + +[`CommandLine`](../interfaces/kui_shell_core.CommandLine.md)[``"pipeStages"``] + +#### Defined in + +[packages/core/src/repl/pipe-stages.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/repl/pipe-stages.ts#L27) + +--- + +### switchToTheme + +▸ `Const` **switchToTheme**(`theme`, `saveNotNeeded?`): `Promise`<`void`\> + +Internal logic to switch themes + +#### Parameters + +| Name | Type | Default value | +| :-------------- | :-------- | :------------ | +| `theme` | `string` | `undefined` | +| `saveNotNeeded` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/webapp/themes/persistence.ts:71](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/themes/persistence.ts#L71) + +--- + +### teeToFile + +▸ **teeToFile**(`response`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `response` | `Entity`<`void`, [`Row`](../classes/kui_shell_core.Row.md), [`ResourceWithMetadata`](../interfaces/kui_shell_core.ResourceWithMetadata.md)<`void`\>\> | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/util/tee.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/util/tee.ts#L21) + +--- + +### tellMain + +▸ `Const` **tellMain**(`message`, `channel?`): `Promise`<`unknown`\> + +Send a synchronous message to the main process + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------------------------- | +| `message` | `string` \| `Record`<`string`, `any`\> | +| `channel?` | `"asynchronous-message"` \| `"synchronous-message"` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[packages/core/src/webapp/electron-events.ts:64](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/webapp/electron-events.ts#L64) + +--- + +### typeahead + +▸ **typeahead**(`prefix`): `string`[] + +Typeahead find lookup + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `prefix` | `string` | + +#### Returns + +`string`[] + +list of matches + +#### Defined in + +[packages/core/src/commands/typeahead.ts:86](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/commands/typeahead.ts#L86) + +--- + +### uiThemes + +▸ **uiThemes**(): `Promise`<`ThemeSet`[]\> + +#### Returns + +`Promise`<`ThemeSet`[]\> + +#### Defined in + +[packages/core/src/core/settings.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/settings.ts#L21) + +--- + +### unparse + +▸ `Const` **unparse**(`options`): `string` + +Turn an options struct into a cli string + +#### Parameters + +| Name | Type | Description | +| :-------- | :--------------------------------------------------------------- | :---------------------------------------------------- | +| `options` | [`ParsedOptions`](../interfaces/kui_shell_core.ParsedOptions.md) | is the command line options struct given by the user. | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/utility.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/utility.ts#L26) + +--- + +### userDataDir + +▸ `Const` **userDataDir**(): `string` + +Get the userdata directory + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/userdata.ts:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/userdata.ts#L34) + +--- + +### withLanguage + +▸ **withLanguage**(`execOptions`): `LanguageBearing` + +#### Parameters + +| Name | Type | +| :------------ | :----------------------------------------------------------- | +| `execOptions` | [`ExecOptions`](../interfaces/kui_shell_core.ExecOptions.md) | + +#### Returns + +`LanguageBearing` + +#### Defined in + +[packages/core/src/models/execOptions.ts:120](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/models/execOptions.ts#L120) diff --git a/docs/api/modules/kui_shell_core.pc.md b/docs/api/modules/kui_shell_core.pc.md new file mode 100644 index 00000000000..8e55af6fe23 --- /dev/null +++ b/docs/api/modules/kui_shell_core.pc.md @@ -0,0 +1,202 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/core](kui_shell_core.md) / pc + +# Namespace: pc + +[@kui-shell/core](kui_shell_core.md).pc + +## Table of contents + +### Functions + +- [command](kui_shell_core.pc.md#command) +- [examples](kui_shell_core.pc.md#examples) +- [intro](kui_shell_core.pc.md#intro) +- [option](kui_shell_core.pc.md#option) +- [options](kui_shell_core.pc.md#options) +- [pipeline](kui_shell_core.pc.md#pipeline) +- [related](kui_shell_core.pc.md#related) +- [title](kui_shell_core.pc.md#title) +- [usage](kui_shell_core.pc.md#usage) + +## Functions + +### command + +▸ **command**(`cmdline`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `cmdline` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/usage/pretty-code.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage/pretty-code.ts#L23) + +--- + +### examples + +▸ **examples**(`examples`, `sectionTitle?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :---------- | :------------ | +| `examples` | `Example`[] | `undefined` | +| `sectionTitle` | `string` | `'Examples'` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/usage/pretty-code.ts:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage/pretty-code.ts#L70) + +--- + +### intro + +▸ **intro**(`paragraph`): `string` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `paragraph` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/usage/pretty-code.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage/pretty-code.ts#L27) + +--- + +### option + +▸ **option**(`opts`): `string` + +#### Parameters + +| Name | Type | +| :----- | :--------------------- | +| `opts` | `string` \| `string`[] | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/usage/pretty-code.ts:31](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage/pretty-code.ts#L31) + +--- + +### options + +▸ **options**(`options`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :--------- | +| `options` | `Option`[] | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/usage/pretty-code.ts:87](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage/pretty-code.ts#L87) + +--- + +### pipeline + +▸ **pipeline**(`code`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `code` | `string` | + +#### Returns + +`string` + +pretty-printed version of the given bash pipeline + +#### Defined in + +[packages/core/src/core/usage/pretty-code.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage/pretty-code.ts#L43) + +--- + +### related + +▸ **related**(`related`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :--------- | +| `related` | `string`[] | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/usage/pretty-code.ts:81](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage/pretty-code.ts#L81) + +--- + +### title + +▸ **title**(`_`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------ | +| `_` | `Title` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/usage/pretty-code.ts:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage/pretty-code.ts#L37) + +--- + +### usage + +▸ **usage**(`usages`): `string` + +#### Parameters + +| Name | Type | +| :------- | :--------- | +| `usages` | `string`[] | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/core/usage/pretty-code.ts:60](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/core/src/core/usage/pretty-code.ts#L60) diff --git a/docs/api/modules/kui_shell_plugin_bash_like.md b/docs/api/modules/kui_shell_plugin_bash_like.md new file mode 100644 index 00000000000..54d81daa644 --- /dev/null +++ b/docs/api/modules/kui_shell_plugin_bash_like.md @@ -0,0 +1,133 @@ +[Kui API Documentation - v10.8.0](../README.md) / @kui-shell/plugin-bash-like + +# Module: @kui-shell/plugin-bash-like + +## Table of contents + +### Classes + +- [StdioChannelWebsocketSide](../classes/kui_shell_plugin_bash_like.StdioChannelWebsocketSide.md) + +### Functions + +- [doExecWithPty](kui_shell_plugin_bash_like.md#doexecwithpty) +- [doExecWithStdoutViaPty](kui_shell_plugin_bash_like.md#doexecwithstdoutviapty) +- [getSessionForTab](kui_shell_plugin_bash_like.md#getsessionfortab) +- [getTabState](kui_shell_plugin_bash_like.md#gettabstate) +- [main](kui_shell_plugin_bash_like.md#main) + +## Functions + +### doExecWithPty + +▸ `Const` **doExecWithPty**(`__namedParameters`): `Promise`<`any`\> + +Command handler that dispatches to an outer shell + +#### Parameters + +| Name | Type | +| :------------------ | :-------------------------------- | +| `__namedParameters` | `EvaluatorArgs`<`ParsedOptions`\> | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[plugins/plugin-bash-like/src/lib/cmds/catchall.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/lib/cmds/catchall.ts#L26) + +--- + +### doExecWithStdoutViaPty + +▸ **doExecWithStdoutViaPty**<`O`\>(`args`): `Promise`<`string`\> + +Execute the given command using a pty, but return a string + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------- | +| `O` | extends ` ParsedOptions``ParsedOptions ` | + +#### Parameters + +| Name | Type | +| :----- | :-------------------- | +| `args` | `EvaluatorArgs`<`O`\> | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[plugins/plugin-bash-like/src/lib/cmds/catchall.ts:103](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/lib/cmds/catchall.ts#L103) + +--- + +### getSessionForTab + +▸ **getSessionForTab**(`tab`): `Promise`<`Channel`\> + +Return the session for the given tab + +#### Parameters + +| Name | Type | +| :---- | :---- | +| `tab` | `Tab` | + +#### Returns + +`Promise`<`Channel`\> + +#### Defined in + +[plugins/plugin-bash-like/src/pty/sessionCache.ts:38](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/pty/sessionCache.ts#L38) + +--- + +### getTabState + +▸ **getTabState**(`tab`, `key`): `any` + +#### Parameters + +| Name | Type | +| :---- | :-------- | +| `tab` | `default` | +| `key` | `string` | + +#### Returns + +`any` + +#### Defined in + +[plugins/plugin-bash-like/src/tab-state/get.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/tab-state/get.ts#L21) + +--- + +### main + +▸ `Const` **main**(`N`, `server?`, `preexistingPort?`, `expectedCookie?`): `Promise`<`number` \| { `port`: `number` ; `wss`: `Server` }\> + +#### Parameters + +| Name | Type | +| :----------------- | :-------------- | +| `N` | `string` | +| `server?` | `Server` | +| `preexistingPort?` | `number` | +| `expectedCookie?` | `SessionCookie` | + +#### Returns + +`Promise`<`number` \| { `port`: `number` ; `wss`: `Server` }\> + +#### Defined in + +[plugins/plugin-bash-like/src/pty/server.ts:509](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-bash-like/src/pty/server.ts#L509) diff --git a/docs/api/modules/kui_shell_plugin_client_common.md b/docs/api/modules/kui_shell_plugin_client_common.md new file mode 100644 index 00000000000..893a4615cc9 --- /dev/null +++ b/docs/api/modules/kui_shell_plugin_client_common.md @@ -0,0 +1,412 @@ +[Kui API Documentation - v10.8.0](../README.md) / @kui-shell/plugin-client-common + +# Module: @kui-shell/plugin-client-common + +## Table of contents + +### Classes + +- [ContextWidgets](../classes/kui_shell_plugin_client_common.ContextWidgets.md) +- [CurrentWorkingDirectory](../classes/kui_shell_plugin_client_common.CurrentWorkingDirectory.md) +- [FancyPipeline](../classes/kui_shell_plugin_client_common.FancyPipeline.md) +- [HTMLDom](../classes/kui_shell_plugin_client_common.HTMLDom.md) +- [InputProvider](../classes/kui_shell_plugin_client_common.InputProvider.md) +- [Kui](../classes/kui_shell_plugin_client_common.Kui.md) +- [MeterWidgets](../classes/kui_shell_plugin_client_common.MeterWidgets.md) +- [Settings](../classes/kui_shell_plugin_client_common.Settings.md) +- [StatusStripe](../classes/kui_shell_plugin_client_common.StatusStripe.md) +- [StatusVisualizer](../classes/kui_shell_plugin_client_common.StatusVisualizer.md) +- [TabContainer](../classes/kui_shell_plugin_client_common.TabContainer.md) +- [TabContent](../classes/kui_shell_plugin_client_common.TabContent.md) +- [TabModel](../classes/kui_shell_plugin_client_common.TabModel.md) +- [TextWithIconWidget](../classes/kui_shell_plugin_client_common.TextWithIconWidget.md) + +### Interfaces + +- [DropDownAction](../interfaces/kui_shell_plugin_client_common.DropDownAction.md) +- [InputProviderState](../interfaces/kui_shell_plugin_client_common.InputProviderState.md) +- [TextWithIconWidgetOptions](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetOptions.md) +- [TextWithIconWidgetProps](../interfaces/kui_shell_plugin_client_common.TextWithIconWidgetProps.md) + +### Type aliases + +- [InputProviderProps](kui_shell_plugin_client_common.md#inputproviderprops) +- [KuiProps](kui_shell_plugin_client_common.md#kuiprops) +- [SplitPosition](kui_shell_plugin_client_common.md#splitposition) +- [ViewLevel](kui_shell_plugin_client_common.md#viewlevel) + +### Properties + +- [KuiContext](kui_shell_plugin_client_common.md#kuicontext) + +### Variables + +- [Alert](kui_shell_plugin_client_common.md#alert) +- [Ansi](kui_shell_plugin_client_common.md#ansi) +- [Button](kui_shell_plugin_client_common.md#button) +- [Card](kui_shell_plugin_client_common.md#card) +- [DropDown](kui_shell_plugin_client_common.md#dropdown) +- [Icons](kui_shell_plugin_client_common.md#icons) +- [LeftNavSidecar](kui_shell_plugin_client_common.md#leftnavsidecar) +- [Markdown](kui_shell_plugin_client_common.md#markdown) +- [Popover](kui_shell_plugin_client_common.md#popover) +- [Select](kui_shell_plugin_client_common.md#select) +- [Tag](kui_shell_plugin_client_common.md#tag) +- [TagWidget](kui_shell_plugin_client_common.md#tagwidget) +- [TopNavSidecar](kui_shell_plugin_client_common.md#topnavsidecar) + +### Functions + +- [DropdownWidget](kui_shell_plugin_client_common.md#dropdownwidget) +- [Loading](kui_shell_plugin_client_common.md#loading) +- [SpaceFiller](kui_shell_plugin_client_common.md#spacefiller) +- [Tooltip](kui_shell_plugin_client_common.md#tooltip) +- [allocateTabUUID](kui_shell_plugin_client_common.md#allocatetabuuid) +- [defaultOnKeyDown](kui_shell_plugin_client_common.md#defaultonkeydown) +- [defaultOnKeyPress](kui_shell_plugin_client_common.md#defaultonkeypress) +- [defaultOnKeyUp](kui_shell_plugin_client_common.md#defaultonkeyup) +- [inDebugMode](kui_shell_plugin_client_common.md#indebugmode) + +## Type aliases + +### InputProviderProps + +Ƭ **InputProviderProps**: `InputOptions` & `InputProps` & `BlockViewTraits` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:161](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx#L161) + +--- + +### KuiProps + +Ƭ **KuiProps**: `Partial`<`KuiConfiguration`\> & `CommonClientProps` & { `bottomInput?`: `true` \| `React.ReactNode` ; `initialTabTitle?`: `string` ; `noBootstrap?`: `boolean` ; `quietExecCommand?`: `boolean` ; `toplevel?`: `React.ReactNode` \| `React.ReactNode`[] } + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/Kui.tsx:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/Kui.tsx#L55) + +--- + +### SplitPosition + +Ƭ **SplitPosition**: `NewSplitRequest`[`"options"`][``"position"``] + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/SplitPosition.ts:19](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/SplitPosition.ts#L19) + +--- + +### ViewLevel + +Ƭ **ViewLevel**: `"loading"` \| `"removed"` \| `"hidden"` \| `"normal"` \| `"obscured"` \| `"ok"` \| `"warn"` \| `"error"` \| `"info"` + +variants of how the information should be presented + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx#L24) + +## Properties + +### KuiContext + +• **KuiContext**: `Context`<`KuiConfiguration`\> + +## Variables + +### Alert + +• **Alert**: `LazyExoticComponent`<`fn`\> + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:65](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L65) + +--- + +### Ansi + +• **Ansi**: `LazyExoticComponent`<`fn`\> + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L55) + +--- + +### Button + +• **Button**: `LazyExoticComponent`<`fn`\> + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:66](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L66) + +--- + +### Card + +• **Card**: `LazyExoticComponent`<`fn`\> + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:67](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L67) + +--- + +### DropDown + +• **DropDown**: `LazyExoticComponent`<`fn`\> + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:72](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L72) + +--- + +### Icons + +• **Icons**: `LazyExoticComponent`<`fn`\> + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:71](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L71) + +--- + +### LeftNavSidecar + +• **LeftNavSidecar**: `LazyExoticComponent` + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:62](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L62) + +--- + +### Markdown + +• **Markdown**: `LazyExoticComponent` + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:57](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L57) + +--- + +### Popover + +• **Popover**: `LazyExoticComponent`<`fn`\> + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:68](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L68) + +--- + +### Select + +• **Select**: `LazyExoticComponent`<`fn`\> + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:69](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L69) + +--- + +### Tag + +• **Tag**: `LazyExoticComponent`<`fn`\> + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L70) + +--- + +### TagWidget + +• **TagWidget**: `LazyExoticComponent`<`fn`\> + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L49) + +--- + +### TopNavSidecar + +• **TopNavSidecar**: `LazyExoticComponent` + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:61](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L61) + +## Functions + +### DropdownWidget + +▸ **DropdownWidget**(`props`): `Element` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/DropdownWidget.tsx:33](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/DropdownWidget.tsx#L33) + +--- + +### Loading + +▸ **Loading**(`props`): `React.ReactElement` + +#### Parameters + +| Name | Type | +| :------ | :-------- | +| `props` | `default` | + +#### Returns + +`React.ReactElement` + +#### Defined in + +[plugins/plugin-client-common/src/components/spi/Loading/index.tsx:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/spi/Loading/index.tsx#L22) + +--- + +### SpaceFiller + +▸ **SpaceFiller**(): `Element` + +This components can be used as a space filler in your StatusStripe. + +#### Returns + +`Element` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/StatusStripe/SpaceFiller.tsx:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/StatusStripe/SpaceFiller.tsx#L23) + +--- + +### Tooltip + +▸ **Tooltip**(`props`): `React.ReactElement` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `props` | `Props` | + +#### Returns + +`React.ReactElement` + +#### Defined in + +[plugins/plugin-client-common/src/components/spi/Tooltip/index.tsx:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/spi/Tooltip/index.tsx#L24) + +--- + +### allocateTabUUID + +▸ **allocateTabUUID**(): `string` + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-client-common/src/components/Client/TabModel.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Client/TabModel.ts#L21) + +--- + +### defaultOnKeyDown + +▸ **defaultOnKeyDown**(`event`): `void` + +#### Parameters + +| Name | Type | +| :------ | :-------------- | +| `event` | `KeyboardEvent` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/OnKeyDown.ts:98](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/OnKeyDown.ts#L98) + +--- + +### defaultOnKeyPress + +▸ **defaultOnKeyPress**(`event`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :-------------- | +| `event` | `KeyboardEvent` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/OnKeyPress.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/OnKeyPress.ts#L21) + +--- + +### defaultOnKeyUp + +▸ **defaultOnKeyUp**(`evt`): `Promise`<`void`\> + +Listen for ctrl+R + +#### Parameters + +| Name | Type | +| :---- | :-------------------------- | +| `evt` | `KeyboardEvent`<`Element`\> | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[plugins/plugin-client-common/src/components/Views/Terminal/Block/ActiveISearch.tsx:181](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/components/Views/Terminal/Block/ActiveISearch.tsx#L181) + +--- + +### inDebugMode + +▸ **inDebugMode**(): `string` \| `true` + +#### Returns + +`string` \| `true` + +#### Defined in + +[plugins/plugin-client-common/src/index.ts:88](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-client-common/src/index.ts#L88) diff --git a/docs/api/modules/kui_shell_plugin_core_support.md b/docs/api/modules/kui_shell_plugin_core_support.md new file mode 100644 index 00000000000..5869a545669 --- /dev/null +++ b/docs/api/modules/kui_shell_plugin_core_support.md @@ -0,0 +1,23 @@ +[Kui API Documentation - v10.8.0](../README.md) / @kui-shell/plugin-core-support + +# Module: @kui-shell/plugin-core-support + +## Table of contents + +### Classes + +- [NotebookVFS](../classes/kui_shell_plugin_core_support.NotebookVFS.md) + +### Variables + +- [notebookVFS](kui_shell_plugin_core_support.md#notebookvfs) + +## Variables + +### notebookVFS + +• **notebookVFS**: [`NotebookVFS`](../classes/kui_shell_plugin_core_support.NotebookVFS.md) + +#### Defined in + +[plugins/plugin-core-support/src/notebooks/vfs/index.ts:311](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-core-support/src/notebooks/vfs/index.ts#L311) diff --git a/docs/api/modules/kui_shell_plugin_electron_components.md b/docs/api/modules/kui_shell_plugin_electron_components.md new file mode 100644 index 00000000000..8266657044b --- /dev/null +++ b/docs/api/modules/kui_shell_plugin_electron_components.md @@ -0,0 +1,11 @@ +[Kui API Documentation - v10.8.0](../README.md) / @kui-shell/plugin-electron-components + +# Module: @kui-shell/plugin-electron-components + +## Table of contents + +### Classes + +- [Screenshot](../classes/kui_shell_plugin_electron_components.Screenshot.md) +- [Search](../classes/kui_shell_plugin_electron_components.Search.md) +- [UpdateChecker](../classes/kui_shell_plugin_electron_components.UpdateChecker.md) diff --git a/docs/api/modules/kui_shell_plugin_git.md b/docs/api/modules/kui_shell_plugin_git.md new file mode 100644 index 00000000000..a47369b0f86 --- /dev/null +++ b/docs/api/modules/kui_shell_plugin_git.md @@ -0,0 +1,9 @@ +[Kui API Documentation - v10.8.0](../README.md) / @kui-shell/plugin-git + +# Module: @kui-shell/plugin-git + +## Table of contents + +### Classes + +- [CurrentGitBranch](../classes/kui_shell_plugin_git.CurrentGitBranch.md) diff --git a/docs/api/modules/kui_shell_plugin_kubectl.md b/docs/api/modules/kui_shell_plugin_kubectl.md new file mode 100644 index 00000000000..4a30f00afae --- /dev/null +++ b/docs/api/modules/kui_shell_plugin_kubectl.md @@ -0,0 +1,1804 @@ +[Kui API Documentation - v10.8.0](../README.md) / @kui-shell/plugin-kubectl + +# Module: @kui-shell/plugin-kubectl + +## Table of contents + +### Enumerations + +- [TrafficLight](../enums/kui_shell_plugin_kubectl.TrafficLight.md) + +### Interfaces + +- [InvolvedObject](../interfaces/kui_shell_plugin_kubectl.InvolvedObject.md) +- [Job](../interfaces/kui_shell_plugin_kubectl.Job.md) +- [KubeContext](../interfaces/kui_shell_plugin_kubectl.KubeContext.md) +- [KubeItems](../interfaces/kui_shell_plugin_kubectl.KubeItems.md) +- [KubeOptions](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) +- [KubeStatus](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md) +- [KubeStatusCondition](../interfaces/kui_shell_plugin_kubectl.KubeStatusCondition.md) +- [Pod](../interfaces/kui_shell_plugin_kubectl.Pod.md) +- [PodLikeSpec](../interfaces/kui_shell_plugin_kubectl.PodLikeSpec.md) +- [PodList](../interfaces/kui_shell_plugin_kubectl.PodList.md) +- [Resource](../interfaces/kui_shell_plugin_kubectl.Resource.md) +- [Secret](../interfaces/kui_shell_plugin_kubectl.Secret.md) +- [WithRawData](../interfaces/kui_shell_plugin_kubectl.WithRawData.md) +- [WithSummary](../interfaces/kui_shell_plugin_kubectl.WithSummary.md) + +### Type aliases + +- [Deployment](kui_shell_plugin_kubectl.md#deployment) +- [KubePartial](kui_shell_plugin_kubectl.md#kubepartial) +- [KubeResource](kui_shell_plugin_kubectl.md#kuberesource) +- [KubeResourceWithSummary](kui_shell_plugin_kubectl.md#kuberesourcewithsummary) + +### Properties + +- [apiVersion](kui_shell_plugin_kubectl.md#apiversion) +- [kubectl](kui_shell_plugin_kubectl.md#kubectl) +- [logsMode](kui_shell_plugin_kubectl.md#logsmode) + +### Variables + +- [Parser](kui_shell_plugin_kubectl.md#parser) +- [defaultFlags](kui_shell_plugin_kubectl.md#defaultflags) + +### Functions + +- [computeDurations](kui_shell_plugin_kubectl.md#computedurations) +- [describer](kui_shell_plugin_kubectl.md#describer) +- [doCreate](kui_shell_plugin_kubectl.md#docreate) +- [doDelete](kui_shell_plugin_kubectl.md#dodelete) +- [doExecRaw](kui_shell_plugin_kubectl.md#doexecraw) +- [doExecWithMarkdown](kui_shell_plugin_kubectl.md#doexecwithmarkdown) +- [doExecWithPty](kui_shell_plugin_kubectl.md#doexecwithpty) +- [doExecWithRadioTable](kui_shell_plugin_kubectl.md#doexecwithradiotable) +- [doExecWithStatus](kui_shell_plugin_kubectl.md#doexecwithstatus) +- [doExecWithStdout](kui_shell_plugin_kubectl.md#doexecwithstdout) +- [doExecWithStdoutViaPty](kui_shell_plugin_kubectl.md#doexecwithstdoutviapty) +- [doExecWithTable](kui_shell_plugin_kubectl.md#doexecwithtable) +- [doGet](kui_shell_plugin_kubectl.md#doget) +- [doHelp](kui_shell_plugin_kubectl.md#dohelp) +- [doNativeExec](kui_shell_plugin_kubectl.md#donativeexec) +- [doRun](kui_shell_plugin_kubectl.md#dorun) +- [emitKubectlConfigChangeEvent](kui_shell_plugin_kubectl.md#emitkubectlconfigchangeevent) +- [fetchFileString](kui_shell_plugin_kubectl.md#fetchfilestring) +- [flags](kui_shell_plugin_kubectl.md#flags) +- [formatTable](kui_shell_plugin_kubectl.md#formattable) +- [fqn](kui_shell_plugin_kubectl.md#fqn) +- [fqnOf](kui_shell_plugin_kubectl.md#fqnof) +- [getAllContexts](kui_shell_plugin_kubectl.md#getallcontexts) +- [getAsMMRTransformer](kui_shell_plugin_kubectl.md#getasmmrtransformer) +- [getCommandFromArgs](kui_shell_plugin_kubectl.md#getcommandfromargs) +- [getContainer](kui_shell_plugin_kubectl.md#getcontainer) +- [getCurrentContext](kui_shell_plugin_kubectl.md#getcurrentcontext) +- [getCurrentContextName](kui_shell_plugin_kubectl.md#getcurrentcontextname) +- [getCurrentDefaultContextName](kui_shell_plugin_kubectl.md#getcurrentdefaultcontextname) +- [getCurrentDefaultNamespace](kui_shell_plugin_kubectl.md#getcurrentdefaultnamespace) +- [getKind](kui_shell_plugin_kubectl.md#getkind) +- [getLabel](kui_shell_plugin_kubectl.md#getlabel) +- [getLabelForArgv](kui_shell_plugin_kubectl.md#getlabelforargv) +- [getNamespace](kui_shell_plugin_kubectl.md#getnamespace) +- [getNamespaceForArgv](kui_shell_plugin_kubectl.md#getnamespaceforargv) +- [getTabState](kui_shell_plugin_kubectl.md#gettabstate) +- [getTransformer](kui_shell_plugin_kubectl.md#gettransformer) +- [getter](kui_shell_plugin_kubectl.md#getter) +- [hasLabel](kui_shell_plugin_kubectl.md#haslabel) +- [isCrudableKubeResource](kui_shell_plugin_kubectl.md#iscrudablekuberesource) +- [isDeployment](kui_shell_plugin_kubectl.md#isdeployment) +- [isForAllNamespaces](kui_shell_plugin_kubectl.md#isforallnamespaces) +- [isHelpRequest](kui_shell_plugin_kubectl.md#ishelprequest) +- [isJob](kui_shell_plugin_kubectl.md#isjob) +- [isKubeItems](kui_shell_plugin_kubectl.md#iskubeitems) +- [isKubeItemsOfKind](kui_shell_plugin_kubectl.md#iskubeitemsofkind) +- [isKubeResource](kui_shell_plugin_kubectl.md#iskuberesource) +- [isPod](kui_shell_plugin_kubectl.md#ispod) +- [isPodList](kui_shell_plugin_kubectl.md#ispodlist) +- [isSecret](kui_shell_plugin_kubectl.md#issecret) +- [isTableRequest](kui_shell_plugin_kubectl.md#istablerequest) +- [isUsage](kui_shell_plugin_kubectl.md#isusage) +- [isWatchRequest](kui_shell_plugin_kubectl.md#iswatchrequest) +- [offKubectlConfigChangeEvents](kui_shell_plugin_kubectl.md#offkubectlconfigchangeevents) +- [onKubectlConfigChangeEvents](kui_shell_plugin_kubectl.md#onkubectlconfigchangeevents) +- [parseName](kui_shell_plugin_kubectl.md#parsename) +- [preprocessTable](kui_shell_plugin_kubectl.md#preprocesstable) +- [registerApplySubcommands](kui_shell_plugin_kubectl.md#registerapplysubcommands) +- [registerConfig](kui_shell_plugin_kubectl.md#registerconfig) +- [registerEdit](kui_shell_plugin_kubectl.md#registeredit) +- [stringToTable](kui_shell_plugin_kubectl.md#stringtotable) +- [watchRequestFrom](kui_shell_plugin_kubectl.md#watchrequestfrom) +- [withHelp](kui_shell_plugin_kubectl.md#withhelp) +- [withKubeconfigFrom](kui_shell_plugin_kubectl.md#withkubeconfigfrom) +- [withNamespaceBreadcrumb](kui_shell_plugin_kubectl.md#withnamespacebreadcrumb) + +## Type aliases + +### Deployment + +Ƭ **Deployment**: `Deployment1` \| `Deployment2` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:421](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L421) + +--- + +### KubePartial + +Ƭ **KubePartial**<`R`\>: `Omit`<`R`, `"apiVersion"` \| `"kind"`\> + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------------------------------------------------------------------------- | +| `R` | extends [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)[`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource) | + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:544](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L544) + +--- + +### KubeResource + +Ƭ **KubeResource**<`Status`, `Metadata`\>: `ResourceWithMetadata` & [`WithRawData`](../interfaces/kui_shell_plugin_kubectl.WithRawData.md) & { `apiVersion`: `string` ; `isKubeResource`: `true` ; `isSimulacrum?`: `boolean` ; `kind`: `string` ; `metadata?`: `Metadata` ; `originatingCommand`: `Arguments`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> ; `spec?`: `any` ; `status?`: `Status` } + +The basic Kubernetes resource + +#### Type parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------- | +| `Status` | [`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md) | +| `Metadata` | `KubeMetadata` | + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:194](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L194) + +--- + +### KubeResourceWithSummary + +Ƭ **KubeResourceWithSummary**<`Status`\>: [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<`Status`\> & [`WithSummary`](../interfaces/kui_shell_plugin_kubectl.WithSummary.md) + +`KubeResourceWithSummary` allows plugins to provide their own +Summary. Otherwise lib/views/modes/summary will try to fetch one +automatically. + +#### Type parameters + +| Name | Type | +| :------- | :------------------------------------------------------------------- | +| `Status` | [`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md) | + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:238](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L238) + +## Properties + +### apiVersion + +• **apiVersion**: `"github.com/kui-shell/plugin-kubectl/v1alpha1"` + +--- + +### kubectl + +• **kubectl**: `string` + +--- + +### logsMode + +• **logsMode**: `"logs"` + +## Variables + +### Parser + +• **Parser**: `Object` + +memory and cpu parsing + +#### Type declaration + +| Name | Type | +| :----------------- | :----------------------------------------------- | +| `cpuFraction` | (`str`: `string`) => `number` | +| `cpuShare` | (`str`: `string`) => `number` | +| `formatAsBytes` | (`mem`: `number`) => `string` | +| `formatAsCpu` | (`cpu`: `number`) => `string` | +| `fractionOfMemory` | (`num`: `string`, `denom`: `string`) => `string` | +| `memShare` | (`str`: `string`) => `number` | +| `reformatAsBytes` | (`mem`: `string`) => `string` | + +#### Defined in + +[plugins/plugin-kubectl/src/lib/util/parse.ts:144](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/util/parse.ts#L144) + +--- + +### defaultFlags + +• **defaultFlags**: `CommandOptions` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/flags.ts:66](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/flags.ts#L66) + +## Functions + +### computeDurations + +▸ **computeDurations**<`T`\>(`table`): `T` + +Turn START and END columns into a DURATION column. + +TODO Kubectl gurus: Is there a way to get this directly from a +jsonpath or go-template? I think so from the latter? + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------- | +| `T` | extends `Table`<`Row`\> \| `KResponse`<`any`\> | + +#### Parameters + +| Name | Type | +| :------ | :--- | +| `table` | `T` | + +#### Returns + +`T` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/view/formatTable.ts:513](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/view/formatTable.ts#L513) + +--- + +### describer + +▸ **describer**(`registrar`, `command`, `cli?`): `void` + +Register a command listener + +#### Parameters + +| Name | Type | Default value | +| :---------- | :----------------- | :------------ | +| `registrar` | `CommandRegistrar` | `undefined` | +| `command` | `string` | `undefined` | +| `cli` | `string` | `command` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/describe.ts:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/describe.ts#L48) + +--- + +### doCreate + +▸ `Const` **doCreate**(`verb`, `command?`): (`args`: `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\>) => `Promise`<`string` \| `number` \| `boolean` \| `HTMLElement` \| `Error` \| `MarkdownResponse` \| `ReactResponse` \| `MixedResponse` \| `CommentaryResponse` \| `TabLayoutModificationResponse`<`NewSplitRequest`\> \| `XtermResponse` \| `default` \| `RandomErrorResponse1` \| `RandomErrorResponse2` \| `Table`<`Row`\> \| `AbortableResponse`<`ScalarResponse`<`Row`\>\> \| `NavResponse` \| `RadioTable` \| `UsageModel` \| `MetadataBearing`<`any`\> \| `RawResponse`<`any`\> \| `MetadataBearing`<`any`\>[]\> + +#### Parameters + +| Name | Type | Default value | +| :-------- | :---------------------- | :------------ | +| `verb` | `"create"` \| `"apply"` | `undefined` | +| `command` | `string` | `'kubectl'` | + +#### Returns + +`fn` + +▸ (`args`): `Promise`<`string` \| `number` \| `boolean` \| `HTMLElement` \| `Error` \| `MarkdownResponse` \| `ReactResponse` \| `MixedResponse` \| `CommentaryResponse` \| `TabLayoutModificationResponse`<`NewSplitRequest`\> \| `XtermResponse` \| `default` \| `RandomErrorResponse1` \| `RandomErrorResponse2` \| `Table`<`Row`\> \| `AbortableResponse`<`ScalarResponse`<`Row`\>\> \| `NavResponse` \| `RadioTable` \| `UsageModel` \| `MetadataBearing`<`any`\> \| `RawResponse`<`any`\> \| `MetadataBearing`<`any`\>[]\> + +##### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | + +##### Returns + +`Promise`<`string` \| `number` \| `boolean` \| `HTMLElement` \| `Error` \| `MarkdownResponse` \| `ReactResponse` \| `MixedResponse` \| `CommentaryResponse` \| `TabLayoutModificationResponse`<`NewSplitRequest`\> \| `XtermResponse` \| `default` \| `RandomErrorResponse1` \| `RandomErrorResponse2` \| `Table`<`Row`\> \| `AbortableResponse`<`ScalarResponse`<`Row`\>\> \| `NavResponse` \| `RadioTable` \| `UsageModel` \| `MetadataBearing`<`any`\> \| `RawResponse`<`any`\> \| `MetadataBearing`<`any`\>[]\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/create.ts:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/create.ts#L34) + +--- + +### doDelete + +▸ `Const` **doDelete**(`command?`): (`args`: `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\>) => `Promise`<`string` \| `number` \| `boolean` \| `HTMLElement` \| `Error` \| `MarkdownResponse` \| `ReactResponse` \| `MixedResponse` \| `CommentaryResponse` \| `TabLayoutModificationResponse`<`NewSplitRequest`\> \| `XtermResponse` \| `default` \| `RandomErrorResponse1` \| `RandomErrorResponse2` \| `Table`<`Row`\> \| `AbortableResponse`<`ScalarResponse`<`Row`\>\> \| `NavResponse` \| `RadioTable` \| `UsageModel` \| `MetadataBearing`<`any`\> \| `RawResponse`<`any`\> \| `MetadataBearing`<`any`\>[]\> + +#### Parameters + +| Name | Type | Default value | +| :-------- | :------- | :------------ | +| `command` | `string` | `'kubectl'` | + +#### Returns + +`fn` + +▸ (`args`): `Promise`<`string` \| `number` \| `boolean` \| `HTMLElement` \| `Error` \| `MarkdownResponse` \| `ReactResponse` \| `MixedResponse` \| `CommentaryResponse` \| `TabLayoutModificationResponse`<`NewSplitRequest`\> \| `XtermResponse` \| `default` \| `RandomErrorResponse1` \| `RandomErrorResponse2` \| `Table`<`Row`\> \| `AbortableResponse`<`ScalarResponse`<`Row`\>\> \| `NavResponse` \| `RadioTable` \| `UsageModel` \| `MetadataBearing`<`any`\> \| `RawResponse`<`any`\> \| `MetadataBearing`<`any`\>[]\> + +##### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | + +##### Returns + +`Promise`<`string` \| `number` \| `boolean` \| `HTMLElement` \| `Error` \| `MarkdownResponse` \| `ReactResponse` \| `MixedResponse` \| `CommentaryResponse` \| `TabLayoutModificationResponse`<`NewSplitRequest`\> \| `XtermResponse` \| `default` \| `RandomErrorResponse1` \| `RandomErrorResponse2` \| `Table`<`Row`\> \| `AbortableResponse`<`ScalarResponse`<`Row`\>\> \| `NavResponse` \| `RadioTable` \| `UsageModel` \| `MetadataBearing`<`any`\> \| `RawResponse`<`any`\> \| `MetadataBearing`<`any`\>[]\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/delete.ts:41](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/delete.ts#L41) + +--- + +### doExecRaw + +▸ **doExecRaw**(`command`, `parsedOptions`, `execOptions`): `Promise`<`string`\> + +A convenience wrapper over `doNativeExec` that extracts only +stdout, and discards the exit code and stderr. + +#### Parameters + +| Name | Type | +| :-------------- | :--------------------------------------------------------------------- | +| `command` | `string` | +| `parsedOptions` | [`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) | +| `execOptions` | `ExecOptions` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/raw.ts:163](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/raw.ts#L163) + +--- + +### doExecWithMarkdown + +▸ **doExecWithMarkdown**(`args`, `exec?`): `Promise`<`NavResponse`\> + +#### Parameters + +| Name | Type | +| :------ | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | +| `exec?` | `string` | + +#### Returns + +`Promise`<`NavResponse`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/exec-to-markdown.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/exec-to-markdown.ts#L24) + +--- + +### doExecWithPty + +▸ **doExecWithPty**<`Content`, `Response`, `O`\>(`args`, `prepare?`, `exec?`): `Promise`<`string` \| `Response`\> + +Execute the given command using a pty + +#### Type parameters + +| Name | Type | +| :--------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Content` | `void` | +| `Response` | extends `KResponse`<`Content`\>`KResponse`<`Content`\> | +| `O` | extends [`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) | + +#### Parameters + +| Name | Type | Default value | +| :-------- | :-------------------- | :------------ | +| `args` | `EvaluatorArgs`<`O`\> | `undefined` | +| `prepare` | `Prepare`<`O`\> | `NoPrepare` | +| `exec?` | `string` | `undefined` | + +#### Returns + +`Promise`<`string` \| `Response`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/exec.ts:107](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/exec.ts#L107) + +--- + +### doExecWithRadioTable + +▸ **doExecWithRadioTable**<`Resource`\>(`resources`, `defaultSelectedIdx`, `onSelect`, `__namedParameters?`): `Promise`<`RadioTable` \| `void`\> + +#### Type parameters + +| Name | Type | +| :--------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Resource` | extends `MetadataBearing`<`void`, `Resource`\> & [`WithRawData`](../interfaces/kui_shell_plugin_kubectl.WithRawData.md)<`void`, `Resource`\> & { `apiVersion`: `string` ; `isKubeResource`: `true` ; `isSimulacrum?`: `boolean` ; `kind`: `string` ; `metadata?`: `KubeMetadata` ; `originatingCommand`: `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> ; `spec?`: `any` ; `status?`: [`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md) } | + +#### Parameters + +| Name | Type | +| :---------------------------------- | :----------------------------------------------------- | +| `resources` | `Resource`[] | +| `defaultSelectedIdx` | `number` | +| `onSelect` | (`name`: `string`, `resource`: `Resource`) => `string` | +| `__namedParameters` | `Object` | +| `__namedParameters.nameColumnTitle` | `string` | +| `__namedParameters.title` | `string` | + +#### Returns + +`Promise`<`RadioTable` \| `void`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/exec.ts:282](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/exec.ts#L282) + +--- + +### doExecWithStatus + +▸ `Const` **doExecWithStatus**<`O`\>(`verb`, `finalState`, `command?`, `prepareForExec?`, `prepareForStatus?`): (`args`: `EvaluatorArgs`<`O`\>) => `Promise`<`KubeTableResponse`\> + +Execute a command, and then execute the status command which will +poll until the given FinalState is reached. + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------- | +| `O` | extends [`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) | + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------- | :------------------------ | +| `verb` | `string` | `undefined` | +| `finalState` | `FinalState` | `undefined` | +| `command` | `string` | `'kubectl'` | +| `prepareForExec` | `Prepare`<`O`\> | `NoPrepare` | +| `prepareForStatus` | `PrepareForStatus`<`O`\> | `DefaultPrepareForStatus` | + +#### Returns + +`fn` + +▸ (`args`): `Promise`<`KubeTableResponse`\> + +##### Parameters + +| Name | Type | +| :----- | :-------------------- | +| `args` | `EvaluatorArgs`<`O`\> | + +##### Returns + +`Promise`<`KubeTableResponse`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/exec.ts:259](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/exec.ts#L259) + +--- + +### doExecWithStdout + +▸ **doExecWithStdout**<`O`\>(`args`, `prepare?`, `exec?`): `Promise`<`string`\> + +Behaves as does `exec`, except that it projects out just the +`stdout` part -- thus ignoring the exit `code` and `stderr`. + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------- | +| `O` | extends [`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) | + +#### Parameters + +| Name | Type | Default value | +| :-------- | :-------------------- | :------------ | +| `args` | `EvaluatorArgs`<`O`\> | `undefined` | +| `prepare` | `Prepare`<`O`\> | `NoPrepare` | +| `exec?` | `string` | `undefined` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/exec.ts:86](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/exec.ts#L86) + +--- + +### doExecWithStdoutViaPty + +▸ **doExecWithStdoutViaPty**<`O`\>(`args`, `prepare?`): `Promise`<`string`\> + +Execute the given command using a pty, but return a string + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------------------------------------------------------------------------------------------------- | +| `O` | extends [`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) | + +#### Parameters + +| Name | Type | Default value | +| :-------- | :-------------------- | :------------ | +| `args` | `EvaluatorArgs`<`O`\> | `undefined` | +| `prepare` | `Prepare`<`O`\> | `NoPrepare` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/exec.ts:158](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/exec.ts#L158) + +--- + +### doExecWithTable + +▸ **doExecWithTable**<`O`\>(`args`, `prepare?`, `command?`, `__namedParameters?`): `Promise`<`Table` \| `MixedResponse`\> + +Behaves as does `exec`, except that it projects out just the +`stdout` part and parses it into a Table model. + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------- | +| `O` | extends [`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) | + +#### Parameters + +| Name | Type | Default value | +| :------------------------------ | :-------------------- | :------------ | +| `args` | `EvaluatorArgs`<`O`\> | `undefined` | +| `prepare` | `Prepare`<`O`\> | `NoPrepare` | +| `command` | `string` | `'kubectl'` | +| `__namedParameters` | `Object` | `{}` | +| `__namedParameters.entityType?` | `string` | `undefined` | +| `__namedParameters.nameColumn?` | `string` | `undefined` | +| `__namedParameters.usePty?` | `boolean` | `undefined` | +| `__namedParameters.verb?` | `string` | `undefined` | + +#### Returns + +`Promise`<`Table` \| `MixedResponse`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/exec.ts:223](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/exec.ts#L223) + +--- + +### doGet + +▸ `Const` **doGet**(`command`): (`args`: `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\>) => `Promise`<`KResponse`<`any`\>\> + +This is the main handler for `kubectl get`. Here, we act as a +dispatcher: in `kubectl` a `get` can mean either get-as-table, +get-as-entity, or get-as-custom, depending on the `-o` flag. + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `command` | `string` | + +#### Returns + +`fn` + +▸ (`args`): `Promise`<`KResponse`<`any`\>\> + +##### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | + +##### Returns + +`Promise`<`KResponse`<`any`\>\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/get.ts:332](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/get.ts#L332) + +--- + +### doHelp + +▸ **doHelp**<`O`\>(`command`, `args`, `prepare?`): `Promise`<`KResponse`\> + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------- | +| `O` | extends [`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) | + +#### Parameters + +| Name | Type | Default value | +| :-------- | :-------------------- | :------------ | +| `command` | `string` | `undefined` | +| `args` | `EvaluatorArgs`<`O`\> | `undefined` | +| `prepare` | `Prepare`<`O`\> | `NoPrepare` | + +#### Returns + +`Promise`<`KResponse`\> + +#### Defined in + +[plugins/plugin-kubectl/src/lib/util/help.ts:467](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/util/help.ts#L467) + +--- + +### doNativeExec + +▸ **doNativeExec**(`args`): `Promise`<`RawResponse`\> + +#### Parameters + +| Name | Type | +| :----- | :----- | +| `args` | `Args` | + +#### Returns + +`Promise`<`RawResponse`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/raw.ts:134](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/raw.ts#L134) + +--- + +### doRun + +▸ `Const` **doRun**(`command?`): (`args`: `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\>) => `Promise`<`KResponse`<`any`\>\> + +#### Parameters + +| Name | Type | Default value | +| :-------- | :------- | :------------ | +| `command` | `string` | `'kubectl'` | + +#### Returns + +`fn` + +▸ (`args`): `Promise`<`KResponse`<`any`\>\> + +##### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | + +##### Returns + +`Promise`<`KResponse`<`any`\>\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/run.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/run.ts#L40) + +--- + +### emitKubectlConfigChangeEvent + +▸ **emitKubectlConfigChangeEvent**(`type`, `namespace?`, `context?`): `void` + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------------------------- | +| `type` | `"SetNamespaceOrContext"` \| `"CreateOrDeleteNamespace"` | +| `namespace?` | `string` | +| `context?` | `string` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/config.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/config.ts#L39) + +--- + +### fetchFileString + +▸ **fetchFileString**(`repl`, `url`, `headers?`): `Promise`<(`void` \| `string`)[]\> + +same as fetchFile, but returning a string rather than a Buffer + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------- | +| `repl` | `default` | +| `url` | `string` | +| `headers?` | `Record`<`string`, `string`\> | + +#### Returns + +`Promise`<(`void` \| `string`)[]\> + +#### Defined in + +[plugins/plugin-kubectl/src/lib/util/fetch-file.ts:295](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/util/fetch-file.ts#L295) + +--- + +### flags + +▸ **flags**(`booleans?`): `CommandOptions` + +#### Parameters + +| Name | Type | Default value | +| :--------- | :--------- | :------------ | +| `booleans` | `string`[] | `[]` | + +#### Returns + +`CommandOptions` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/flags.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/flags.ts#L44) + +--- + +### formatTable + +▸ `Const` **formatTable**<`O`\>(`command`, `verb`, `entityTypeFromCommandLine`, `args`, `preTable`, `nameColumn?`): `Promise`<`Table`<`Row`\>\> + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------- | +| `O` | extends [`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) | + +#### Parameters + +| Name | Type | Default value | +| :-------------------------- | :-------------------- | :------------ | +| `command` | `string` | `undefined` | +| `verb` | `string` | `undefined` | +| `entityTypeFromCommandLine` | `string` | `undefined` | +| `args` | `EvaluatorArgs`<`O`\> | `undefined` | +| `preTable` | `Pair`[][] | `undefined` | +| `nameColumn` | `string` | `'NAME'` | + +#### Returns + +`Promise`<`Table`<`Row`\>\> + +#### Defined in + +[plugins/plugin-kubectl/src/lib/view/formatTable.ts:210](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/view/formatTable.ts#L210) + +--- + +### fqn + +▸ **fqn**(`apiVersion`, `kind`, `name`, `namespace`): `string` + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `apiVersion` | `string` | +| `kind` | `string` | +| `name` | `string` | +| `namespace` | `string` | + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/fqn.ts:93](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/fqn.ts#L93) + +--- + +### fqnOf + +▸ **fqnOf**(`resource`): `string` + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| `resource` | [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\> | + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/fqn.ts:101](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/fqn.ts#L101) + +--- + +### getAllContexts + +▸ **getAllContexts**(`__namedParameters`): `Promise`<[`KubeContext`](../interfaces/kui_shell_plugin_kubectl.KubeContext.md)[]\> + +#### Parameters + +| Name | Type | +| :----------------------- | :-------- | +| `__namedParameters` | `Object` | +| `__namedParameters.REPL` | `default` | + +#### Returns + +`Promise`<[`KubeContext`](../interfaces/kui_shell_plugin_kubectl.KubeContext.md)[]\> + +a list of `KubeContext` for all known contexts + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/contexts.ts:67](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/contexts.ts#L67) + +--- + +### getAsMMRTransformer + +▸ **getAsMMRTransformer**(`args`, `resource`): `Promise`<`MultiModalResponse`<[`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)\>\> + +`kubectl get` as entity response + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | +| `resource` | [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\> | + +#### Returns + +`Promise`<`MultiModalResponse`<[`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)\>\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/get.ts:183](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/get.ts#L183) + +--- + +### getCommandFromArgs + +▸ `Const` **getCommandFromArgs**(`args`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------ | +| `args` | `Pick`<`EvaluatorArgs`<`ParsedOptions`\>, `"argvNoOptions"`\> | + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/util/util.ts:115](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/util/util.ts#L115) + +--- + +### getContainer + +▸ **getContainer**(`args`, `verb`): `string` + +e.g. for kubectl logs + +#### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | +| `verb` | `string` | + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:229](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L229) + +--- + +### getCurrentContext + +▸ **getCurrentContext**(`__namedParameters`): `Promise`<[`KubeContext`](../interfaces/kui_shell_plugin_kubectl.KubeContext.md)\> + +#### Parameters + +| Name | Type | +| :----------------------- | :-------- | +| `__namedParameters` | `Object` | +| `__namedParameters.REPL` | `default` | + +#### Returns + +`Promise`<[`KubeContext`](../interfaces/kui_shell_plugin_kubectl.KubeContext.md)\> + +a `KubeContext` representing the current context + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/contexts.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/contexts.ts#L55) + +--- + +### getCurrentContextName + +▸ **getCurrentContextName**(`__namedParameters`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------------- | :-------- | +| `__namedParameters` | `Object` | +| `__namedParameters.REPL` | `default` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/contexts.ts:71](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/contexts.ts#L71) + +--- + +### getCurrentDefaultContextName + +▸ **getCurrentDefaultContextName**(`__namedParameters`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------------- | :-------- | +| `__namedParameters` | `Object` | +| `__namedParameters.REPL` | `default` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/contexts.ts:130](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/contexts.ts#L130) + +--- + +### getCurrentDefaultNamespace + +▸ **getCurrentDefaultNamespace**(`__namedParameters`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------------- | :-------- | +| `__namedParameters` | `Object` | +| `__namedParameters.REPL` | `default` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/contexts.ts:97](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/contexts.ts#L97) + +--- + +### getKind + +▸ **getKind**(`command`, `args`, `kindAsProvidedByUser`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | Description | +| :--------------------- | :-------------------------------- | :------------- | +| `command` | `string` | - | +| `args` | `EvaluatorArgs`<`ParsedOptions`\> | - | +| `kindAsProvidedByUser` | `string` | e.g. pod or po | + +#### Returns + +`Promise`<`string`\> + +e.g. Pod + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/explain.ts:329](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/explain.ts#L329) + +--- + +### getLabel + +▸ **getLabel**(`__namedParameters`): `string` + +#### Parameters + +| Name | Type | +| :------------------ | :------------------------------------------------------------------------------------------------------------------- | +| `__namedParameters` | `Pick`<`EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\>, `"parsedOptions"`\> | + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:144](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L144) + +--- + +### getLabelForArgv + +▸ **getLabelForArgv**(`args`): `string` + +#### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:169](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L169) + +--- + +### getNamespace + +▸ **getNamespace**(`args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | + +#### Returns + +`Promise`<`string`\> + +the namespace as expressed in the command line, or the default from context + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:206](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L206) + +--- + +### getNamespaceForArgv + +▸ **getNamespaceForArgv**(`args`): `string` + +A variant of getNamespace where you _only_ want to use what was +provided by the user in their command line. + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------------------------------------------------------- | +| `args` | `Pick`<`EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\>, `"parsedOptions"`\> | + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:214](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L214) + +--- + +### getTabState + +▸ **getTabState**(`tab`, `key`): `any` + +#### Parameters + +| Name | Type | +| :---- | :-------- | +| `tab` | `default` | +| `key` | `string` | + +#### Returns + +`any` + +#### Defined in + +[plugins/plugin-kubectl/src/tab-state.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/tab-state.ts#L27) + +--- + +### getTransformer + +▸ **getTransformer**(`args`, `response`): `Promise`<`ReturnType` \| `Table`\> + +KubeResource -> MultiModalResponse view transformer + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | +| `response` | `KResponse`<`any`\> | + +#### Returns + +`Promise`<`ReturnType` \| `Table`\> + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/get.ts:403](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/get.ts#L403) + +--- + +### getter + +▸ **getter**(`registrar`, `command`, `cli?`): `void` + +Register a command listener + +#### Parameters + +| Name | Type | Default value | +| :---------- | :----------------- | :------------ | +| `registrar` | `CommandRegistrar` | `undefined` | +| `command` | `string` | `undefined` | +| `cli` | `string` | `command` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/get.ts:466](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/get.ts#L466) + +--- + +### hasLabel + +▸ **hasLabel**(`args`): `boolean` + +Due to deficiencies in yargs-parser (used by @kui-shell/core), the +form -lapp=name (i.e. without a whitespace after the -l) is not +parsed properly. + +#### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | + +#### Returns + +`boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:183](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L183) + +--- + +### isCrudableKubeResource + +▸ **isCrudableKubeResource**(`entity`): entity is KubeResource + +is the command response a kube resource that can responds to "kubectl delete", etc.? + +#### Parameters + +| Name | Type | +| :------- | :------------------------- | +| `entity` | `MetadataBearing`<`void`\> | + +#### Returns + +entity is KubeResource + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:530](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L530) + +--- + +### isDeployment + +▸ **isDeployment**(`resource`): resource is Deployment + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| `resource` | [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\> | + +#### Returns + +resource is Deployment + +whether the given resource is an instance of a Deployment + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:427](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L427) + +--- + +### isForAllNamespaces + +▸ **isForAllNamespaces**(`parsedOptions`): `boolean` + +#### Parameters + +| Name | Type | +| :-------------- | :--------------------------------------------------------------------- | +| `parsedOptions` | [`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) | + +#### Returns + +`boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:317](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L317) + +--- + +### isHelpRequest + +▸ **isHelpRequest**(`args`): `boolean` + +#### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | + +#### Returns + +`boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:112](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L112) + +--- + +### isJob + +▸ **isJob**(`resource`): resource is Job + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `resource` | `Pick`<[`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\>, `"apiVersion"` \| `"kind"`\> | + +#### Returns + +resource is Job + +whether the given resource is an instance of a Deploymemt + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:399](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L399) + +--- + +### isKubeItems + +▸ **isKubeItems**(`resource`): resource is KubeItems\> + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| `resource` | [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\> | + +#### Returns + +resource is KubeItems\> + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:552](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L552) + +--- + +### isKubeItemsOfKind + +▸ **isKubeItemsOfKind**<`Item`\>(`resource`, `isOfKind`): resource is KubeItems + +#### Type parameters + +| Name | Type | +| :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Item` | extends `MetadataBearing`<`void`, `Item`\> & [`WithRawData`](../interfaces/kui_shell_plugin_kubectl.WithRawData.md)<`void`, `Item`\> & { `apiVersion`: `string` ; `isKubeResource`: `true` ; `isSimulacrum?`: `boolean` ; `kind`: `string` ; `metadata?`: `KubeMetadata` ; `originatingCommand`: `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> ; `spec?`: `any` ; `status?`: [`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md) }[`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\> | + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `resource` | [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\> | +| `isOfKind` | (`item`: [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\>) => item is Item | + +#### Returns + +resource is KubeItems + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:560](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L560) + +--- + +### isKubeResource + +▸ **isKubeResource**(`entity`): entity is KubeResource + +is the command response a Kubernetes resource? note: excluding any ones we simulate in kubeui + +#### Parameters + +| Name | Type | +| :------- | :------------------------------------------------ | +| `entity` | `MetadataBearing`<`void`\> \| `KResponse`<`any`\> | + +#### Returns + +entity is KubeResource + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:214](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L214) + +--- + +### isPod + +▸ **isPod**(`resource`): resource is Pod + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| `resource` | [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\> | + +#### Returns + +resource is Pod + +whether the given resource is an instance of a Pod + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:335](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L335) + +--- + +### isPodList + +▸ **isPodList**(`resource`): resource is PodList + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| `resource` | [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\> | + +#### Returns + +resource is PodList + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:556](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L556) + +--- + +### isSecret + +▸ **isSecret**(`resource`): resource is Secret\> + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| `resource` | [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\> | + +#### Returns + +resource is Secret\> + +#### Defined in + +[plugins/plugin-kubectl/src/lib/model/resource.ts:760](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/model/resource.ts#L760) + +--- + +### isTableRequest + +▸ **isTableRequest**(`args`): `boolean` + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------------------------------------------------------- | +| `args` | `Pick`<`EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\>, `"parsedOptions"`\> | + +#### Returns + +`boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:118](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L118) + +--- + +### isUsage + +▸ `Const` **isUsage**(`args`): `boolean` + +#### Parameters + +| Name | Type | +| :----- | :--------------------------------------------------------------------------------------- | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | + +#### Returns + +`boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/lib/util/help.ts:465](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/util/help.ts#L465) + +--- + +### isWatchRequest + +▸ **isWatchRequest**(`args`): `boolean` + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------------------------------------------------------- | +| `args` | `Pick`<`EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\>, `"parsedOptions"`\> | + +#### Returns + +`boolean` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:122](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L122) + +--- + +### offKubectlConfigChangeEvents + +▸ **offKubectlConfigChangeEvents**(`handler`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :-------- | +| `handler` | `Handler` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/config.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/config.ts#L55) + +--- + +### onKubectlConfigChangeEvents + +▸ **onKubectlConfigChangeEvents**(`handler`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :-------- | +| `handler` | `Handler` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/config.ts:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/config.ts#L51) + +--- + +### parseName + +▸ **parseName**(`resource`): { `app`: `string` ; `name`: `string` ; `nameHash`: `string` ; `version`: `string` } \| { `app`: `undefined` ; `name`: `string` ; `nameHash`: `string` ; `version`: `string` } \| { `app`: `undefined` ; `name`: `undefined` ; `nameHash`: `undefined` ; `version`: `undefined` } + +Separate the app and generated parts of a resource name + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| `resource` | [`KubeResource`](kui_shell_plugin_kubectl.md#kuberesource)<[`KubeStatus`](../interfaces/kui_shell_plugin_kubectl.KubeStatus.md), `KubeMetadata`\> | + +#### Returns + +{ `app`: `string` ; `name`: `string` ; `nameHash`: `string` ; `version`: `string` } \| { `app`: `undefined` ; `name`: `string` ; `nameHash`: `string` ; `version`: `string` } \| { `app`: `undefined` ; `name`: `undefined` ; `nameHash`: `undefined` ; `version`: `undefined` } + +#### Defined in + +[plugins/plugin-kubectl/src/lib/util/name.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/util/name.ts#L23) + +--- + +### preprocessTable + +▸ `Const` **preprocessTable**(`raw`): `Pair`[][][] + +Find the column splits + +#### Parameters + +| Name | Type | +| :---- | :--------- | +| `raw` | `string`[] | + +#### Returns + +`Pair`[][][] + +#### Defined in + +[plugins/plugin-kubectl/src/lib/view/formatTable.ts:147](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/view/formatTable.ts#L147) + +--- + +### registerApplySubcommands + +▸ **registerApplySubcommands**(`registrar`, `cmd`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------------- | +| `registrar` | `CommandRegistrar` | +| `cmd` | `string` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/apply-subcommands.ts:108](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/apply-subcommands.ts#L108) + +--- + +### registerConfig + +▸ **registerConfig**(`registrar`, `cmd`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------------- | +| `registrar` | `CommandRegistrar` | +| `cmd` | `string` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/config.ts:101](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/config.ts#L101) + +--- + +### registerEdit + +▸ **registerEdit**(`registrar`, `cmd`): `void` + +#### Parameters + +| Name | Type | +| :---------- | :----------------- | +| `registrar` | `CommandRegistrar` | +| `cmd` | `string` | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/edit.ts:279](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/edit.ts#L279) + +--- + +### stringToTable + +▸ `Const` **stringToTable**<`O`\>(`decodedResult`, `stderr`, `args`, `command?`, `verb?`, `entityType?`, `nameColumn?`): `Promise`<`KubeTableResponse`\> + +Display the given string as a REPL table + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------- | +| `O` | extends [`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) | + +#### Parameters + +| Name | Type | +| :-------------- | :-------------------- | +| `decodedResult` | `string` | +| `stderr` | `string` | +| `args` | `EvaluatorArgs`<`O`\> | +| `command?` | `string` | +| `verb?` | `string` | +| `entityType?` | `string` | +| `nameColumn?` | `string` | + +#### Returns + +`Promise`<`KubeTableResponse`\> + +#### Defined in + +[plugins/plugin-kubectl/src/lib/view/formatTable.ts:459](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/view/formatTable.ts#L459) + +--- + +### watchRequestFrom + +▸ **watchRequestFrom**(`args`, `forceWatch?`): `""` \| `"--watch"` \| `"-w"` \| `"--watch-only"` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------------------------------------------------------------------------------------- | :------------ | +| `args` | `EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\> | `undefined` | +| `forceWatch` | `boolean` | `false` | + +#### Returns + +`""` \| `"--watch"` \| `"-w"` \| `"--watch-only"` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:126](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L126) + +--- + +### withHelp + +▸ **withHelp**<`O`\>(`args`): `string` \| `number` \| `boolean` \| `HTMLElement` \| `Error` \| `MarkdownResponse` \| `ReactResponse` \| `MixedResponse` \| `CommentaryResponse` \| `TabLayoutModificationResponse`<`NewSplitRequest`\> \| `XtermResponse` \| `default` \| `RandomErrorResponse1` \| `RandomErrorResponse2` \| `Table`<`Row`\> & `Partial`<`WithSourceReferences`\> \| `AbortableResponse`<`ScalarResponse`<`Row`\>\> \| `NavResponse` \| `RadioTable` \| `UsageModel` \| `MetadataBearing`<`any`\> \| `RawResponse`<`any`\> \| `MetadataBearing`<`any`\>[] \| `Promise`<`KResponse`<`any`\>\> + +Wrap the given command handler `this` with a help dispatcher. + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------------- | +| `O` | extends [`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md) | + +#### Parameters + +| Name | Type | +| :----- | :-------------------- | +| `args` | `EvaluatorArgs`<`O`\> | + +#### Returns + +`string` \| `number` \| `boolean` \| `HTMLElement` \| `Error` \| `MarkdownResponse` \| `ReactResponse` \| `MixedResponse` \| `CommentaryResponse` \| `TabLayoutModificationResponse`<`NewSplitRequest`\> \| `XtermResponse` \| `default` \| `RandomErrorResponse1` \| `RandomErrorResponse2` \| `Table`<`Row`\> & `Partial`<`WithSourceReferences`\> \| `AbortableResponse`<`ScalarResponse`<`Row`\>\> \| `NavResponse` \| `RadioTable` \| `UsageModel` \| `MetadataBearing`<`any`\> \| `RawResponse`<`any`\> \| `MetadataBearing`<`any`\>[] \| `Promise`<`KResponse`<`any`\>\> + +#### Defined in + +[plugins/plugin-kubectl/src/lib/util/help.ts:487](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/util/help.ts#L487) + +--- + +### withKubeconfigFrom + +▸ **withKubeconfigFrom**(`args`, `cmdline`): `string` + +Copy over any kubeconfig/context/cluster/namespace specifications from the given args + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------------------------------------------------------------------- | +| `args` | `Pick`<`EvaluatorArgs`<[`KubeOptions`](../interfaces/kui_shell_plugin_kubectl.KubeOptions.md)\>, `"parsedOptions"`\> | +| `cmdline` | `string` | + +#### Returns + +`string` + +#### Defined in + +[plugins/plugin-kubectl/src/controller/kubectl/options.ts:322](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/controller/kubectl/options.ts#L322) + +--- + +### withNamespaceBreadcrumb + +▸ **withNamespaceBreadcrumb**(`ns`, `table`): `MixedResponse` \| `Table`<`Row`\> + +Change the namespace breadcrumb of the given maybe-Table + +#### Parameters + +| Name | Type | +| :------ | :--------------------------------- | +| `ns` | `string` | +| `table` | `MixedResponse` \| `Table`<`Row`\> | + +#### Returns + +`MixedResponse` \| `Table`<`Row`\> + +#### Defined in + +[plugins/plugin-kubectl/src/lib/view/formatTable.ts:602](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-kubectl/src/lib/view/formatTable.ts#L602) diff --git a/docs/api/modules/kui_shell_plugin_proxy_support.md b/docs/api/modules/kui_shell_plugin_proxy_support.md new file mode 100644 index 00000000000..f257c82d004 --- /dev/null +++ b/docs/api/modules/kui_shell_plugin_proxy_support.md @@ -0,0 +1,9 @@ +[Kui API Documentation - v10.8.0](../README.md) / @kui-shell/plugin-proxy-support + +# Module: @kui-shell/plugin-proxy-support + +## Table of contents + +### Classes + +- [ProxyOfflineIndicator](../classes/kui_shell_plugin_proxy_support.ProxyOfflineIndicator.md) diff --git a/docs/api/modules/kui_shell_plugin_s3.md b/docs/api/modules/kui_shell_plugin_s3.md new file mode 100644 index 00000000000..70f8f13eb39 --- /dev/null +++ b/docs/api/modules/kui_shell_plugin_s3.md @@ -0,0 +1,124 @@ +[Kui API Documentation - v10.8.0](../README.md) / @kui-shell/plugin-s3 + +# Module: @kui-shell/plugin-s3 + +## Table of contents + +### Classes + +- [UnsupportedS3ProviderError](../classes/kui_shell_plugin_s3.UnsupportedS3ProviderError.md) + +### Interfaces + +- [MinioConfig](../interfaces/kui_shell_plugin_s3.MinioConfig.md) +- [Mount](../interfaces/kui_shell_plugin_s3.Mount.md) + +### Type aliases + +- [ProviderInitializer](kui_shell_plugin_s3.md#providerinitializer) +- [S3Provider](kui_shell_plugin_s3.md#s3provider) + +### Properties + +- [eventBus](kui_shell_plugin_s3.md#eventbus) + +### Functions + +- [addProviderInitializer](kui_shell_plugin_s3.md#addproviderinitializer) +- [getCurrentMounts](kui_shell_plugin_s3.md#getcurrentmounts) +- [minioConfig](kui_shell_plugin_s3.md#minioconfig) + +## Type aliases + +### ProviderInitializer + +Ƭ **ProviderInitializer**: `Object` + +#### Type declaration + +| Name | Type | +| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `mountName` | `string` | +| `init` | (`repl`: `default`, `reinit?`: () => `void`) => [`S3Provider`](kui_shell_plugin_s3.md#s3provider) \| `Promise`<[`S3Provider`](kui_shell_plugin_s3.md#s3provider)\> \| `Promise`<[`S3Provider`](kui_shell_plugin_s3.md#s3provider)[]\> | + +#### Defined in + +[plugins/plugin-s3/src/providers/model.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/providers/model.ts#L43) + +--- + +### S3Provider + +Ƭ **S3Provider**: `ClientOptions` & { `bucketFilter?`: `BucketFilter` ; `directEndPoint?`: `string` ; `error?`: `Error` ; `isDefault?`: `boolean` ; `listBuckets?`: `ClientOptions` ; `mountName`: `string` ; `publicOnly?`: `boolean` ; `region?`: `string` ; `subdir?`: `string` ; `understandsFolders?`: `boolean` } + +#### Defined in + +[plugins/plugin-s3/src/providers/model.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/providers/model.ts#L23) + +## Properties + +### eventBus + +• **eventBus**: `EventBus` + +## Functions + +### addProviderInitializer + +▸ **addProviderInitializer**(`providerInitializers`): `void` + +#### Parameters + +| Name | Type | +| :--------------------- | :-------------------------------------------------------------------- | +| `providerInitializers` | [`ProviderInitializer`](kui_shell_plugin_s3.md#providerinitializer)[] | + +#### Returns + +`void` + +#### Defined in + +[plugins/plugin-s3/src/providers/index.ts:35](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/providers/index.ts#L35) + +--- + +### getCurrentMounts + +▸ **getCurrentMounts**(): [`Mount`](../interfaces/kui_shell_plugin_s3.Mount.md)[] + +#### Returns + +[`Mount`](../interfaces/kui_shell_plugin_s3.Mount.md)[] + +a list of the providers, with info about mount status for each + +#### Defined in + +[plugins/plugin-s3/src/vfs/responders.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/vfs/responders.ts#L39) + +--- + +### minioConfig + +▸ **minioConfig**(`direct?`): `Promise`<[`MinioConfig`](../interfaces/kui_shell_plugin_s3.MinioConfig.md)\> + +This takes the S3 providers that we know about, and produces a +model that can be fed into `mc alias set`. Special case: if this +user does not have a configured AWS provider (i.e. we have no AWS +S3 credentials for them), we will create an auth-less entry; this +will allow access to public AWS s3 buckets. + +#### Parameters + +| Name | Type | Default value | +| :------- | :-------- | :------------ | +| `direct` | `boolean` | `false` | + +#### Returns + +`Promise`<[`MinioConfig`](../interfaces/kui_shell_plugin_s3.MinioConfig.md)\> + +#### Defined in + +[plugins/plugin-s3/src/vfs/responders.ts:96](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/plugins/plugin-s3/src/vfs/responders.ts#L96) diff --git a/docs/api/modules/kui_shell_test.CLI.md b/docs/api/modules/kui_shell_test.CLI.md new file mode 100644 index 00000000000..e7ed8db01c6 --- /dev/null +++ b/docs/api/modules/kui_shell_test.CLI.md @@ -0,0 +1,455 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](kui_shell_test.md) / CLI + +# Namespace: CLI + +[@kui-shell/test](kui_shell_test.md).CLI + +## Table of contents + +### Variables + +- [timeout](kui_shell_test.CLI.md#timeout) +- [waitTimeout](kui_shell_test.CLI.md#waittimeout) + +### Functions + +- [command](kui_shell_test.CLI.md#command) +- [commandInSplit](kui_shell_test.CLI.md#commandinsplit) +- [exitCode](kui_shell_test.CLI.md#exitcode) +- [expandLast](kui_shell_test.CLI.md#expandlast) +- [expandNth](kui_shell_test.CLI.md#expandnth) +- [expectInput](kui_shell_test.CLI.md#expectinput) +- [expectInputContext](kui_shell_test.CLI.md#expectinputcontext) +- [expectPriorInput](kui_shell_test.CLI.md#expectpriorinput) +- [getTextContent](kui_shell_test.CLI.md#gettextcontent) +- [grabFocus](kui_shell_test.CLI.md#grabfocus) +- [lastBlock](kui_shell_test.CLI.md#lastblock) +- [makeCustom](kui_shell_test.CLI.md#makecustom) +- [nOfCurrentBlock](kui_shell_test.CLI.md#nofcurrentblock) +- [paste](kui_shell_test.CLI.md#paste) +- [waitForRepl](kui_shell_test.CLI.md#waitforrepl) +- [waitForSession](kui_shell_test.CLI.md#waitforsession) + +## Variables + +### timeout + +• **timeout**: `number` + +#### Defined in + +[packages/test/src/api/cli.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L24) + +--- + +### waitTimeout + +• **waitTimeout**: `number` + +#### Defined in + +[packages/test/src/api/cli.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L25) + +## Functions + +### command + +▸ `Const` **command**(`cmd`, `app`, `noNewline?`, `noCopyPaste?`, `noFocus?`, `block?`, `currentPrompt?`): `Promise`<`Object`\> + +Execute a CLI command, and return the data-input-count of that command + +#### Parameters + +| Name | Type | Default value | +| :-------------- | :------------ | :------------ | +| `cmd` | `string` | `undefined` | +| `app` | `Application` | `undefined` | +| `noNewline` | `boolean` | `false` | +| `noCopyPaste` | `boolean` | `undefined` | +| `noFocus` | `boolean` | `false` | +| `block` | `string` | `undefined` | +| `currentPrompt` | `string` | `undefined` | + +#### Returns + +`Promise`<`Object`\> + +#### Defined in + +[packages/test/src/api/cli.ts:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L56) + +--- + +### commandInSplit + +▸ `Const` **commandInSplit**(`cmd`, `app`, `splitIndex`): `Promise`<{ `app`: `Application` = app; `count`: `number` } & { `splitIndex`: `number` }\> + +Execute the given command in the given split + +#### Parameters + +| Name | Type | +| :----------- | :------------ | +| `cmd` | `string` | +| `app` | `Application` | +| `splitIndex` | `number` | + +#### Returns + +`Promise`<{ `app`: `Application` = app; `count`: `number` } & { `splitIndex`: `number` }\> + +#### Defined in + +[packages/test/src/api/cli.ts:102](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L102) + +--- + +### exitCode + +▸ `Const` **exitCode**(`statusCode`): `string` \| `number` + +Exit code code for the given http status code; this is an identity function; for headless mode, there is the -256 part. +See headless.js for the analogous headless implementation. + +#### Parameters + +| Name | Type | +| :----------- | :------------------- | +| `statusCode` | `string` \| `number` | + +#### Returns + +`string` \| `number` + +#### Defined in + +[packages/test/src/api/cli.ts:179](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L179) + +--- + +### expandLast + +▸ **expandLast**(`app`, `splitIndex?`, `N?`): `Promise`<`void`\> + +Click to expand the last replayed sample output + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------------ | :------------ | +| `app` | `Application` | `undefined` | +| `splitIndex` | `number` | `1` | +| `N` | `number` | `1` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/cli.ts:244](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L244) + +--- + +### expandNth + +▸ **expandNth**(`app`, `N`, `splitIndex?`): `Promise`<`void`\> + +Click to expand the last replayed sample output + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------------ | :------------ | +| `app` | `Application` | `undefined` | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/cli.ts:237](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L237) + +--- + +### expectInput + +▸ `Const` **expectInput**(`selector`, `expectedText`): (`app`: `Application`) => `Promise`<`Application`\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `selector` | `string` | +| `expectedText` | `string` | + +#### Returns + +`fn` + +▸ (`app`): `Promise`<`Application`\> + +##### Parameters + +| Name | Type | +| :---- | :------------ | +| `app` | `Application` | + +##### Returns + +`Promise`<`Application`\> + +#### Defined in + +[packages/test/src/api/cli.ts:181](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L181) + +--- + +### expectInputContext + +▸ **expectInputContext**(`res`, `N`, `expectedText`, `exact?`): `Promise`<`boolean`\> + +text repl input context text + +#### Parameters + +| Name | Type | Default value | +| :------------- | :---------------------------------------------------------------------- | :------------ | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | `undefined` | +| `N` | `number` | `undefined` | +| `expectedText` | `string` | `undefined` | +| `exact` | `boolean` | `false` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/cli.ts:193](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L193) + +--- + +### expectPriorInput + +▸ `Const` **expectPriorInput**(`selector`, `expectedText`): (`app`: `Application`) => `Promise`<`Application`\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `selector` | `string` | +| `expectedText` | `string` | + +#### Returns + +`fn` + +▸ (`app`): `Promise`<`Application`\> + +##### Parameters + +| Name | Type | +| :---- | :------------ | +| `app` | `Application` | + +##### Returns + +`Promise`<`Application`\> + +#### Defined in + +[packages/test/src/api/cli.ts:199](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L199) + +--- + +### getTextContent + +▸ `Const` **getTextContent**(`app`, `selector`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :--------- | :------------ | +| `app` | `Application` | +| `selector` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/test/src/api/cli.ts:157](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L157) + +--- + +### grabFocus + +▸ `Const` **grabFocus**(`app`, `currentPromptBlock?`, `currentPrompt?`): `Promise`<`boolean` \| `void`\> + +grab focus for the repl + +#### Parameters + +| Name | Type | +| :------------------- | :------------ | +| `app` | `Application` | +| `currentPromptBlock` | `string` | +| `currentPrompt` | `string` | + +#### Returns + +`Promise`<`boolean` \| `void`\> + +#### Defined in + +[packages/test/src/api/cli.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L28) + +--- + +### lastBlock + +▸ **lastBlock**(`app`, `splitIndex?`, `N?`, `inNotebook?`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +Index of last executed block + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------------ | :------------ | +| `app` | `Application` | `undefined` | +| `splitIndex` | `number` | `1` | +| `N` | `number` | `1` | +| `inNotebook` | `boolean` | `false` | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/cli.ts:223](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L223) + +--- + +### makeCustom + +▸ `Const` **makeCustom**(`selector`, `expect`, `exact?`): `Object` + +wait for the result of a cli.command + +#### Parameters + +| Name | Type | +| :--------- | :-------- | +| `selector` | `string` | +| `expect` | `string` | +| `exact?` | `boolean` | + +#### Returns + +`Object` + +| Name | Type | +| :--------- | :-------- | +| `exact` | `boolean` | +| `expect` | `string` | +| `selector` | `string` | + +#### Defined in + +[packages/test/src/api/cli.ts:169](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L169) + +--- + +### nOfCurrentBlock + +▸ **nOfCurrentBlock**(`app`, `splitIndex?`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------------ | :------------ | +| `app` | `Application` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`Promise`<`number`\> + +the "N" of the current block + +#### Defined in + +[packages/test/src/api/cli.ts:215](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L215) + +--- + +### paste + +▸ `Const` **paste**(`cmd`, `app`, `nLines?`): `Promise`<`Object`\> + +#### Parameters + +| Name | Type | Default value | +| :------- | :------------ | :------------ | +| `cmd` | `string` | `undefined` | +| `app` | `Application` | `undefined` | +| `nLines` | `number` | `1` | + +#### Returns + +`Promise`<`Object`\> + +#### Defined in + +[packages/test/src/api/cli.ts:115](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L115) + +--- + +### waitForRepl + +▸ `Const` **waitForRepl**(`app`): `Promise`<`Application`\> + +wait for the repl to be active + +#### Parameters + +| Name | Type | +| :---- | :------------ | +| `app` | `Application` | + +#### Returns + +`Promise`<`Application`\> + +#### Defined in + +[packages/test/src/api/cli.ts:128](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L128) + +--- + +### waitForSession + +▸ `Const` **waitForSession**(`ctx`, `noProxySessionWait?`): `Promise`<`void`\> + +Wait, if needed, for a proxy session + +#### Parameters + +| Name | Type | Default value | +| :------------------- | :-------------------------------------------------------- | :------------ | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | `undefined` | +| `noProxySessionWait` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/cli.ts:141](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/cli.ts#L141) diff --git a/docs/api/modules/kui_shell_test.Common.md b/docs/api/modules/kui_shell_test.Common.md new file mode 100644 index 00000000000..30bb9893d12 --- /dev/null +++ b/docs/api/modules/kui_shell_test.Common.md @@ -0,0 +1,368 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](kui_shell_test.md) / Common + +# Namespace: Common + +[@kui-shell/test](kui_shell_test.md).Common + +## Table of contents + +### Interfaces + +- [BeforeOptions](../interfaces/kui_shell_test.Common.BeforeOptions.md) +- [ISuite](../interfaces/kui_shell_test.Common.ISuite.md) + +### Variables + +- [expectedVersion](kui_shell_test.Common.md#expectedversion) + +### Functions + +- [after](kui_shell_test.Common.md#after) +- [before](kui_shell_test.Common.md#before) +- [dockerDescribe](kui_shell_test.Common.md#dockerdescribe) +- [localDescribe](kui_shell_test.Common.md#localdescribe) +- [localIt](kui_shell_test.Common.md#localit) +- [oops](kui_shell_test.Common.md#oops) +- [pDescribe](kui_shell_test.Common.md#pdescribe) +- [pit](kui_shell_test.Common.md#pit) +- [proxyDescribe](kui_shell_test.Common.md#proxydescribe) +- [proxyIt](kui_shell_test.Common.md#proxyit) +- [refresh](kui_shell_test.Common.md#refresh) +- [remoteIt](kui_shell_test.Common.md#remoteit) +- [restart](kui_shell_test.Common.md#restart) +- [setDebugMode](kui_shell_test.Common.md#setdebugmode) + +## Variables + +### expectedVersion + +• **expectedVersion**: `string` = `version` + +non-headless targets in travis use the clients/default version + +#### Defined in + +[packages/test/src/api/common.ts:577](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L577) + +## Functions + +### after + +▸ `Const` **after**(`ctx`, `f?`): `HookFunction` + +This is the method that will be called when a test completes + +#### Parameters + +| Name | Type | +| :---- | :-------------------------------------------------------- | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | +| `f?` | () => `void` | + +#### Returns + +`HookFunction` + +#### Defined in + +[packages/test/src/api/common.ts:387](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L387) + +--- + +### before + +▸ `Const` **before**(`ctx`, `options?`): `HookFunction` + +This is the method that will be called before a test begins + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------------- | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | +| `options?` | [`BeforeOptions`](../interfaces/kui_shell_test.Common.BeforeOptions.md) | + +#### Returns + +`HookFunction` + +#### Defined in + +[packages/test/src/api/common.ts:288](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L288) + +--- + +### dockerDescribe + +▸ `Const` **dockerDescribe**(`msg`, `suite`): `Suite` + +only execute the test suite in an environment that has docker + +#### Parameters + +| Name | Type | +| :------ | :----------- | +| `msg` | `string` | +| `suite` | () => `void` | + +#### Returns + +`Suite` + +#### Defined in + +[packages/test/src/api/common.ts:544](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L544) + +--- + +### localDescribe + +▸ `Const` **localDescribe**(`msg`, `suite`): `Suite` + +only execute the test suite in local + +#### Parameters + +| Name | Type | +| :------ | :----------- | +| `msg` | `string` | +| `suite` | () => `void` | + +#### Returns + +`Suite` + +#### Defined in + +[packages/test/src/api/common.ts:539](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L539) + +--- + +### localIt + +▸ `Const` **localIt**(`msg`, `func`): `Test` + +only execute the test in local + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `msg` | `string` | +| `func` | `Func` | + +#### Returns + +`Test` + +#### Defined in + +[packages/test/src/api/common.ts:534](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L534) + +--- + +### oops + +▸ `Const` **oops**(`ctx`, `wait?`): (`err`: `Error`) => `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | Default value | +| :----- | :-------------------------------------------------------- | :------------ | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | `undefined` | +| `wait` | `boolean` | `false` | + +#### Returns + +`fn` + +▸ (`err`): `Promise`<`unknown`\> + +##### Parameters + +| Name | Type | +| :---- | :------ | +| `err` | `Error` | + +##### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[packages/test/src/api/common.ts:430](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L430) + +--- + +### pDescribe + +▸ `Const` **pDescribe**(`msg`, `suite`): `Suite` + +only execute the test suite in electron or proxy+browser clients + +#### Parameters + +| Name | Type | +| :------ | :----------- | +| `msg` | `string` | +| `suite` | () => `void` | + +#### Returns + +`Suite` + +#### Defined in + +[packages/test/src/api/common.ts:562](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L562) + +--- + +### pit + +▸ `Const` **pit**(`msg`, `func`): `Test` + +only execute the test in electron or proxy+browser client + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `msg` | `string` | +| `func` | `Func` | + +#### Returns + +`Test` + +#### Defined in + +[packages/test/src/api/common.ts:572](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L572) + +--- + +### proxyDescribe + +▸ `Const` **proxyDescribe**(`msg`, `suite`): `Suite` + +only execute the test suite in proxy+browser clients + +#### Parameters + +| Name | Type | +| :------ | :----------- | +| `msg` | `string` | +| `suite` | () => `void` | + +#### Returns + +`Suite` + +#### Defined in + +[packages/test/src/api/common.ts:557](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L557) + +--- + +### proxyIt + +▸ `Const` **proxyIt**(`msg`, `func`): `Test` + +only execute the test in proxy+browser client + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `msg` | `string` | +| `func` | `Func` | + +#### Returns + +`Test` + +#### Defined in + +[packages/test/src/api/common.ts:567](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L567) + +--- + +### refresh + +▸ `Const` **refresh**(`ctx`, `wait?`, `clean?`): `Promise`<`void`\> + +reload the app + +#### Parameters + +| Name | Type | Default value | +| :------ | :-------------------------------------------------------- | :------------ | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | `undefined` | +| `wait` | `boolean` | `true` | +| `clean` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/common.ts:253](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L253) + +--- + +### remoteIt + +▸ `Const` **remoteIt**(`msg`, `func`): `Test` + +only execute the test in non-proxy browser + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `msg` | `string` | +| `func` | `Func` | + +#### Returns + +`Test` + +#### Defined in + +[packages/test/src/api/common.ts:552](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L552) + +--- + +### restart + +▸ `Const` **restart**(`ctx`): `Promise`<`void`\> + +restart the app + +#### Parameters + +| Name | Type | +| :---- | :-------------------------------------------------------- | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/common.ts:234](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L234) + +--- + +### setDebugMode + +▸ **setDebugMode**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/common.ts:585](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/common.ts#L585) diff --git a/docs/api/modules/kui_shell_test.ReplExpect.md b/docs/api/modules/kui_shell_test.ReplExpect.md new file mode 100644 index 00000000000..16f7e2093fd --- /dev/null +++ b/docs/api/modules/kui_shell_test.ReplExpect.md @@ -0,0 +1,758 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](kui_shell_test.md) / ReplExpect + +# Namespace: ReplExpect + +[@kui-shell/test](kui_shell_test.md).ReplExpect + +## Table of contents + +### Interfaces + +- [AppAndCount](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) + +### Functions + +- [blank](kui_shell_test.ReplExpect.md#blank) +- [blankWithOpts](kui_shell_test.ReplExpect.md#blankwithopts) +- [blockAfter](kui_shell_test.ReplExpect.md#blockafter) +- [blockCount](kui_shell_test.ReplExpect.md#blockcount) +- [comment](kui_shell_test.ReplExpect.md#comment) +- [consoleToBeClear](kui_shell_test.ReplExpect.md#consoletobeclear) +- [elsewhere](kui_shell_test.ReplExpect.md#elsewhere) +- [error](kui_shell_test.ReplExpect.md#error) +- [justOK](kui_shell_test.ReplExpect.md#justok) +- [ok](kui_shell_test.ReplExpect.md#ok) +- [okWith](kui_shell_test.ReplExpect.md#okwith) +- [okWithAny](kui_shell_test.ReplExpect.md#okwithany) +- [okWithCustom](kui_shell_test.ReplExpect.md#okwithcustom) +- [okWithDropDownList](kui_shell_test.ReplExpect.md#okwithdropdownlist) +- [okWithEvents](kui_shell_test.ReplExpect.md#okwithevents) +- [okWithOnly](kui_shell_test.ReplExpect.md#okwithonly) +- [okWithPtyOutput](kui_shell_test.ReplExpect.md#okwithptyoutput) +- [okWithPtyOutputEventually](kui_shell_test.ReplExpect.md#okwithptyoutputeventually) +- [okWithStreamingOutput](kui_shell_test.ReplExpect.md#okwithstreamingoutput) +- [okWithString](kui_shell_test.ReplExpect.md#okwithstring) +- [okWithStringEventually](kui_shell_test.ReplExpect.md#okwithstringeventually) +- [okWithTextContent](kui_shell_test.ReplExpect.md#okwithtextcontent) +- [splitCount](kui_shell_test.ReplExpect.md#splitcount) +- [tableWithNRows](kui_shell_test.ReplExpect.md#tablewithnrows) + +## Functions + +### blank + +▸ `Const` **blank**(`res`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:201](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L201) + +--- + +### blankWithOpts + +▸ `Const` **blankWithOpts**(`opts?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `opts` | `Object` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`boolean`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:198](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L198) + +--- + +### blockAfter + +▸ **blockAfter**(`res`, `delta?`): [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) + +Transform the given block finder to one that can find the next block + +#### Parameters + +| Name | Type | Default value | +| :------ | :---------------------------------------------------------------------- | :------------ | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | `undefined` | +| `delta` | `number` | `1` | + +#### Returns + +[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) + +#### Defined in + +[packages/test/src/api/repl-expect.ts:469](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L469) + +--- + +### blockCount + +▸ **blockCount**(): `Object` + +Verify that the number of blocks equals the expected count + +#### Returns + +`Object` + +| Name | Type | +| :-------- | :--------------------------------------------------------------------------------------- | +| `inSplit` | (`splitIndex`: `number`) => { `is`: (`expected`: `number` \| () => `number`) => `void` } | + +#### Defined in + +[packages/test/src/api/repl-expect.ts:437](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L437) + +--- + +### comment + +▸ **comment**(`expectedBody`, `expectedTitle?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +Expect a CommentaryResponse + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `expectedBody` | `string` | +| `expectedTitle?` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:413](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L413) + +--- + +### consoleToBeClear + +▸ `Const` **consoleToBeClear**(`app`, `residualBlockCount?`, `splitIndex?`): `Promise`<`boolean`\> + +The return type `any` comes from webdriverio waitUntil + +#### Parameters + +| Name | Type | Default value | +| :------------------- | :------------ | :------------ | +| `app` | `Application` | `undefined` | +| `residualBlockCount` | `number` | `1` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:204](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L204) + +--- + +### elsewhere + +▸ **elsewhere**(`expectedBody`, `N?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`Application`\> + +Expect an ElsewhereCommentaryResponse + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `expectedBody` | `string` | +| `N?` | `number` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`Application`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`Application`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:392](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L392) + +--- + +### error + +▸ `Const` **error**(`statusCode`, `expect?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`Application`\> + +#### Parameters + +| Name | Type | +| :----------- | :------------------- | +| `statusCode` | `string` \| `number` | +| `expect?` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`Application`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`Application`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:174](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L174) + +--- + +### justOK + +▸ `Const` **justOK**(`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +expect just ok, and no result value + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:353](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L353) + +--- + +### ok + +▸ `Const` **ok**(`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:168](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L168) + +--- + +### okWith + +▸ `Const` **okWith**(`entityName`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`boolean`\> + +expect ok and at least the given result value + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `entityName` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`boolean`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:350](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L350) + +--- + +### okWithAny + +▸ `Const` **okWithAny**(`res`): `Promise`<`boolean`\> + +as long as its ok, accept anything + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:342](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L342) + +--- + +### okWithCustom + +▸ `Const` **okWithCustom**<`T`\>(`custom`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`T`\> + +as long as its ok, accept anything + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------- | +| `T` | extends `string` \| `boolean` | + +#### Parameters + +| Name | Type | +| :------- | :----------- | +| `custom` | `CustomSpec` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`T`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`T`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:221](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L221) + +--- + +### okWithDropDownList + +▸ `Const` **okWithDropDownList**(`openAndExpectLabel`, `click?`, `closeAfterOpen?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------------------- | :-------- | :------------ | +| `openAndExpectLabel` | `string` | `undefined` | +| `click` | `boolean` | `false` | +| `closeAfterOpen` | `boolean` | `true` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:294](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L294) + +--- + +### okWithEvents + +▸ `Const` **okWithEvents**(`ctx`, `res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:325](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L325) + +--- + +### okWithOnly + +▸ `Const` **okWithOnly**(`entityName`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`boolean`\> + +expect ok and _only_ the given result value + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `entityName` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`boolean`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:345](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L345) + +--- + +### okWithPtyOutput + +▸ `Const` **okWithPtyOutput**(`expect`, `exact?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :------- | :-------- | :------------ | +| `expect` | `string` | `undefined` | +| `exact` | `boolean` | `false` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`boolean`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:266](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L266) + +--- + +### okWithPtyOutputEventually + +▸ `Const` **okWithPtyOutputEventually**(`expect`, `exact?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :------- | :-------- | :------------ | +| `expect` | `string` | `undefined` | +| `exact` | `boolean` | `false` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`boolean`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:281](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L281) + +--- + +### okWithStreamingOutput + +▸ `Const` **okWithStreamingOutput**(`expect`, `exact?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :------- | :-------- | :------------ | +| `expect` | `string` | `undefined` | +| `exact` | `boolean` | `false` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`boolean`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:265](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L265) + +--- + +### okWithString + +▸ `Const` **okWithString**(`expect`, `exact?`, `streaming?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :---------- | :-------- | :------------ | +| `expect` | `string` | `undefined` | +| `exact` | `boolean` | `false` | +| `streaming` | `boolean` | `false` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`boolean`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:252](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L252) + +--- + +### okWithStringEventually + +▸ `Const` **okWithStringEventually**(`expect`, `exact?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :------- | :-------- | :------------ | +| `expect` | `string` | `undefined` | +| `exact` | `boolean` | `false` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`boolean`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:268](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L268) + +--- + +### okWithTextContent + +▸ `Const` **okWithTextContent**(`expect`, `exact?`, `failFast?`, `sel?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :-------- | :------------ | +| `expect` | `string` | `undefined` | +| `exact` | `boolean` | `false` | +| `failFast` | `boolean` | `true` | +| `sel` | `string` | `' '` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`boolean`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:224](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L224) + +--- + +### splitCount + +▸ **splitCount**(`expectedSplitCount`, `inverseColors?`, `expectedSplitIndex?`): (`app`: `Application`) => `Promise`<`void`\> + +Expect the given number of terminal splits in the current tab, and check whether the last split has inverse colors + +#### Parameters + +| Name | Type | Default value | +| :-------------------- | :-------- | :------------ | +| `expectedSplitCount` | `number` | `undefined` | +| `inverseColors` | `boolean` | `false` | +| `expectedSplitIndex?` | `number` | `undefined` | + +#### Returns + +`fn` + +▸ (`app`): `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :---- | :------------ | +| `app` | `Application` | + +##### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:356](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L356) + +--- + +### tableWithNRows + +▸ **tableWithNRows**(`N`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<`boolean`\> + +Expect table with N rows + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<`boolean`\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/repl-expect.ts:379](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/repl-expect.ts#L379) diff --git a/docs/api/modules/kui_shell_test.Selectors.md b/docs/api/modules/kui_shell_test.Selectors.md new file mode 100644 index 00000000000..bfe457953a4 --- /dev/null +++ b/docs/api/modules/kui_shell_test.Selectors.md @@ -0,0 +1,4166 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](kui_shell_test.md) / Selectors + +# Namespace: Selectors + +[@kui-shell/test](kui_shell_test.md).Selectors + +## Table of contents + +### Variables + +- [BLOCK_CLOSE_BUTTON](kui_shell_test.Selectors.md#block_close_button) +- [BLOCK_UNPIN_BUTTON](kui_shell_test.Selectors.md#block_unpin_button) +- [BOTTOM_PROMPT](kui_shell_test.Selectors.md#bottom_prompt) +- [BOTTOM_PROMPT_BLOCK](kui_shell_test.Selectors.md#bottom_prompt_block) +- [COMMENTARY_EDITOR](kui_shell_test.Selectors.md#commentary_editor) +- [COMMENTARY_EDITOR_BUTTON_CANCEL](kui_shell_test.Selectors.md#commentary_editor_button_cancel) +- [COMMENTARY_EDITOR_BUTTON_DONE](kui_shell_test.Selectors.md#commentary_editor_button_done) +- [COMMENTARY_EDITOR_BUTTON_REVERT](kui_shell_test.Selectors.md#commentary_editor_button_revert) +- [CONFIRM_DIALOG](kui_shell_test.Selectors.md#confirm_dialog) +- [CONFIRM_DIALOG_CANCEL_BUTTON](kui_shell_test.Selectors.md#confirm_dialog_cancel_button) +- [CONFIRM_DIALOG_CONFIRM_BUTTON](kui_shell_test.Selectors.md#confirm_dialog_confirm_button) +- [CURRENT_MULTI_LINE_PROMPT](kui_shell_test.Selectors.md#current_multi_line_prompt) +- [CURRENT_PROMPT](kui_shell_test.Selectors.md#current_prompt) +- [CURRENT_PROMPT_BLOCK](kui_shell_test.Selectors.md#current_prompt_block) +- [CURRENT_TAB](kui_shell_test.Selectors.md#current_tab) +- [CURRENT_TAB_CLOSE](kui_shell_test.Selectors.md#current_tab_close) +- [CURRENT_TAB_TITLE](kui_shell_test.Selectors.md#current_tab_title) +- [DLIST](kui_shell_test.Selectors.md#dlist) +- [DROPDOWN](kui_shell_test.Selectors.md#dropdown) +- [EXPERIMENTAL_PROMPT_BLOCK_TAG](kui_shell_test.Selectors.md#experimental_prompt_block_tag) +- [INVERTED_COLORS](kui_shell_test.Selectors.md#inverted_colors) +- [LIST_RESULT_FIRST](kui_shell_test.Selectors.md#list_result_first) +- [NEW_SPLIT_BUTTON](kui_shell_test.Selectors.md#new_split_button) +- [N_ATTR](kui_shell_test.Selectors.md#n_attr) +- [OOPS](kui_shell_test.Selectors.md#oops) +- [OUTPUT_LAST](kui_shell_test.Selectors.md#output_last) +- [OUTPUT_LAST_PTY](kui_shell_test.Selectors.md#output_last_pty) +- [OUTPUT_LAST_STREAMING](kui_shell_test.Selectors.md#output_last_streaming) +- [OUTPUT_LAST_STREAMING_IN_NOTEBOOK](kui_shell_test.Selectors.md#output_last_streaming_in_notebook) +- [OVERFLOW_MENU](kui_shell_test.Selectors.md#overflow_menu) +- [PROCESSING_PROMPT_BLOCK](kui_shell_test.Selectors.md#processing_prompt_block) +- [PROMPT_BLOCK](kui_shell_test.Selectors.md#prompt_block) +- [PROMPT_BLOCK_FINAL](kui_shell_test.Selectors.md#prompt_block_final) +- [PROMPT_BLOCK_LAST](kui_shell_test.Selectors.md#prompt_block_last) +- [PROMPT_FINAL](kui_shell_test.Selectors.md#prompt_final) +- [PROMPT_LAST](kui_shell_test.Selectors.md#prompt_last) +- [RADIO_BUTTON](kui_shell_test.Selectors.md#radio_button) +- [RADIO_BUTTON_IS_SELECTED](kui_shell_test.Selectors.md#radio_button_is_selected) +- [RADIO_BUTTON_SELECTED](kui_shell_test.Selectors.md#radio_button_selected) +- [SIDECAR_LAST](kui_shell_test.Selectors.md#sidecar_last) +- [SIDECAR_TOOLBAR_LAST](kui_shell_test.Selectors.md#sidecar_toolbar_last) +- [SPLITS](kui_shell_test.Selectors.md#splits) +- [SPLIT_ID](kui_shell_test.Selectors.md#split_id) +- [STATUS_STRIPE](kui_shell_test.Selectors.md#status_stripe) +- [STATUS_STRIPE_BLOCK](kui_shell_test.Selectors.md#status_stripe_block) +- [STATUS_STRIPE_MESSAGE](kui_shell_test.Selectors.md#status_stripe_message) +- [STATUS_STRIPE_PROMPT](kui_shell_test.Selectors.md#status_stripe_prompt) +- [TAB_CONTENT](kui_shell_test.Selectors.md#tab_content) +- [TERMINAL_CARD](kui_shell_test.Selectors.md#terminal_card) +- [TERMINAL_CARD_BODY](kui_shell_test.Selectors.md#terminal_card_body) +- [TERMINAL_CARD_TITLE](kui_shell_test.Selectors.md#terminal_card_title) +- [TOP_TAB](kui_shell_test.Selectors.md#top_tab) +- [WELCOME_BLOCK](kui_shell_test.Selectors.md#welcome_block) +- [\_SIDECAR](kui_shell_test.Selectors.md#_sidecar) +- [\_TABLE_AS_GRID](kui_shell_test.Selectors.md#_table_as_grid) +- [\_TABLE_EMPTY](kui_shell_test.Selectors.md#_table_empty) +- [tabButtonSelector](kui_shell_test.Selectors.md#tabbuttonselector) + +### Functions + +- [ALT_BUFFER_N](kui_shell_test.Selectors.md#alt_buffer_n) +- [BLOCK_DOWN_BUTTON](kui_shell_test.Selectors.md#block_down_button) +- [BLOCK_LINK_BUTTON](kui_shell_test.Selectors.md#block_link_button) +- [BLOCK_REMOVE_BUTTON](kui_shell_test.Selectors.md#block_remove_button) +- [BLOCK_SECTION_BUTTON](kui_shell_test.Selectors.md#block_section_button) +- [BLOCK_UP_BUTTON](kui_shell_test.Selectors.md#block_up_button) +- [BY_KEY](kui_shell_test.Selectors.md#by_key) +- [BY_NAME](kui_shell_test.Selectors.md#by_name) +- [COMMAND_COPY_BUTTON](kui_shell_test.Selectors.md#command_copy_button) +- [COMMAND_COPY_DONE_BUTTON](kui_shell_test.Selectors.md#command_copy_done_button) +- [COMMAND_RERUN_BUTTON](kui_shell_test.Selectors.md#command_rerun_button) +- [CURRENT_GRID_BY_NAME_FOR_SPLIT](kui_shell_test.Selectors.md#current_grid_by_name_for_split) +- [CURRENT_GRID_FOR_SPLIT](kui_shell_test.Selectors.md#current_grid_for_split) +- [CURRENT_GRID_OFFLINE_FOR_SPLIT](kui_shell_test.Selectors.md#current_grid_offline_for_split) +- [CURRENT_GRID_ONLINE_FOR_SPLIT](kui_shell_test.Selectors.md#current_grid_online_for_split) +- [CURRENT_PROMPT_BLOCK_FOR_SPLIT](kui_shell_test.Selectors.md#current_prompt_block_for_split) +- [CURRENT_PROMPT_FOR_SPLIT](kui_shell_test.Selectors.md#current_prompt_for_split) +- [DLIST_DESCRIPTION_FOR](kui_shell_test.Selectors.md#dlist_description_for) +- [DROPDOWN_MENU_ITEM_NAMED](kui_shell_test.Selectors.md#dropdown_menu_item_named) +- [DROPDOWN_N](kui_shell_test.Selectors.md#dropdown_n) +- [DROPDOWN_N_MENU_ITEM](kui_shell_test.Selectors.md#dropdown_n_menu_item) +- [EXPANDABLE_OUTPUT_LAST](kui_shell_test.Selectors.md#expandable_output_last) +- [EXPANDABLE_OUTPUT_LAST_IN_NOTEBOOK](kui_shell_test.Selectors.md#expandable_output_last_in_notebook) +- [EXPANDABLE_OUTPUT_N](kui_shell_test.Selectors.md#expandable_output_n) +- [GRID_CELL_BY_NAME](kui_shell_test.Selectors.md#grid_cell_by_name) +- [LIST_RESULTS_BY_NAME_N](kui_shell_test.Selectors.md#list_results_by_name_n) +- [LIST_RESULTS_N](kui_shell_test.Selectors.md#list_results_n) +- [LIST_RESULT_BY_N_AND_NAME](kui_shell_test.Selectors.md#list_result_by_n_and_name) +- [LIST_RESULT_BY_N_FOR_NAME](kui_shell_test.Selectors.md#list_result_by_n_for_name) +- [OK_N](kui_shell_test.Selectors.md#ok_n) +- [OUTPUT_LAST_FOR_SPLIT](kui_shell_test.Selectors.md#output_last_for_split) +- [OUTPUT_LAST_FOR_SPLIT_IN_NOTEBOOK](kui_shell_test.Selectors.md#output_last_for_split_in_notebook) +- [OUTPUT_LAST_IN_NOTEBOOK](kui_shell_test.Selectors.md#output_last_in_notebook) +- [OUTPUT_LAST_PTY_IN_NOTEBOOK](kui_shell_test.Selectors.md#output_last_pty_in_notebook) +- [OUTPUT_N](kui_shell_test.Selectors.md#output_n) +- [OUTPUT_N_PTY](kui_shell_test.Selectors.md#output_n_pty) +- [OUTPUT_N_STREAMING](kui_shell_test.Selectors.md#output_n_streaming) +- [POPOVER_SELECT_OPTION](kui_shell_test.Selectors.md#popover_select_option) +- [PROCESSING_N](kui_shell_test.Selectors.md#processing_n) +- [PROMPT_BLOCK_FOR_SPLIT](kui_shell_test.Selectors.md#prompt_block_for_split) +- [PROMPT_BLOCK_LAST_FOR_SPLIT](kui_shell_test.Selectors.md#prompt_block_last_for_split) +- [PROMPT_BLOCK_LAST_FOR_SPLIT_IN_NOTEBOOK](kui_shell_test.Selectors.md#prompt_block_last_for_split_in_notebook) +- [PROMPT_BLOCK_LAST_IN_NOTEBOOK](kui_shell_test.Selectors.md#prompt_block_last_in_notebook) +- [PROMPT_BLOCK_MENU](kui_shell_test.Selectors.md#prompt_block_menu) +- [PROMPT_BLOCK_N](kui_shell_test.Selectors.md#prompt_block_n) +- [PROMPT_BLOCK_N_FOR_SPLIT](kui_shell_test.Selectors.md#prompt_block_n_for_split) +- [PROMPT_CONTEXT_N](kui_shell_test.Selectors.md#prompt_context_n) +- [PROMPT_LAST_IN_NOTEBOOK](kui_shell_test.Selectors.md#prompt_last_in_notebook) +- [PROMPT_N](kui_shell_test.Selectors.md#prompt_n) +- [PROMPT_N_FOR_SPLIT](kui_shell_test.Selectors.md#prompt_n_for_split) +- [RADIO_BUTTON_BY_NAME](kui_shell_test.Selectors.md#radio_button_by_name) +- [SIDECAR](kui_shell_test.Selectors.md#sidecar) +- [SIDECAR_ACTIVATION_TITLE](kui_shell_test.Selectors.md#sidecar_activation_title) +- [SIDECAR_ALERT](kui_shell_test.Selectors.md#sidecar_alert) +- [SIDECAR_BACK_BUTTON](kui_shell_test.Selectors.md#sidecar_back_button) +- [SIDECAR_BACK_BUTTON_DISABLED](kui_shell_test.Selectors.md#sidecar_back_button_disabled) +- [SIDECAR_BADGES](kui_shell_test.Selectors.md#sidecar_badges) +- [SIDECAR_BASE](kui_shell_test.Selectors.md#sidecar_base) +- [SIDECAR_BREADCRUMBS](kui_shell_test.Selectors.md#sidecar_breadcrumbs) +- [SIDECAR_CLOSE_BUTTON](kui_shell_test.Selectors.md#sidecar_close_button) +- [SIDECAR_CONTENT](kui_shell_test.Selectors.md#sidecar_content) +- [SIDECAR_CUSTOM_CONTENT](kui_shell_test.Selectors.md#sidecar_custom_content) +- [SIDECAR_CUSTOM_CONTENT_LINE_NUMBERS](kui_shell_test.Selectors.md#sidecar_custom_content_line_numbers) +- [SIDECAR_FORWARD_BUTTON](kui_shell_test.Selectors.md#sidecar_forward_button) +- [SIDECAR_FORWARD_BUTTON_DISABLED](kui_shell_test.Selectors.md#sidecar_forward_button_disabled) +- [SIDECAR_FULLY_CLOSED](kui_shell_test.Selectors.md#sidecar_fully_closed) +- [SIDECAR_FULLY_CLOSE_BUTTON](kui_shell_test.Selectors.md#sidecar_fully_close_button) +- [SIDECAR_HEADER_NAVIGATION](kui_shell_test.Selectors.md#sidecar_header_navigation) +- [SIDECAR_HERO_TITLE](kui_shell_test.Selectors.md#sidecar_hero_title) +- [SIDECAR_KIND](kui_shell_test.Selectors.md#sidecar_kind) +- [SIDECAR_LEFTNAV](kui_shell_test.Selectors.md#sidecar_leftnav) +- [SIDECAR_LEFTNAV_NAV](kui_shell_test.Selectors.md#sidecar_leftnav_nav) +- [SIDECAR_LEFTNAV_TITLE](kui_shell_test.Selectors.md#sidecar_leftnav_title) +- [SIDECAR_MODE_BUTTON](kui_shell_test.Selectors.md#sidecar_mode_button) +- [SIDECAR_MODE_BUTTONS](kui_shell_test.Selectors.md#sidecar_mode_buttons) +- [SIDECAR_MODE_BUTTONS_V2](kui_shell_test.Selectors.md#sidecar_mode_buttons_v2) +- [SIDECAR_MODE_BUTTON_SELECTED](kui_shell_test.Selectors.md#sidecar_mode_button_selected) +- [SIDECAR_MODE_BUTTON_SELECTED_V2](kui_shell_test.Selectors.md#sidecar_mode_button_selected_v2) +- [SIDECAR_MODE_BUTTON_V2](kui_shell_test.Selectors.md#sidecar_mode_button_v2) +- [SIDECAR_NAV_COMMAND_LINKS](kui_shell_test.Selectors.md#sidecar_nav_command_links) +- [SIDECAR_NAV_HREF_LINKS](kui_shell_test.Selectors.md#sidecar_nav_href_links) +- [SIDECAR_PACKAGE_NAME_TITLE](kui_shell_test.Selectors.md#sidecar_package_name_title) +- [SIDECAR_PACKAGE_PARAMETERS](kui_shell_test.Selectors.md#sidecar_package_parameters) +- [SIDECAR_POPUP_HERO_TITLE](kui_shell_test.Selectors.md#sidecar_popup_hero_title) +- [SIDECAR_POPUP_TITLE](kui_shell_test.Selectors.md#sidecar_popup_title) +- [SIDECAR_RESUME_FROM_CLOSE_BUTTON](kui_shell_test.Selectors.md#sidecar_resume_from_close_button) +- [SIDECAR_TAB_CONTENT](kui_shell_test.Selectors.md#sidecar_tab_content) +- [SIDECAR_TITLE](kui_shell_test.Selectors.md#sidecar_title) +- [SIDECAR_TOOLBAR](kui_shell_test.Selectors.md#sidecar_toolbar) +- [SIDECAR_TOOLBAR_BUTTON](kui_shell_test.Selectors.md#sidecar_toolbar_button) +- [SIDECAR_TOOLBAR_BUTTON_LAST](kui_shell_test.Selectors.md#sidecar_toolbar_button_last) +- [SIDECAR_TOOLBAR_TEXT](kui_shell_test.Selectors.md#sidecar_toolbar_text) +- [SIDECAR_TOOLBAR_TEXT_LAST](kui_shell_test.Selectors.md#sidecar_toolbar_text_last) +- [SIDECAR_WEB_ACTION_URL](kui_shell_test.Selectors.md#sidecar_web_action_url) +- [SIDECAR_WITH_FAILURE](kui_shell_test.Selectors.md#sidecar_with_failure) +- [SOURCE_REF_N](kui_shell_test.Selectors.md#source_ref_n) +- [SOURCE_REF_TOGGLE_N](kui_shell_test.Selectors.md#source_ref_toggle_n) +- [SPLIT_N](kui_shell_test.Selectors.md#split_n) +- [SPLIT_N_AS_BOTTOM_STRIP](kui_shell_test.Selectors.md#split_n_as_bottom_strip) +- [SPLIT_N_AS_DEFAULT](kui_shell_test.Selectors.md#split_n_as_default) +- [SPLIT_N_AS_LEFT_STRIP](kui_shell_test.Selectors.md#split_n_as_left_strip) +- [SPLIT_N_CLEAR](kui_shell_test.Selectors.md#split_n_clear) +- [SPLIT_N_CLOSE](kui_shell_test.Selectors.md#split_n_close) +- [SPLIT_N_FOCUS](kui_shell_test.Selectors.md#split_n_focus) +- [SPLIT_N_HEADER](kui_shell_test.Selectors.md#split_n_header) +- [SPLIT_N_MENU](kui_shell_test.Selectors.md#split_n_menu) +- [SPLIT_N_OUTPUT](kui_shell_test.Selectors.md#split_n_output) +- [SPLIT_N_POSITION_TOGGLE](kui_shell_test.Selectors.md#split_n_position_toggle) +- [STATUS_STRIPE_DROPDOWN_LABEL](kui_shell_test.Selectors.md#status_stripe_dropdown_label) +- [STATUS_STRIPE_TYPE](kui_shell_test.Selectors.md#status_stripe_type) +- [STATUS_STRIPE_WIDGET](kui_shell_test.Selectors.md#status_stripe_widget) +- [STATUS_STRIPE_WIDGET_ICON_WITH_ATTR](kui_shell_test.Selectors.md#status_stripe_widget_icon_with_attr) +- [STATUS_STRIPE_WIDGET_LABEL](kui_shell_test.Selectors.md#status_stripe_widget_label) +- [STATUS_STRIPE_WIDGET_LABEL_WITH_ATTR](kui_shell_test.Selectors.md#status_stripe_widget_label_with_attr) +- [STATUS_STRIPE_WIDGET_WITH_ATTR](kui_shell_test.Selectors.md#status_stripe_widget_with_attr) +- [TABLE_AS_GRID](kui_shell_test.Selectors.md#table_as_grid) +- [TABLE_AS_GRID_CELL](kui_shell_test.Selectors.md#table_as_grid_cell) +- [TABLE_AS_GRID_CELL_GREEN](kui_shell_test.Selectors.md#table_as_grid_cell_green) +- [TABLE_AS_GRID_CELL_RED](kui_shell_test.Selectors.md#table_as_grid_cell_red) +- [TABLE_AS_LIST](kui_shell_test.Selectors.md#table_as_list) +- [TABLE_AS_SEQUENCE](kui_shell_test.Selectors.md#table_as_sequence) +- [TABLE_AS_SEQUENCE_BAR](kui_shell_test.Selectors.md#table_as_sequence_bar) +- [TABLE_AS_SEQUENCE_BAR_WIDTH](kui_shell_test.Selectors.md#table_as_sequence_bar_width) +- [TABLE_CELL](kui_shell_test.Selectors.md#table_cell) +- [TABLE_FOOTER](kui_shell_test.Selectors.md#table_footer) +- [TABLE_FOOTER_MESSAGE](kui_shell_test.Selectors.md#table_footer_message) +- [TABLE_FOOTER_MESSAGE_LINK](kui_shell_test.Selectors.md#table_footer_message_link) +- [TABLE_HEADER_CELL](kui_shell_test.Selectors.md#table_header_cell) +- [TABLE_HISTOGRAM_TEXT](kui_shell_test.Selectors.md#table_histogram_text) +- [TABLE_HISTOGRAM_TEXT_WITH_ID](kui_shell_test.Selectors.md#table_histogram_text_with_id) +- [TABLE_PAGINATION_BACKWARD](kui_shell_test.Selectors.md#table_pagination_backward) +- [TABLE_PAGINATION_FORWARD](kui_shell_test.Selectors.md#table_pagination_forward) +- [TABLE_SHOW_AS_GRID](kui_shell_test.Selectors.md#table_show_as_grid) +- [TABLE_SHOW_AS_HISTOGRAM](kui_shell_test.Selectors.md#table_show_as_histogram) +- [TABLE_SHOW_AS_LIST](kui_shell_test.Selectors.md#table_show_as_list) +- [TABLE_SHOW_AS_SEQUENCE](kui_shell_test.Selectors.md#table_show_as_sequence) +- [TABLE_TITLE](kui_shell_test.Selectors.md#table_title) +- [TABLE_TITLE_NROWS](kui_shell_test.Selectors.md#table_title_nrows) +- [TABLE_TITLE_SECONDARY](kui_shell_test.Selectors.md#table_title_secondary) +- [TAB_N](kui_shell_test.Selectors.md#tab_n) +- [TAB_SELECTED_N](kui_shell_test.Selectors.md#tab_selected_n) +- [TAB_TITLE_N](kui_shell_test.Selectors.md#tab_title_n) +- [TERMINAL_ALERT](kui_shell_test.Selectors.md#terminal_alert) +- [TOP_TAB_CLOSE_N](kui_shell_test.Selectors.md#top_tab_close_n) +- [TOP_TAB_N](kui_shell_test.Selectors.md#top_tab_n) +- [TOP_TAB_N_CLICKABLE](kui_shell_test.Selectors.md#top_tab_n_clickable) +- [TOP_TAB_WITH_TITLE](kui_shell_test.Selectors.md#top_tab_with_title) +- [WATCHER_CLOSE_BUTTON](kui_shell_test.Selectors.md#watcher_close_button) +- [WATCHER_N](kui_shell_test.Selectors.md#watcher_n) +- [WATCHER_N_CLOSE](kui_shell_test.Selectors.md#watcher_n_close) +- [WATCHER_N_DROPDOWN](kui_shell_test.Selectors.md#watcher_n_dropdown) +- [WATCHER_N_DROPDOWN_ITEM](kui_shell_test.Selectors.md#watcher_n_dropdown_item) +- [WATCHER_N_GRID_CELL](kui_shell_test.Selectors.md#watcher_n_grid_cell) +- [WATCHER_N_GRID_CELL_OFFLINE](kui_shell_test.Selectors.md#watcher_n_grid_cell_offline) +- [WATCHER_N_GRID_CELL_ONLINE](kui_shell_test.Selectors.md#watcher_n_grid_cell_online) +- [WATCHER_N_GRID_CELL_PENDING](kui_shell_test.Selectors.md#watcher_n_grid_cell_pending) +- [WATCHER_N_SHOW_AS_TABLE](kui_shell_test.Selectors.md#watcher_n_show_as_table) +- [WATCHER_N_TITLE](kui_shell_test.Selectors.md#watcher_n_title) +- [WATCH_LIVE_BUTTON](kui_shell_test.Selectors.md#watch_live_button) +- [WATCH_OFFLINE_BUTTON](kui_shell_test.Selectors.md#watch_offline_button) +- [\_PROMPT_BLOCK_N](kui_shell_test.Selectors.md#_prompt_block_n) +- [xtermRows](kui_shell_test.Selectors.md#xtermrows) + +## Variables + +### BLOCK_CLOSE_BUTTON + +• **BLOCK_CLOSE_BUTTON**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:319](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L319) + +--- + +### BLOCK_UNPIN_BUTTON + +• **BLOCK_UNPIN_BUTTON**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:320](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L320) + +--- + +### BOTTOM_PROMPT + +• **BOTTOM_PROMPT**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:48](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L48) + +--- + +### BOTTOM_PROMPT_BLOCK + +• **BOTTOM_PROMPT_BLOCK**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:47](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L47) + +--- + +### COMMENTARY_EDITOR + +• **COMMENTARY_EDITOR**: `".kui--commentary .kui--source-ref-editor"` + +#### Defined in + +[packages/test/src/api/selectors.ts:362](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L362) + +--- + +### COMMENTARY_EDITOR_BUTTON_CANCEL + +• **COMMENTARY_EDITOR_BUTTON_CANCEL**: `".kui--commentary-editor-toolbar .kui--commentary-button.kui--commentary-cancel-button"` + +#### Defined in + +[packages/test/src/api/selectors.ts:356](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L356) + +--- + +### COMMENTARY_EDITOR_BUTTON_DONE + +• **COMMENTARY_EDITOR_BUTTON_DONE**: `".kui--commentary-editor-toolbar .kui--commentary-button.kui--commentary-done-button"` + +#### Defined in + +[packages/test/src/api/selectors.ts:358](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L358) + +--- + +### COMMENTARY_EDITOR_BUTTON_REVERT + +• **COMMENTARY_EDITOR_BUTTON_REVERT**: `".kui--commentary-editor-toolbar .kui--commentary-button.kui--commentary-revert-button"` + +#### Defined in + +[packages/test/src/api/selectors.ts:360](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L360) + +--- + +### CONFIRM_DIALOG + +• **CONFIRM_DIALOG**: `"#confirm-dialog"` + +Confirm Dialog + +#### Defined in + +[packages/test/src/api/selectors.ts:379](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L379) + +--- + +### CONFIRM_DIALOG_CANCEL_BUTTON + +• **CONFIRM_DIALOG_CANCEL_BUTTON**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:381](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L381) + +--- + +### CONFIRM_DIALOG_CONFIRM_BUTTON + +• **CONFIRM_DIALOG_CONFIRM_BUTTON**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:380](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L380) + +--- + +### CURRENT_MULTI_LINE_PROMPT + +• **CURRENT_MULTI_LINE_PROMPT**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:43](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L43) + +--- + +### CURRENT_PROMPT + +• **CURRENT_PROMPT**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:42](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L42) + +--- + +### CURRENT_PROMPT_BLOCK + +• **CURRENT_PROMPT_BLOCK**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:36](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L36) + +--- + +### CURRENT_TAB + +• **CURRENT_TAB**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:24](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L24) + +--- + +### CURRENT_TAB_CLOSE + +• **CURRENT_TAB_CLOSE**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:26](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L26) + +--- + +### CURRENT_TAB_TITLE + +• **CURRENT_TAB_TITLE**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L25) + +--- + +### DLIST + +• **DLIST**: `".kui--description-list"` + +DescriptionList + +#### Defined in + +[packages/test/src/api/selectors.ts:392](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L392) + +--- + +### DROPDOWN + +• **DROPDOWN**: `".kui--dropdown"` + +dropdown + +#### Defined in + +[packages/test/src/api/selectors.ts:372](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L372) + +--- + +### EXPERIMENTAL_PROMPT_BLOCK_TAG + +• **EXPERIMENTAL_PROMPT_BLOCK_TAG**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:216](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L216) + +--- + +### INVERTED_COLORS + +• **INVERTED_COLORS**: `".kui--inverted-color-context"` + +#### Defined in + +[packages/test/src/api/selectors.ts:147](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L147) + +--- + +### LIST_RESULT_FIRST + +• **LIST_RESULT_FIRST**: `"tbody tr:first-child .clickable"` + +#### Defined in + +[packages/test/src/api/selectors.ts:285](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L285) + +--- + +### NEW_SPLIT_BUTTON + +• **NEW_SPLIT_BUTTON**: `"#kui--split-terminal-button"` + +Terminal splits + +#### Defined in + +[packages/test/src/api/selectors.ts:153](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L153) + +--- + +### N_ATTR + +• **N_ATTR**: `"data-input-count"` + +#### Defined in + +[packages/test/src/api/selectors.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L44) + +--- + +### OOPS + +• **OOPS**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:51](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L51) + +--- + +### OUTPUT_LAST + +• **OUTPUT_LAST**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:195](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L195) + +--- + +### OUTPUT_LAST_PTY + +• **OUTPUT_LAST_PTY**: `string` = `OUTPUT_LAST` + +#### Defined in + +[packages/test/src/api/selectors.ts:200](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L200) + +--- + +### OUTPUT_LAST_STREAMING + +• **OUTPUT_LAST_STREAMING**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:197](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L197) + +--- + +### OUTPUT_LAST_STREAMING_IN_NOTEBOOK + +• **OUTPUT_LAST_STREAMING_IN_NOTEBOOK**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:198](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L198) + +--- + +### OVERFLOW_MENU + +• **OVERFLOW_MENU**: `".kui--repl-block-right-element.kui--toolbar-button-with-icon"` + +#### Defined in + +[packages/test/src/api/selectors.ts:218](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L218) + +--- + +### PROCESSING_PROMPT_BLOCK + +• **PROCESSING_PROMPT_BLOCK**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:35](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L35) + +--- + +### PROMPT_BLOCK + +• **PROMPT_BLOCK**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:34](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L34) + +--- + +### PROMPT_BLOCK_FINAL + +• **PROMPT_BLOCK_FINAL**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:217](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L217) + +--- + +### PROMPT_BLOCK_LAST + +• **PROMPT_BLOCK_LAST**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:179](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L179) + +--- + +### PROMPT_FINAL + +• **PROMPT_FINAL**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:229](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L229) + +--- + +### PROMPT_LAST + +• **PROMPT_LAST**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:190](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L190) + +--- + +### RADIO_BUTTON + +• **RADIO_BUTTON**: `".kui--radio-table-body .kui--radio-table-row"` + +Selectors of radio button (new RadioTable-based) + +#### Defined in + +[packages/test/src/api/selectors.ts:346](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L346) + +--- + +### RADIO_BUTTON_IS_SELECTED + +• **RADIO_BUTTON_IS_SELECTED**: `"[data-is-selected]"` + +#### Defined in + +[packages/test/src/api/selectors.ts:348](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L348) + +--- + +### RADIO_BUTTON_SELECTED + +• **RADIO_BUTTON_SELECTED**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:349](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L349) + +--- + +### SIDECAR_LAST + +• **SIDECAR_LAST**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:364](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L364) + +--- + +### SIDECAR_TOOLBAR_LAST + +• **SIDECAR_TOOLBAR_LAST**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:365](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L365) + +--- + +### SPLITS + +• **SPLITS**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:154](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L154) + +--- + +### SPLIT_ID + +• **SPLIT_ID**: `"data-scrollback-id"` + +#### Defined in + +[packages/test/src/api/selectors.ts:155](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L155) + +--- + +### STATUS_STRIPE + +• **STATUS_STRIPE**: `"#kui--status-stripe"` + +Status Stripe widgets + +#### Defined in + +[packages/test/src/api/selectors.ts:326](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L326) + +--- + +### STATUS_STRIPE_BLOCK + +• **STATUS_STRIPE_BLOCK**: `".kui--status-stripe .kui--input-stripe .repl-block"` + +#### Defined in + +[packages/test/src/api/selectors.ts:49](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L49) + +--- + +### STATUS_STRIPE_MESSAGE + +• **STATUS_STRIPE_MESSAGE**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:328](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L328) + +--- + +### STATUS_STRIPE_PROMPT + +• **STATUS_STRIPE_PROMPT**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:50](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L50) + +--- + +### TAB_CONTENT + +• **TAB_CONTENT**: `".kui--tab-content"` + +#### Defined in + +[packages/test/src/api/selectors.ts:23](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L23) + +--- + +### TERMINAL_CARD + +• **TERMINAL_CARD**: `".kui--card"` + +Terminal card + +#### Defined in + +[packages/test/src/api/selectors.ts:207](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L207) + +--- + +### TERMINAL_CARD_BODY + +• **TERMINAL_CARD_BODY**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:209](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L209) + +--- + +### TERMINAL_CARD_TITLE + +• **TERMINAL_CARD_TITLE**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:208](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L208) + +--- + +### TOP_TAB + +• **TOP_TAB**: `".kui--tab-list > .kui--tab"` + +#### Defined in + +[packages/test/src/api/selectors.ts:18](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L18) + +--- + +### WELCOME_BLOCK + +• **WELCOME_BLOCK**: `string` + +#### Defined in + +[packages/test/src/api/selectors.ts:46](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L46) + +--- + +### \_SIDECAR + +• **\_SIDECAR**: `".kui--sidecar"` + +#### Defined in + +[packages/test/src/api/selectors.ts:52](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L52) + +--- + +### \_TABLE_AS_GRID + +• **\_TABLE_AS_GRID**: `".kui--data-table-as-grid"` + +#### Defined in + +[packages/test/src/api/selectors.ts:263](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L263) + +--- + +### \_TABLE_EMPTY + +• **\_TABLE_EMPTY**: `".kui--table-like-wrapper tbody td[data-is-empty=\"true\"]"` + +#### Defined in + +[packages/test/src/api/selectors.ts:275](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L275) + +--- + +### tabButtonSelector + +• **tabButtonSelector**: `"#new-tab-button"` + +#### Defined in + +[packages/test/src/api/selectors.ts:396](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L396) + +## Functions + +### ALT_BUFFER_N + +▸ `Const` **ALT_BUFFER_N**(`N`): `string` + +xterm + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:323](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L323) + +--- + +### BLOCK_DOWN_BUTTON + +▸ `Const` **BLOCK_DOWN_BUTTON**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:222](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L222) + +--- + +### BLOCK_LINK_BUTTON + +▸ `Const` **BLOCK_LINK_BUTTON**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:224](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L224) + +--- + +### BLOCK_REMOVE_BUTTON + +▸ `Const` **BLOCK_REMOVE_BUTTON**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:220](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L220) + +--- + +### BLOCK_SECTION_BUTTON + +▸ `Const` **BLOCK_SECTION_BUTTON**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:223](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L223) + +--- + +### BLOCK_UP_BUTTON + +▸ `Const` **BLOCK_UP_BUTTON**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:221](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L221) + +--- + +### BY_KEY + +▸ `Const` **BY_KEY**(`key`): `string` + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `key` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:283](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L283) + +--- + +### BY_NAME + +▸ `Const` **BY_NAME**(`name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:282](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L282) + +--- + +### COMMAND_COPY_BUTTON + +▸ `Const` **COMMAND_COPY_BUTTON**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:225](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L225) + +--- + +### COMMAND_COPY_DONE_BUTTON + +▸ `Const` **COMMAND_COPY_DONE_BUTTON**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:226](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L226) + +--- + +### COMMAND_RERUN_BUTTON + +▸ `Const` **COMMAND_RERUN_BUTTON**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:227](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L227) + +--- + +### CURRENT_GRID_BY_NAME_FOR_SPLIT + +▸ `Const` **CURRENT_GRID_BY_NAME_FOR_SPLIT**(`N`, `name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `N` | `number` | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:310](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L310) + +--- + +### CURRENT_GRID_FOR_SPLIT + +▸ `Const` **CURRENT_GRID_FOR_SPLIT**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:309](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L309) + +--- + +### CURRENT_GRID_OFFLINE_FOR_SPLIT + +▸ `Const` **CURRENT_GRID_OFFLINE_FOR_SPLIT**(`N`, `name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `N` | `number` | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:314](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L314) + +--- + +### CURRENT_GRID_ONLINE_FOR_SPLIT + +▸ `Const` **CURRENT_GRID_ONLINE_FOR_SPLIT**(`N`, `name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `N` | `number` | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:312](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L312) + +--- + +### CURRENT_PROMPT_BLOCK_FOR_SPLIT + +▸ `Const` **CURRENT_PROMPT_BLOCK_FOR_SPLIT**(`splitIndex`): `string` + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `splitIndex` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:169](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L169) + +--- + +### CURRENT_PROMPT_FOR_SPLIT + +▸ `Const` **CURRENT_PROMPT_FOR_SPLIT**(`splitIndex`): `string` + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `splitIndex` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:170](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L170) + +--- + +### DLIST_DESCRIPTION_FOR + +▸ `Const` **DLIST_DESCRIPTION_FOR**(`term`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `term` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:393](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L393) + +--- + +### DROPDOWN_MENU_ITEM_NAMED + +▸ `Const` **DROPDOWN_MENU_ITEM_NAMED**(`label`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `label` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:374](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L374) + +--- + +### DROPDOWN_N + +▸ `Const` **DROPDOWN_N**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:373](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L373) + +--- + +### DROPDOWN_N_MENU_ITEM + +▸ `Const` **DROPDOWN_N_MENU_ITEM**(`N`, `label`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `label` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:375](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L375) + +--- + +### EXPANDABLE_OUTPUT_LAST + +▸ `Const` **EXPANDABLE_OUTPUT_LAST**(`splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:386](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L386) + +--- + +### EXPANDABLE_OUTPUT_LAST_IN_NOTEBOOK + +▸ `Const` **EXPANDABLE_OUTPUT_LAST_IN_NOTEBOOK**(`splitIndex?`, `N?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `splitIndex` | `number` | `1` | +| `N` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:388](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L388) + +--- + +### EXPANDABLE_OUTPUT_N + +▸ `Const` **EXPANDABLE_OUTPUT_N**(`N`, `splitIndex?`): `string` + +Expandable output in notebooks + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:384](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L384) + +--- + +### GRID_CELL_BY_NAME + +▸ `Const` **GRID_CELL_BY_NAME**(`name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:284](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L284) + +--- + +### LIST_RESULTS_BY_NAME_N + +▸ `Const` **LIST_RESULTS_BY_NAME_N**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:234](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L234) + +--- + +### LIST_RESULTS_N + +▸ `Const` **LIST_RESULTS_N**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:230](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L230) + +--- + +### LIST_RESULT_BY_N_AND_NAME + +▸ `Const` **LIST_RESULT_BY_N_AND_NAME**(`N`, `name`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `name` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:286](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L286) + +--- + +### LIST_RESULT_BY_N_FOR_NAME + +▸ `Const` **LIST_RESULT_BY_N_FOR_NAME**(`N`, `name`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `name` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:240](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L240) + +--- + +### OK_N + +▸ `Const` **OK_N**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:288](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L288) + +--- + +### OUTPUT_LAST_FOR_SPLIT + +▸ `Const` **OUTPUT_LAST_FOR_SPLIT**(`splitIndex`): `string` + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `splitIndex` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:192](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L192) + +--- + +### OUTPUT_LAST_FOR_SPLIT_IN_NOTEBOOK + +▸ `Const` **OUTPUT_LAST_FOR_SPLIT_IN_NOTEBOOK**(`splitIndex`, `N?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `splitIndex` | `number` | `undefined` | +| `N` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:193](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L193) + +--- + +### OUTPUT_LAST_IN_NOTEBOOK + +▸ `Const` **OUTPUT_LAST_IN_NOTEBOOK**(`N?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :--- | :------- | :------------ | +| `N` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:196](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L196) + +--- + +### OUTPUT_LAST_PTY_IN_NOTEBOOK + +▸ `Const` **OUTPUT_LAST_PTY_IN_NOTEBOOK**(`N?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :--- | :------- | :------------ | +| `N` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:201](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L201) + +--- + +### OUTPUT_N + +▸ `Const` **OUTPUT_N**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:212](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L212) + +--- + +### OUTPUT_N_PTY + +▸ `Const` **OUTPUT_N_PTY**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:215](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L215) + +--- + +### OUTPUT_N_STREAMING + +▸ `Const` **OUTPUT_N_STREAMING**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:213](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L213) + +--- + +### POPOVER_SELECT_OPTION + +▸ `Const` **POPOVER_SELECT_OPTION**(`value`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `value` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:343](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L343) + +--- + +### PROCESSING_N + +▸ `Const` **PROCESSING_N**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:40](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L40) + +--- + +### PROMPT_BLOCK_FOR_SPLIT + +▸ `Const` **PROMPT_BLOCK_FOR_SPLIT**(`splitIndex`): `string` + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `splitIndex` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:172](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L172) + +--- + +### PROMPT_BLOCK_LAST_FOR_SPLIT + +▸ `Const` **PROMPT_BLOCK_LAST_FOR_SPLIT**(`splitIndex?`, `N?`, `inNotebook?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `splitIndex` | `number` | `1` | +| `N` | `number` | `1` | +| `inNotebook` | `boolean` | `false` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:183](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L183) + +--- + +### PROMPT_BLOCK_LAST_FOR_SPLIT_IN_NOTEBOOK + +▸ `Const` **PROMPT_BLOCK_LAST_FOR_SPLIT_IN_NOTEBOOK**(`splitIndex?`, `N?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `splitIndex` | `number` | `1` | +| `N` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:181](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L181) + +--- + +### PROMPT_BLOCK_LAST_IN_NOTEBOOK + +▸ `Const` **PROMPT_BLOCK_LAST_IN_NOTEBOOK**(`N?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :--- | :------- | :------------ | +| `N` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:180](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L180) + +--- + +### PROMPT_BLOCK_MENU + +▸ `Const` **PROMPT_BLOCK_MENU**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:219](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L219) + +--- + +### PROMPT_BLOCK_N + +▸ `Const` **PROMPT_BLOCK_N**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:38](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L38) + +--- + +### PROMPT_BLOCK_N_FOR_SPLIT + +▸ `Const` **PROMPT_BLOCK_N_FOR_SPLIT**(`N`, `splitIndex`): `string` + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `N` | `number` | +| `splitIndex` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:173](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L173) + +--- + +### PROMPT_CONTEXT_N + +▸ `Const` **PROMPT_CONTEXT_N**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:39](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L39) + +--- + +### PROMPT_LAST_IN_NOTEBOOK + +▸ `Const` **PROMPT_LAST_IN_NOTEBOOK**(`N?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :--- | :------- | :------------ | +| `N` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:191](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L191) + +--- + +### PROMPT_N + +▸ `Const` **PROMPT_N**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:211](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L211) + +--- + +### PROMPT_N_FOR_SPLIT + +▸ `Const` **PROMPT_N_FOR_SPLIT**(`N`, `splitIndex`): `string` + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `N` | `number` | +| `splitIndex` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:175](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L175) + +--- + +### RADIO_BUTTON_BY_NAME + +▸ `Const` **RADIO_BUTTON_BY_NAME**(`name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:347](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L347) + +--- + +### SIDECAR + +▸ `Const` **SIDECAR**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:55](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L55) + +--- + +### SIDECAR_ACTIVATION_TITLE + +▸ `Const` **SIDECAR_ACTIVATION_TITLE**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:58](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L58) + +--- + +### SIDECAR_ALERT + +▸ `Const` **SIDECAR_ALERT**(`N`, `type`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `type` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:94](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L94) + +--- + +### SIDECAR_BACK_BUTTON + +▸ `Const` **SIDECAR_BACK_BUTTON**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:129](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L129) + +--- + +### SIDECAR_BACK_BUTTON_DISABLED + +▸ `Const` **SIDECAR_BACK_BUTTON_DISABLED**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:131](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L131) + +--- + +### SIDECAR_BADGES + +▸ `Const` **SIDECAR_BADGES**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:80](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L80) + +--- + +### SIDECAR_BASE + +▸ `Const` **SIDECAR_BASE**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:54](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L54) + +--- + +### SIDECAR_BREADCRUMBS + +▸ `Const` **SIDECAR_BREADCRUMBS**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:68](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L68) + +--- + +### SIDECAR_CLOSE_BUTTON + +▸ `Const` **SIDECAR_CLOSE_BUTTON**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:138](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L138) + +--- + +### SIDECAR_CONTENT + +▸ `Const` **SIDECAR_CONTENT**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:75](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L75) + +--- + +### SIDECAR_CUSTOM_CONTENT + +▸ `Const` **SIDECAR_CUSTOM_CONTENT**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:103](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L103) + +--- + +### SIDECAR_CUSTOM_CONTENT_LINE_NUMBERS + +▸ `Const` **SIDECAR_CUSTOM_CONTENT_LINE_NUMBERS**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:105](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L105) + +--- + +### SIDECAR_FORWARD_BUTTON + +▸ `Const` **SIDECAR_FORWARD_BUTTON**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:133](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L133) + +--- + +### SIDECAR_FORWARD_BUTTON_DISABLED + +▸ `Const` **SIDECAR_FORWARD_BUTTON_DISABLED**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:135](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L135) + +--- + +### SIDECAR_FULLY_CLOSED + +▸ `Const` **SIDECAR_FULLY_CLOSED**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:144](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L144) + +--- + +### SIDECAR_FULLY_CLOSE_BUTTON + +▸ `Const` **SIDECAR_FULLY_CLOSE_BUTTON**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:142](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L142) + +--- + +### SIDECAR_HEADER_NAVIGATION + +▸ `Const` **SIDECAR_HEADER_NAVIGATION**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:66](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L66) + +--- + +### SIDECAR_HERO_TITLE + +▸ `Const` **SIDECAR_HERO_TITLE**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:62](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L62) + +--- + +### SIDECAR_KIND + +▸ `Const` **SIDECAR_KIND**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:74](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L74) + +--- + +### SIDECAR_LEFTNAV + +▸ `Const` **SIDECAR_LEFTNAV**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:117](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L117) + +--- + +### SIDECAR_LEFTNAV_NAV + +▸ `Const` **SIDECAR_LEFTNAV_NAV**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:118](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L118) + +--- + +### SIDECAR_LEFTNAV_TITLE + +▸ `Const` **SIDECAR_LEFTNAV_TITLE**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:64](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L64) + +--- + +### SIDECAR_MODE_BUTTON + +▸ `Const` **SIDECAR_MODE_BUTTON**(`N`, `mode`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `mode` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:111](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L111) + +--- + +### SIDECAR_MODE_BUTTONS + +▸ `Const` **SIDECAR_MODE_BUTTONS**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:109](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L109) + +--- + +### SIDECAR_MODE_BUTTONS_V2 + +▸ `Const` **SIDECAR_MODE_BUTTONS_V2**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:123](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L123) + +--- + +### SIDECAR_MODE_BUTTON_SELECTED + +▸ `Const` **SIDECAR_MODE_BUTTON_SELECTED**(`N`, `mode`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `mode` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:113](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L113) + +--- + +### SIDECAR_MODE_BUTTON_SELECTED_V2 + +▸ `Const` **SIDECAR_MODE_BUTTON_SELECTED_V2**(`N`, `mode`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `mode` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:126](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L126) + +--- + +### SIDECAR_MODE_BUTTON_V2 + +▸ `Const` **SIDECAR_MODE_BUTTON_V2**(`N`, `mode`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `mode` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:124](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L124) + +--- + +### SIDECAR_NAV_COMMAND_LINKS + +▸ `Const` **SIDECAR_NAV_COMMAND_LINKS**(`N`, `link`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `link` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:119](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L119) + +--- + +### SIDECAR_NAV_HREF_LINKS + +▸ `Const` **SIDECAR_NAV_HREF_LINKS**(`N`, `link`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `link` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:121](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L121) + +--- + +### SIDECAR_PACKAGE_NAME_TITLE + +▸ `Const` **SIDECAR_PACKAGE_NAME_TITLE**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:70](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L70) + +--- + +### SIDECAR_PACKAGE_PARAMETERS + +▸ `Const` **SIDECAR_PACKAGE_PARAMETERS**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:78](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L78) + +--- + +### SIDECAR_POPUP_HERO_TITLE + +▸ `Const` **SIDECAR_POPUP_HERO_TITLE**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:73](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L73) + +--- + +### SIDECAR_POPUP_TITLE + +▸ `Const` **SIDECAR_POPUP_TITLE**(`N`, `splitIndex?`, `clickable?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | +| `clickable` | `boolean` | `true` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:72](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L72) + +--- + +### SIDECAR_RESUME_FROM_CLOSE_BUTTON + +▸ `Const` **SIDECAR_RESUME_FROM_CLOSE_BUTTON**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:140](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L140) + +--- + +### SIDECAR_TAB_CONTENT + +▸ `Const` **SIDECAR_TAB_CONTENT**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:101](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L101) + +--- + +### SIDECAR_TITLE + +▸ `Const` **SIDECAR_TITLE**(`N`, `splitIndex?`, `clickable?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | +| `clickable` | `boolean` | `true` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:60](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L60) + +--- + +### SIDECAR_TOOLBAR + +▸ `Const` **SIDECAR_TOOLBAR**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:83](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L83) + +--- + +### SIDECAR_TOOLBAR_BUTTON + +▸ `Const` **SIDECAR_TOOLBAR_BUTTON**(`N`, `mode`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `mode` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:87](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L87) + +--- + +### SIDECAR_TOOLBAR_BUTTON_LAST + +▸ `Const` **SIDECAR_TOOLBAR_BUTTON_LAST**(`mode`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `mode` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:368](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L368) + +--- + +### SIDECAR_TOOLBAR_TEXT + +▸ `Const` **SIDECAR_TOOLBAR_TEXT**(`N`, `type`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `type` | `string` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:85](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L85) + +--- + +### SIDECAR_TOOLBAR_TEXT_LAST + +▸ `Const` **SIDECAR_TOOLBAR_TEXT_LAST**(`type`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `type` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:366](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L366) + +--- + +### SIDECAR_WEB_ACTION_URL + +▸ `Const` **SIDECAR_WEB_ACTION_URL**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:76](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L76) + +--- + +### SIDECAR_WITH_FAILURE + +▸ `Const` **SIDECAR_WITH_FAILURE**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:56](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L56) + +--- + +### SOURCE_REF_N + +▸ `Const` **SOURCE_REF_N**(`N`, `splitIndex?`): `string` + +SourceRef + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:352](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L352) + +--- + +### SOURCE_REF_TOGGLE_N + +▸ `Const` **SOURCE_REF_TOGGLE_N**(`N`, `expanded?`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `N` | `number` | `undefined` | +| `expanded` | `boolean` | `false` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:353](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L353) + +--- + +### SPLIT_N + +▸ `Const` **SPLIT_N**(`N`, `inverseColors?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :-------------- | :-------- | :------------ | +| `N` | `number` | `undefined` | +| `inverseColors` | `boolean` | `false` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:156](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L156) + +--- + +### SPLIT_N_AS_BOTTOM_STRIP + +▸ `Const` **SPLIT_N_AS_BOTTOM_STRIP**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:167](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L167) + +--- + +### SPLIT_N_AS_DEFAULT + +▸ `Const` **SPLIT_N_AS_DEFAULT**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:165](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L165) + +--- + +### SPLIT_N_AS_LEFT_STRIP + +▸ `Const` **SPLIT_N_AS_LEFT_STRIP**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:166](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L166) + +--- + +### SPLIT_N_CLEAR + +▸ `Const` **SPLIT_N_CLEAR**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:161](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L161) + +--- + +### SPLIT_N_CLOSE + +▸ `Const` **SPLIT_N_CLOSE**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:159](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L159) + +--- + +### SPLIT_N_FOCUS + +▸ `Const` **SPLIT_N_FOCUS**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:162](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L162) + +--- + +### SPLIT_N_HEADER + +▸ `Const` **SPLIT_N_HEADER**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:158](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L158) + +--- + +### SPLIT_N_MENU + +▸ `Const` **SPLIT_N_MENU**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:317](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L317) + +--- + +### SPLIT_N_OUTPUT + +▸ `Const` **SPLIT_N_OUTPUT**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:163](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L163) + +--- + +### SPLIT_N_POSITION_TOGGLE + +▸ `Const` **SPLIT_N_POSITION_TOGGLE**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:160](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L160) + +--- + +### STATUS_STRIPE_DROPDOWN_LABEL + +▸ `Const` **STATUS_STRIPE_DROPDOWN_LABEL**(`which`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `which` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:333](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L333) + +--- + +### STATUS_STRIPE_TYPE + +▸ `Const` **STATUS_STRIPE_TYPE**(`type`): `string` + +#### Parameters + +| Name | Type | +| :----- | :---------------------- | +| `type` | `"default"` \| `"blue"` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:327](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L327) + +--- + +### STATUS_STRIPE_WIDGET + +▸ `Const` **STATUS_STRIPE_WIDGET**(`which`, `dot?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------------- | :------------ | +| `which` | `string` | `undefined` | +| `dot` | `"."` \| `"#"` | `'.'` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:329](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L329) + +--- + +### STATUS_STRIPE_WIDGET_ICON_WITH_ATTR + +▸ `Const` **STATUS_STRIPE_WIDGET_ICON_WITH_ATTR**(`which`, `key`, `value`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `which` | `string` | +| `key` | `string` | +| `value` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:335](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L335) + +--- + +### STATUS_STRIPE_WIDGET_LABEL + +▸ `Const` **STATUS_STRIPE_WIDGET_LABEL**(`which`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `which` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:332](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L332) + +--- + +### STATUS_STRIPE_WIDGET_LABEL_WITH_ATTR + +▸ `Const` **STATUS_STRIPE_WIDGET_LABEL_WITH_ATTR**(`which`, `key`, `value`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `which` | `string` | +| `key` | `string` | +| `value` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:337](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L337) + +--- + +### STATUS_STRIPE_WIDGET_WITH_ATTR + +▸ `Const` **STATUS_STRIPE_WIDGET_WITH_ATTR**(`which`, `key`, `value`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `which` | `string` | +| `key` | `string` | +| `value` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:330](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L330) + +--- + +### TABLE_AS_GRID + +▸ `Const` **TABLE_AS_GRID**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:264](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L264) + +--- + +### TABLE_AS_GRID_CELL + +▸ `Const` **TABLE_AS_GRID_CELL**(`N`, `name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `N` | `number` | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:265](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L265) + +--- + +### TABLE_AS_GRID_CELL_GREEN + +▸ `Const` **TABLE_AS_GRID_CELL_GREEN**(`N`, `name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `N` | `number` | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:268](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L268) + +--- + +### TABLE_AS_GRID_CELL_RED + +▸ `Const` **TABLE_AS_GRID_CELL_RED**(`N`, `name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `N` | `number` | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:267](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L267) + +--- + +### TABLE_AS_LIST + +▸ `Const` **TABLE_AS_LIST**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:269](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L269) + +--- + +### TABLE_AS_SEQUENCE + +▸ `Const` **TABLE_AS_SEQUENCE**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:271](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L271) + +--- + +### TABLE_AS_SEQUENCE_BAR + +▸ `Const` **TABLE_AS_SEQUENCE_BAR**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:272](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L272) + +--- + +### TABLE_AS_SEQUENCE_BAR_WIDTH + +▸ `Const` **TABLE_AS_SEQUENCE_BAR_WIDTH**(`N`, `width`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `N` | `number` | +| `width` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:273](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L273) + +--- + +### TABLE_CELL + +▸ `Const` **TABLE_CELL**(`rowKey`, `cellKey`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `rowKey` | `string` | +| `cellKey` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:243](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L243) + +--- + +### TABLE_FOOTER + +▸ `Const` **TABLE_FOOTER**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:258](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L258) + +--- + +### TABLE_FOOTER_MESSAGE + +▸ `Const` **TABLE_FOOTER_MESSAGE**(`N`, `M`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | +| `M` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:259](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L259) + +--- + +### TABLE_FOOTER_MESSAGE_LINK + +▸ `Const` **TABLE_FOOTER_MESSAGE_LINK**(`N`, `M`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | +| `M` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:261](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L261) + +--- + +### TABLE_HEADER_CELL + +▸ `Const` **TABLE_HEADER_CELL**(`cellKey`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `cellKey` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:242](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L242) + +--- + +### TABLE_HISTOGRAM_TEXT + +▸ `Const` **TABLE_HISTOGRAM_TEXT**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:248](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L248) + +--- + +### TABLE_HISTOGRAM_TEXT_WITH_ID + +▸ `Const` **TABLE_HISTOGRAM_TEXT_WITH_ID**(`id`, `N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `id` | `string` | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:249](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L249) + +--- + +### TABLE_PAGINATION_BACKWARD + +▸ `Const` **TABLE_PAGINATION_BACKWARD**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:256](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L256) + +--- + +### TABLE_PAGINATION_FORWARD + +▸ `Const` **TABLE_PAGINATION_FORWARD**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:254](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L254) + +--- + +### TABLE_SHOW_AS_GRID + +▸ `Const` **TABLE_SHOW_AS_GRID**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:244](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L244) + +--- + +### TABLE_SHOW_AS_HISTOGRAM + +▸ `Const` **TABLE_SHOW_AS_HISTOGRAM**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:247](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L247) + +--- + +### TABLE_SHOW_AS_LIST + +▸ `Const` **TABLE_SHOW_AS_LIST**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:246](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L246) + +--- + +### TABLE_SHOW_AS_SEQUENCE + +▸ `Const` **TABLE_SHOW_AS_SEQUENCE**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:245](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L245) + +--- + +### TABLE_TITLE + +▸ `Const` **TABLE_TITLE**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:278](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L278) + +--- + +### TABLE_TITLE_NROWS + +▸ `Const` **TABLE_TITLE_NROWS**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:281](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L281) + +--- + +### TABLE_TITLE_SECONDARY + +▸ `Const` **TABLE_TITLE_SECONDARY**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:280](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L280) + +--- + +### TAB_N + +▸ `Const` **TAB_N**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:28](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L28) + +--- + +### TAB_SELECTED_N + +▸ `Const` **TAB_SELECTED_N**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:29](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L29) + +--- + +### TAB_TITLE_N + +▸ `Const` **TAB_TITLE_N**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:27](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L27) + +--- + +### TERMINAL_ALERT + +▸ `Const` **TERMINAL_ALERT**(`type`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `type` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:98](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L98) + +--- + +### TOP_TAB_CLOSE_N + +▸ `Const` **TOP_TAB_CLOSE_N**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:21](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L21) + +--- + +### TOP_TAB_N + +▸ `Const` **TOP_TAB_N**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:19](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L19) + +--- + +### TOP_TAB_N_CLICKABLE + +▸ `Const` **TOP_TAB_N_CLICKABLE**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:20](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L20) + +--- + +### TOP_TAB_WITH_TITLE + +▸ `Const` **TOP_TAB_WITH_TITLE**(`title`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `title` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:22](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L22) + +--- + +### WATCHER_CLOSE_BUTTON + +▸ `Const` **WATCHER_CLOSE_BUTTON**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:318](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L318) + +--- + +### WATCHER_N + +▸ `Const` **WATCHER_N**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:291](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L291) + +--- + +### WATCHER_N_CLOSE + +▸ `Const` **WATCHER_N_CLOSE**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:306](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L306) + +--- + +### WATCHER_N_DROPDOWN + +▸ `Const` **WATCHER_N_DROPDOWN**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:303](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L303) + +--- + +### WATCHER_N_DROPDOWN_ITEM + +▸ `Const` **WATCHER_N_DROPDOWN_ITEM**(`N`, `label`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `N` | `number` | +| `label` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:304](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L304) + +--- + +### WATCHER_N_GRID_CELL + +▸ `Const` **WATCHER_N_GRID_CELL**(`N`, `name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `N` | `number` | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:293](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L293) + +--- + +### WATCHER_N_GRID_CELL_OFFLINE + +▸ `Const` **WATCHER_N_GRID_CELL_OFFLINE**(`N`, `name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `N` | `number` | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:297](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L297) + +--- + +### WATCHER_N_GRID_CELL_ONLINE + +▸ `Const` **WATCHER_N_GRID_CELL_ONLINE**(`N`, `name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `N` | `number` | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:295](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L295) + +--- + +### WATCHER_N_GRID_CELL_PENDING + +▸ `Const` **WATCHER_N_GRID_CELL_PENDING**(`N`, `name`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `N` | `number` | +| `name` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:299](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L299) + +--- + +### WATCHER_N_SHOW_AS_TABLE + +▸ `Const` **WATCHER_N_SHOW_AS_TABLE**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:307](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L307) + +--- + +### WATCHER_N_TITLE + +▸ `Const` **WATCHER_N_TITLE**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:302](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L302) + +--- + +### WATCH_LIVE_BUTTON + +▸ `Const` **WATCH_LIVE_BUTTON**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:250](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L250) + +--- + +### WATCH_OFFLINE_BUTTON + +▸ `Const` **WATCH_OFFLINE_BUTTON**(`N`, `splitIndex?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `N` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:252](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L252) + +--- + +### \_PROMPT_BLOCK_N + +▸ `Const` **\_PROMPT_BLOCK_N**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L37) + +--- + +### xtermRows + +▸ `Const` **xtermRows**(`N`): `string` + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `N` | `number` | + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/selectors.ts:289](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/selectors.ts#L289) diff --git a/docs/api/modules/kui_shell_test.SidecarExpect.md b/docs/api/modules/kui_shell_test.SidecarExpect.md new file mode 100644 index 00000000000..f2d50a4744e --- /dev/null +++ b/docs/api/modules/kui_shell_test.SidecarExpect.md @@ -0,0 +1,969 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](kui_shell_test.md) / SidecarExpect + +# Namespace: SidecarExpect + +[@kui-shell/test](kui_shell_test.md).SidecarExpect + +## Table of contents + +### Functions + +- [badge](kui_shell_test.SidecarExpect.md#badge) +- [breadcrumbs](kui_shell_test.SidecarExpect.md#breadcrumbs) +- [button](kui_shell_test.SidecarExpect.md#button) +- [closed](kui_shell_test.SidecarExpect.md#closed) +- [defaultMode](kui_shell_test.SidecarExpect.md#defaultmode) +- [descriptionList](kui_shell_test.SidecarExpect.md#descriptionlist) +- [form](kui_shell_test.SidecarExpect.md#form) +- [fullyClosed](kui_shell_test.SidecarExpect.md#fullyclosed) +- [heroName](kui_shell_test.SidecarExpect.md#heroname) +- [keyToClose](kui_shell_test.SidecarExpect.md#keytoclose) +- [kind](kui_shell_test.SidecarExpect.md#kind) +- [mode](kui_shell_test.SidecarExpect.md#mode) +- [modes](kui_shell_test.SidecarExpect.md#modes) +- [name](kui_shell_test.SidecarExpect.md#name) +- [namehash](kui_shell_test.SidecarExpect.md#namehash) +- [namespace](kui_shell_test.SidecarExpect.md#namespace) +- [notOpen](kui_shell_test.SidecarExpect.md#notopen) +- [open](kui_shell_test.SidecarExpect.md#open) +- [openInBlockAfter](kui_shell_test.SidecarExpect.md#openinblockafter) +- [openWithFailure](kui_shell_test.SidecarExpect.md#openwithfailure) +- [popupTitle](kui_shell_test.SidecarExpect.md#popuptitle) +- [showing](kui_shell_test.SidecarExpect.md#showing) +- [showingLeftNav](kui_shell_test.SidecarExpect.md#showingleftnav) +- [showingNotClickable](kui_shell_test.SidecarExpect.md#showingnotclickable) +- [showingTopNav](kui_shell_test.SidecarExpect.md#showingtopnav) +- [tableContent](kui_shell_test.SidecarExpect.md#tablecontent) +- [textPlainContent](kui_shell_test.SidecarExpect.md#textplaincontent) +- [textPlainContentFromMonaco](kui_shell_test.SidecarExpect.md#textplaincontentfrommonaco) +- [toolbarAlert](kui_shell_test.SidecarExpect.md#toolbaralert) +- [toolbarText](kui_shell_test.SidecarExpect.md#toolbartext) +- [yaml](kui_shell_test.SidecarExpect.md#yaml) + +## Functions + +### badge + +▸ `Const` **badge**(`title`, `css?`, `absent?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +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`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:71](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L71) + +--- + +### breadcrumbs + +▸ **breadcrumbs**(`breadcrumbs`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :--------- | +| `breadcrumbs` | `string`[] | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:369](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L369) + +--- + +### button + +▸ `Const` **button**(`button`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `button` | `Object` | +| `button.label?` | `string` | +| `button.mode` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:91](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L91) + +--- + +### closed + +▸ `Const` **closed**(`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +either minimized or fully closed + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:60](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L60) + +--- + +### defaultMode + +▸ `Const` **defaultMode**(`expected`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `expected` | `Object` | +| `expected.label?` | `string` | +| `expected.mode` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:181](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L181) + +--- + +### descriptionList + +▸ `Const` **descriptionList**(`content`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +Expect DescriptionList content in the current tab + +#### Parameters + +| Name | Type | +| :-------- | :----------------------------------------------------- | +| `content` | `Record`<`string`, `string` \| `number` \| `boolean`\> | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:384](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L384) + +--- + +### form + +▸ **form**(`form`, `idPrefix?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +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`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:260](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L260) + +--- + +### fullyClosed + +▸ `Const` **fullyClosed**(`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +fully closed, not just minimized + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:52](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L52) + +--- + +### heroName + +▸ `Const` **heroName**(`count`, `expectedName`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `count` | `number` | +| `expectedName` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:145](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L145) + +--- + +### keyToClose + +▸ `Const` **keyToClose**(`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +close the sidecar by ESCAPE key + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:65](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L65) + +--- + +### kind + +▸ `Const` **kind**(`expectedKind`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `expectedKind` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:153](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L153) + +--- + +### mode + +▸ `Const` **mode**(`expectedMode`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `expectedMode` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:98](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L98) + +--- + +### modes + +▸ `Const` **modes**(`expected`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------------- | +| `expected` | { `dafaultMode?`: `boolean` ; `label?`: `string` ; `mode`: `string` }[] | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:157](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L157) + +--- + +### name + +▸ `Const` **name**(`count`, `expectedName`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `count` | `number` | +| `expectedName` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:143](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L143) + +--- + +### namehash + +▸ `Const` **namehash**(`count`, `expectedNameHash`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :----------------- | :------- | +| `count` | `number` | +| `expectedNameHash` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:147](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L147) + +--- + +### namespace + +▸ `Const` **namespace**(`expectedNamespace`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :------------------ | :------- | +| `expectedNamespace` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:150](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L150) + +--- + +### notOpen + +▸ `Const` **notOpen**(`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:37](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L37) + +--- + +### open + +▸ `Const` **open**(`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:25](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L25) + +--- + +### openInBlockAfter + +▸ **openInBlockAfter**(`res`, `delta?`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +Same as open(), but in the block proceding the given block + +#### Parameters + +| Name | Type | Default value | +| :------ | :---------------------------------------------------------------------- | :------------ | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | `undefined` | +| `delta` | `number` | `1` | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:33](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L33) + +--- + +### openWithFailure + +▸ `Const` **openWithFailure**(`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:44](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L44) + +--- + +### popupTitle + +▸ **popupTitle**(`res`, `expectedTitle`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | +| `expectedTitle` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:247](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L247) + +--- + +### showing + +▸ `Const` **showing**(`expectedName`, `expectedActivationId?`, `expectSubstringMatchOnName?`, `expectedPackageName?`, `expectType?`, `waitThisLong?`, `which?`, `clickable?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### 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`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:281](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L281) + +--- + +### showingLeftNav + +▸ `Const` **showingLeftNav**(`expectedName`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `expectedName` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:366](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L366) + +--- + +### showingNotClickable + +▸ `Const` **showingNotClickable**(`expectedName`, `expectedPackageName?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :--------------------- | :------- | +| `expectedName` | `string` | +| `expectedPackageName?` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:360](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L360) + +--- + +### showingTopNav + +▸ `Const` **showingTopNav**(`expectedName`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `expectedName` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:363](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L363) + +--- + +### tableContent + +▸ **tableContent**(`res`, `nRows`, `nCells`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | +| `nRows` | `number` | +| `nCells` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:227](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L227) + +--- + +### textPlainContent + +▸ `Const` **textPlainContent**(`content`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `content` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:201](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L201) + +--- + +### textPlainContentFromMonaco + +▸ `Const` **textPlainContentFromMonaco**(`expectedText`, `exact?`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------------- | :-------- | :------------ | +| `expectedText` | `string` | `undefined` | +| `exact` | `boolean` | `true` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:206](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L206) + +--- + +### toolbarAlert + +▸ `Const` **toolbarAlert**(`expect`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :-------------- | :-------- | +| `expect` | `Object` | +| `expect.exact?` | `boolean` | +| `expect.text` | `string` | +| `expect.type` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:124](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L124) + +--- + +### toolbarText + +▸ `Const` **toolbarText**(`expect`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :---------------- | :-------- | +| `expect` | `Object` | +| `expect.exact?` | `boolean` | +| `expect.text` | `string` | +| `expect.timeout?` | `number` | +| `expect.type` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:112](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L112) + +--- + +### yaml + +▸ `Const` **yaml**(`content`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `content` | `object` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/sidecar-expect.ts:235](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/sidecar-expect.ts#L235) diff --git a/docs/api/modules/kui_shell_test.Util.md b/docs/api/modules/kui_shell_test.Util.md new file mode 100644 index 00000000000..f1c80a42938 --- /dev/null +++ b/docs/api/modules/kui_shell_test.Util.md @@ -0,0 +1,748 @@ +[Kui API Documentation - v10.8.0](../README.md) / [@kui-shell/test](kui_shell_test.md) / Util + +# Namespace: Util + +[@kui-shell/test](kui_shell_test.md).Util + +## Table of contents + +### Interfaces + +- [AppAndCount](../interfaces/kui_shell_test.Util.AppAndCount.md) + +### Functions + +- [clickBlockActionButton](kui_shell_test.Util.md#clickblockactionbutton) +- [clickNewTabButton](kui_shell_test.Util.md#clicknewtabbutton) +- [clickSidecarButtonCustomized](kui_shell_test.Util.md#clicksidecarbuttoncustomized) +- [clickSidecarModeButton](kui_shell_test.Util.md#clicksidecarmodebutton) +- [clickToExpandMonacoFold](kui_shell_test.Util.md#clicktoexpandmonacofold) +- [closeAllExceptFirstTab](kui_shell_test.Util.md#closeallexceptfirsttab) +- [copyBlockLink](kui_shell_test.Util.md#copyblocklink) +- [doCancel](kui_shell_test.Util.md#docancel) +- [doClear](kui_shell_test.Util.md#doclear) +- [doList](kui_shell_test.Util.md#dolist) +- [expectArray](kui_shell_test.Util.md#expectarray) +- [expectStruct](kui_shell_test.Util.md#expectstruct) +- [expectSubset](kui_shell_test.Util.md#expectsubset) +- [expectText](kui_shell_test.Util.md#expecttext) +- [expectYAML](kui_shell_test.Util.md#expectyaml) +- [expectYAMLSubset](kui_shell_test.Util.md#expectyamlsubset) +- [getValueFromMonaco](kui_shell_test.Util.md#getvaluefrommonaco) +- [listAndOpenSidecarNoWait](kui_shell_test.Util.md#listandopensidecarnowait) +- [markBlockAsSection](kui_shell_test.Util.md#markblockassection) +- [openSidecarByClick](kui_shell_test.Util.md#opensidecarbyclick) +- [outputOf](kui_shell_test.Util.md#outputof) +- [removeBlock](kui_shell_test.Util.md#removeblock) +- [rerunCommand](kui_shell_test.Util.md#reruncommand) +- [switchToTab](kui_shell_test.Util.md#switchtotab) +- [switchToTopLevelTabViaClick](kui_shell_test.Util.md#switchtotopleveltabviaclick) +- [tabCount](kui_shell_test.Util.md#tabcount) +- [uniqueFileForSnapshot](kui_shell_test.Util.md#uniquefileforsnapshot) +- [waitForXtermInput](kui_shell_test.Util.md#waitforxterminput) + +## Functions + +### clickBlockActionButton + +▸ **clickBlockActionButton**(`res`, `buttonSelector`): `Promise`<`void`\> + +Click the specified button action button + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md) | +| `buttonSelector` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/util.ts:317](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L317) + +--- + +### clickNewTabButton + +▸ **clickNewTabButton**(`ctx`, `expectedNewTabIndex`): `Promise`<`Application`\> + +#### Parameters + +| Name | Type | +| :-------------------- | :-------------------------------------------------------- | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | +| `expectedNewTabIndex` | `number` | + +#### Returns + +`Promise`<`Application`\> + +#### Defined in + +[packages/test/src/api/util.ts:490](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L490) + +--- + +### clickSidecarButtonCustomized + +▸ **clickSidecarButtonCustomized**(`ctx`, `res`, `selector`): `Promise`<`void`\> + +Click a sidecar button with `selector` + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------------------------- | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md) | +| `selector` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/util.ts:446](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L446) + +--- + +### clickSidecarModeButton + +▸ **clickSidecarModeButton**(`ctx`, `res`, `mode`): `Promise`<`void`\> + +Click sidecar mode button by `mode` + +#### Parameters + +| Name | Type | +| :----- | :---------------------------------------------------------------- | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md) | +| `mode` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/util.ts:435](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L435) + +--- + +### clickToExpandMonacoFold + +▸ **clickToExpandMonacoFold**(`res`, `lineIdx`): `Promise`<`void`\> + +Expand the fold on the given line of a monaco editor + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md) | +| `lineIdx` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/util.ts:183](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L183) + +--- + +### closeAllExceptFirstTab + +▸ **closeAllExceptFirstTab**(`expectedInitialNTabs`): `void` + +Close all except the first tab + +#### Parameters + +| Name | Type | +| :--------------------- | :------- | +| `expectedInitialNTabs` | `number` | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/util.ts:286](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L286) + +--- + +### copyBlockLink + +▸ **copyBlockLink**(`res`): `Promise`<`void`\> + +Click the section button on a block, and expect it to be a section + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/util.ts:340](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L340) + +--- + +### doCancel + +▸ **doCancel**(`cmd`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `cmd` | `string` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[packages/test/src/api/util.ts:453](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L453) + +--- + +### doClear + +▸ **doClear**(`residualBlockCount`, `splitIndex?`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | Default value | +| :------------------- | :------- | :------------ | +| `residualBlockCount` | `number` | `undefined` | +| `splitIndex` | `number` | `1` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[packages/test/src/api/util.ts:483](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L483) + +--- + +### doList + +▸ **doList**(`ctx`, `command`, `name`): `Promise`<`string`\> + +Execute `command` and expect a table with `name` + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------------------------------- | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | +| `command` | `string` | +| `name` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/test/src/api/util.ts:371](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L371) + +--- + +### expectArray + +▸ `Const` **expectArray**(`expected`, `failFast?`, `subset?`): (`actual`: `string` \| `string`[]) => `boolean` + +is the given actual array the same as the given expected array? + +#### Parameters + +| Name | Type | Default value | +| :--------- | :--------- | :------------ | +| `expected` | `string`[] | `undefined` | +| `failFast` | `boolean` | `true` | +| `subset` | `boolean` | `false` | + +#### Returns + +`fn` + +▸ (`actual`): `boolean` + +##### Parameters + +| Name | Type | +| :------- | :--------------------- | +| `actual` | `string` \| `string`[] | + +##### Returns + +`boolean` + +#### Defined in + +[packages/test/src/api/util.ts:157](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L157) + +--- + +### expectStruct + +▸ `Const` **expectStruct**(`struct1`, `noParse?`, `failFast?`): (`str`: `string`) => `boolean` + +is the given struct2 the same as the given struct2 (given as a string) + +#### Parameters + +| Name | Type | Default value | +| :--------- | :-------- | :------------ | +| `struct1` | `object` | `undefined` | +| `noParse` | `boolean` | `false` | +| `failFast` | `boolean` | `true` | + +#### Returns + +`fn` + +▸ (`str`): `boolean` + +##### Parameters + +| Name | Type | +| :---- | :------- | +| `str` | `string` | + +##### Returns + +`boolean` + +#### Defined in + +[packages/test/src/api/util.ts:119](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L119) + +--- + +### expectSubset + +▸ `Const` **expectSubset**(`struct1`, `failFast?`): (`str`: `string`) => `boolean` + +#### Parameters + +| Name | Type | Default value | +| :--------- | :-------- | :------------ | +| `struct1` | `object` | `undefined` | +| `failFast` | `boolean` | `true` | + +#### Returns + +`fn` + +▸ (`str`): `boolean` + +##### Parameters + +| Name | Type | +| :---- | :------- | +| `str` | `string` | + +##### Returns + +`boolean` + +#### Defined in + +[packages/test/src/api/util.ts:105](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L105) + +--- + +### expectText + +▸ `Const` **expectText**(`app`, `expectedText`, `exact?`, `timeout?`): (`selector`: `string`) => `Promise`<`Application`\> + +#### Parameters + +| Name | Type | Default value | +| :------------- | :------------ | :---------------- | +| `app` | `Application` | `undefined` | +| `expectedText` | `string` | `undefined` | +| `exact` | `boolean` | `true` | +| `timeout` | `number` | `CLI.waitTimeout` | + +#### Returns + +`fn` + +▸ (`selector`): `Promise`<`Application`\> + +##### Parameters + +| Name | Type | +| :--------- | :------- | +| `selector` | `string` | + +##### Returns + +`Promise`<`Application`\> + +#### Defined in + +[packages/test/src/api/util.ts:253](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L253) + +--- + +### expectYAML + +▸ `Const` **expectYAML**(`struct1`, `subset?`, `failFast?`): (`str`: `string`) => `boolean` + +#### Parameters + +| Name | Type | Default value | +| :--------- | :-------- | :------------ | +| `struct1` | `object` | `undefined` | +| `subset` | `boolean` | `false` | +| `failFast` | `boolean` | `true` | + +#### Returns + +`fn` + +▸ (`str`): `boolean` + +##### Parameters + +| Name | Type | +| :---- | :------- | +| `str` | `string` | + +##### Returns + +`boolean` + +#### Defined in + +[packages/test/src/api/util.ts:132](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L132) + +--- + +### expectYAMLSubset + +▸ `Const` **expectYAMLSubset**(`struct1`, `failFast?`): (`str`: `string`) => `boolean` + +#### Parameters + +| Name | Type | Default value | +| :--------- | :-------- | :------------ | +| `struct1` | `object` | `undefined` | +| `failFast` | `boolean` | `true` | + +#### Returns + +`fn` + +▸ (`str`): `boolean` + +##### Parameters + +| Name | Type | +| :---- | :------- | +| `str` | `string` | + +##### Returns + +`boolean` + +#### Defined in + +[packages/test/src/api/util.ts:154](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L154) + +--- + +### getValueFromMonaco + +▸ `Const` **getValueFromMonaco**(`res`, `container?`): `Promise`<`string`\> + +get the monaco editor text + +#### Parameters + +| Name | Type | +| :----------- | :---------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md) | +| `container?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/test/src/api/util.ts:214](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L214) + +--- + +### listAndOpenSidecarNoWait + +▸ **listAndOpenSidecarNoWait**(`ctx`, `command`, `name`, `mode?`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +Execute `command` and expect a table with `name`, +and then open sidecar by clicking the `name` + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------------------------------- | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | +| `command` | `string` | +| `name` | `string` | +| `mode?` | `string` | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/util.ts:426](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L426) + +--- + +### markBlockAsSection + +▸ **markBlockAsSection**(`res`): `Promise`<`void`\> + +Click the section button on a block, and expect it to be a section + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/util.ts:335](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L335) + +--- + +### openSidecarByClick + +▸ **openSidecarByClick**(`ctx`, `selector`, `name`, `mode?`, `activationId?`, `splitIndex?`, `inNotebook?`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Parameters + +| Name | Type | Default value | +| :-------------- | :-------------------------------------------------------- | :------------ | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | `undefined` | +| `selector` | `string` | `undefined` | +| `name` | `string` | `undefined` | +| `mode?` | `string` | `undefined` | +| `activationId?` | `string` | `undefined` | +| `splitIndex` | `number` | `2` | +| `inNotebook` | `boolean` | `false` | + +#### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.ReplExpect.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/util.ts:380](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L380) + +--- + +### outputOf + +▸ **outputOf**(`res`): `Promise`<`string`\> + +Output of the given block + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/test/src/api/util.ts:363](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L363) + +--- + +### removeBlock + +▸ **removeBlock**(`res`): `Promise`<`void`\> + +Click the close button on a block, and expect it to be gone + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/util.ts:330](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L330) + +--- + +### rerunCommand + +▸ **rerunCommand**(`res`): `Promise`<`void`\> + +Click the section button on a block, and expect it to be a section + +#### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/test/src/api/util.ts:345](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L345) + +--- + +### switchToTab + +▸ **switchToTab**(`mode`): (`res`: [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md)) => `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md)\> + +Switch sidecar tab + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `mode` | `string` | + +#### Returns + +`fn` + +▸ (`res`): `Promise`<[`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md)\> + +##### Parameters + +| Name | Type | +| :---- | :---------------------------------------------------------------- | +| `res` | [`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md) | + +##### Returns + +`Promise`<[`AppAndCount`](../interfaces/kui_shell_test.Util.AppAndCount.md)\> + +#### Defined in + +[packages/test/src/api/util.ts:350](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L350) + +--- + +### switchToTopLevelTabViaClick + +▸ **switchToTopLevelTabViaClick**(`ctx`, `N`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :---- | :-------------------------------------------------------- | +| `ctx` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | +| `N` | `number` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[packages/test/src/api/util.ts:474](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L474) + +--- + +### tabCount + +▸ **tabCount**(`app`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :---- | :------------ | +| `app` | `Application` | + +#### Returns + +`Promise`<`number`\> + +the current number of tabs + +#### Defined in + +[packages/test/src/api/util.ts:280](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L280) + +--- + +### uniqueFileForSnapshot + +▸ **uniqueFileForSnapshot**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/test/src/api/util.ts:312](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L312) + +--- + +### waitForXtermInput + +▸ `Const` **waitForXtermInput**(`app`, `N`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :---- | :------------ | +| `app` | `Application` | +| `N` | `number` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/test/src/api/util.ts:248](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/util.ts#L248) diff --git a/docs/api/modules/kui_shell_test.md b/docs/api/modules/kui_shell_test.md new file mode 100644 index 00000000000..cc696ab0c9e --- /dev/null +++ b/docs/api/modules/kui_shell_test.md @@ -0,0 +1,98 @@ +[Kui API Documentation - v10.8.0](../README.md) / @kui-shell/test + +# Module: @kui-shell/test + +## Table of contents + +### Namespaces + +- [CLI](kui_shell_test.CLI.md) +- [Common](kui_shell_test.Common.md) +- [ReplExpect](kui_shell_test.ReplExpect.md) +- [Selectors](kui_shell_test.Selectors.md) +- [SidecarExpect](kui_shell_test.SidecarExpect.md) +- [Util](kui_shell_test.Util.md) + +### Classes + +- [TestMMR](../classes/kui_shell_test.TestMMR.md) +- [TestNavResponse](../classes/kui_shell_test.TestNavResponse.md) +- [TestStringResponse](../classes/kui_shell_test.TestStringResponse.md) +- [TestTable](../classes/kui_shell_test.TestTable.md) + +### Type aliases + +- [MMRExpectMode](kui_shell_test.md#mmrexpectmode) + +### Variables + +- [Keys](kui_shell_test.md#keys) + +### Functions + +- [testAbout](kui_shell_test.md#testabout) + +## Type aliases + +### MMRExpectMode + +Ƭ **MMRExpectMode**: `Label` & `PlainTextContent` \| `YamlContentWithEditor` \| `TableContent` \| `ReactContent` + +#### Defined in + +[packages/test/src/api/mmr.ts:36](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/mmr.ts#L36) + +## Variables + +### Keys + +• **Keys**: `Object` + +#### Type declaration + +| Name | Type | +| :------------ | :-------------------------------------------- | +| `BACKSPACE` | `string` | +| `CONTROL` | `string` | +| `DELETE` | `string` | +| `Delete` | `string` | +| `ENTER` | `string` | +| `ESCAPE` | `string` | +| `End` | `string` | +| `Home` | `string` | +| `META` | `string` | +| `Numpad1` | `string` | +| `Numpad2` | `string` | +| `PageDown` | `string` | +| `PageUp` | `string` | +| `TAB` | `string` | +| `ctrlC` | `string`[] | +| `ctrlN` | `string`[] | +| `ctrlOrMeta` | `string` | +| `ctrlP` | `string`[] | +| `holdDownKey` | (`character`: `string`) => `Promise`<`void`\> | +| `releaseKey` | (`character`: `string`) => `Promise`<`void`\> | + +#### Defined in + +[packages/test/src/api/keys.ts:19](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/keys.ts#L19) + +## Functions + +### testAbout + +▸ `Const` **testAbout**(`self`): `void` + +#### Parameters + +| Name | Type | +| :----- | :-------------------------------------------------------- | +| `self` | [`ISuite`](../interfaces/kui_shell_test.Common.ISuite.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/test/src/api/NavResponse.ts:129](https://github.com/mra-ruiz/kui/blob/a3b5e3edf/packages/test/src/api/NavResponse.ts#L129) diff --git a/package-lock.json b/package-lock.json index 50f5355c83d..78a7ca9f4fb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5326,6 +5326,19 @@ "integrity": "sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==", "dev": true }, + "handlebars": { + "version": "4.7.7", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", + "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", + "dev": true, + "requires": { + "minimist": "^1.2.5", + "neo-async": "^2.6.0", + "source-map": "^0.6.1", + "uglify-js": "^3.1.4", + "wordwrap": "^1.0.0" + } + }, "har-schema": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", @@ -6556,6 +6569,12 @@ "minimist": "^1.2.5" } }, + "jsonc-parser": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.0.0.tgz", + "integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==", + "dev": true + }, "jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -7360,6 +7379,12 @@ "yallist": "^4.0.0" } }, + "lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, "make-dir": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-2.1.0.tgz", @@ -7386,6 +7411,12 @@ "repeat-string": "^1.0.0" } }, + "marked": { + "version": "3.0.8", + "resolved": "https://registry.npmjs.org/marked/-/marked-3.0.8.tgz", + "integrity": "sha512-0gVrAjo5m0VZSJb4rpL59K1unJAMb/hm8HRXqasD8VeC8m91ytDPMritgFSlKonfdt+rRYYpP/JfLxgIX8yoSw==", + "dev": true + }, "marky": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/marky/-/marky-1.2.2.tgz", @@ -8567,6 +8598,32 @@ "mimic-fn": "^2.1.0" } }, + "onigasm": { + "version": "2.2.5", + "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", + "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", + "dev": true, + "requires": { + "lru-cache": "^5.1.1" + }, + "dependencies": { + "lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "requires": { + "yallist": "^3.0.2" + } + }, + "yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true + } + } + }, "open": { "version": "8.4.0", "resolved": "https://registry.npmjs.org/open/-/open-8.4.0.tgz", @@ -10379,6 +10436,17 @@ "rechoir": "^0.6.2" } }, + "shiki": { + "version": "0.9.12", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.12.tgz", + "integrity": "sha512-VXcROdldv0/Qu0w2XvzU4IrvTeBNs/Kj/FCmtcEXGz7Tic/veQzliJj6tEiAgoKianhQstpYmbPDStHU5Opqcw==", + "dev": true, + "requires": { + "jsonc-parser": "^3.0.0", + "onigasm": "^2.2.5", + "vscode-textmate": "5.2.0" + } + }, "side-channel": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz", @@ -11558,6 +11626,28 @@ "integrity": "sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=", "dev": true }, + "typedoc": { + "version": "0.22.7", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.22.7.tgz", + "integrity": "sha512-ndxxp+tU1Wczvdxp4u2/PvT1qjD6hdFdSdehpORHjE+JXmMkl2bftXCR0upHmsnesBG7VCcr8vfgloGHIH8glQ==", + "dev": true, + "requires": { + "glob": "^7.2.0", + "lunr": "^2.3.9", + "marked": "^3.0.8", + "minimatch": "^3.0.4", + "shiki": "^0.9.12" + } + }, + "typedoc-plugin-markdown": { + "version": "3.11.3", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.11.3.tgz", + "integrity": "sha512-rWiHbEIe0oZetDIsBR24XJVxGOJ91kDcHoj2KhFKxCLoJGX659EKBQkHne9QJ4W2stGhu1fRgFyQaouSBnxukA==", + "dev": true, + "requires": { + "handlebars": "^4.7.7" + } + }, "typescript": { "version": "4.3.5", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.3.5.tgz", @@ -11570,6 +11660,13 @@ "integrity": "sha512-uXEtSresNUlXQ1QL4/3dQORcGv7+J2ookOG2ybA/ga9+HYEXueT2o+8dUJQkpedsyTyCJ6jCCirRcKtdtx1kbg==", "dev": true }, + "uglify-js": { + "version": "3.14.2", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.14.2.tgz", + "integrity": "sha512-rtPMlmcO4agTUfz10CbgJ1k6UAoXM2gWb3GoMPPZB/+/Ackf8lNWk11K4rYi2D0apgoFRLtQOZhb+/iGNJq26A==", + "dev": true, + "optional": true + }, "unbox-primitive": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz", @@ -12055,6 +12152,12 @@ "victory-core": "^35.11.4" } }, + "vscode-textmate": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", + "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", + "dev": true + }, "warning": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/warning/-/warning-4.0.3.tgz", @@ -12640,6 +12743,12 @@ "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==" }, + "wordwrap": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", + "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", + "dev": true + }, "workerpool": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.1.0.tgz", diff --git a/package.json b/package.json index cb85697718c..93a277454b5 100644 --- a/package.json +++ b/package.json @@ -103,9 +103,9 @@ "debug": "4.3.2", "electron": "11.5.0", "eslint": "6.8.0", - "eslint-plugin-header": "3.1.1", "eslint-config-prettier": "6.10.1", "eslint-config-standard": "14.1.1", + "eslint-plugin-header": "3.1.1", "eslint-plugin-import": "2.20.1", "eslint-plugin-node": "11.0.0", "eslint-plugin-promise": "4.2.1", @@ -121,6 +121,8 @@ "properties-parser": "0.3.1", "spectron": "13.0.0", "tmp": "0.2.1", + "typedoc": "0.22.7", + "typedoc-plugin-markdown": "3.11.3", "typescript": "4.3.5", "uuid": "8.3.2" }, diff --git a/packages/core/package.json b/packages/core/package.json index dda2d8f4474..9e4315fd9c6 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -24,6 +24,7 @@ "Mengting Yan" ], "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "bin": { diff --git a/packages/core/src/api/Events.ts b/packages/core/src/api/Events.ts new file mode 100644 index 00000000000..65f61a2d33f --- /dev/null +++ b/packages/core/src/api/Events.ts @@ -0,0 +1,29 @@ +/* + * Copyright 2017 The Kubernetes Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// eventChannelUnsafe +export { + default as eventChannelUnsafe, + wireToTabEvents, + wireToStandardEvents, + unwireToTabEvents, + unwireToStandardEvents, + eventBus, + NewTabRequestEvent, + SnapshotRequestEvent, + StatusStripeChangeEvent, + TabLayoutChangeEvent +} from '../core/events' diff --git a/packages/core/src/api/index.ts b/packages/core/src/api/index.ts new file mode 100644 index 00000000000..e5d32996898 --- /dev/null +++ b/packages/core/src/api/index.ts @@ -0,0 +1,18 @@ +/* + * Copyright 2021 The Kubernetes Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as Events from './Events' +export { Events } \ No newline at end of file diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts index 5e4d8370cf1..180b9a534cd 100644 --- a/packages/core/src/index.ts +++ b/packages/core/src/index.ts @@ -79,18 +79,7 @@ import * as pc from './core/usage/pretty-code' export { pc } // eventChannelUnsafe -export { - default as eventChannelUnsafe, - wireToTabEvents, - wireToStandardEvents, - unwireToTabEvents, - unwireToStandardEvents, - eventBus, - NewTabRequestEvent, - SnapshotRequestEvent, - StatusStripeChangeEvent, - TabLayoutChangeEvent -} from './core/events' +export * from './api' // i18n export { fromMap as i18nFromMap, default as i18n } from './util/i18n' diff --git a/packages/react/package.json b/packages/react/package.json index 837919f7a07..f6da30f43c1 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -8,6 +8,7 @@ "url": "https://github.com/IBM/kui/issues/new" }, "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "repository": { diff --git a/packages/test/package.json b/packages/test/package.json index 791817cc7ec..0b828386e53 100644 --- a/packages/test/package.json +++ b/packages/test/package.json @@ -5,6 +5,7 @@ "license": "Apache-2.0", "author": "Nick Mitchell", "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "scripts": { diff --git a/plugins/plugin-bash-like/fs/src/vfs/index.ts b/plugins/plugin-bash-like/fs/src/vfs/index.ts index 053c0f55608..95bb3a9e4d2 100644 --- a/plugins/plugin-bash-like/fs/src/vfs/index.ts +++ b/plugins/plugin-bash-like/fs/src/vfs/index.ts @@ -20,10 +20,10 @@ import { cwd, expandHomeDir, Arguments, + Events, ParsedOptions, REPL, Table, - eventBus, getCurrentTab, inBrowser } from '@kui-shell/core' @@ -187,7 +187,7 @@ export function mount(vfs: VFS | VFSProducingFunction, placeholderMountPath?: st if (!tab) { try { let debounce = false - eventBus.on('/tab/new', async tab => { + Events.eventBus.on('/tab/new', async tab => { try { if (!debounce) { debounce = true diff --git a/plugins/plugin-bash-like/package.json b/plugins/plugin-bash-like/package.json index 827dc6f1e3c..a030c31490c 100644 --- a/plugins/plugin-bash-like/package.json +++ b/plugins/plugin-bash-like/package.json @@ -20,6 +20,7 @@ "Mengting Yan" ], "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "dependencies": { diff --git a/plugins/plugin-bash-like/src/lib/cmds/export.ts b/plugins/plugin-bash-like/src/lib/cmds/export.ts index e7e26d68496..67e93ae914a 100644 --- a/plugins/plugin-bash-like/src/lib/cmds/export.ts +++ b/plugins/plugin-bash-like/src/lib/cmds/export.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Arguments, Registrar, SymbolTable, eventBus } from '@kui-shell/core' +import { Arguments, Events, Registrar, SymbolTable } from '@kui-shell/core' import { doExecWithStdoutViaPty } from './catchall' /** @@ -34,7 +34,7 @@ const exportCommand = async (args: Arguments) => { curDic[key] = value SymbolTable.write(tab, curDic) - eventBus.emitEnvUpdate(key, value) + Events.eventBus.emitEnvUpdate(key, value) return true } diff --git a/plugins/plugin-bash-like/src/pty/client.ts b/plugins/plugin-bash-like/src/pty/client.ts index de6f43879ba..33963ff4aed 100644 --- a/plugins/plugin-bash-like/src/pty/client.ts +++ b/plugins/plugin-bash-like/src/pty/client.ts @@ -26,10 +26,10 @@ import { Tab, Abortable, FlowControllable, - eventChannelUnsafe, XtermResponse, CodedError, inBrowser, + Events, ExecType, ExecOptions, disableInputQueueing @@ -68,7 +68,7 @@ function bumpGeneration() { } if (window) { window.addEventListener('resize', bumpGeneration) - eventChannelUnsafe.on('/zoom', bumpGeneration) + Events.eventChannelUnsafe.on('/zoom', bumpGeneration) } function getCachedSize(tab: Tab): Size { const cachedSize: Size = tab['_kui_pty_cachedSize'] @@ -533,8 +533,8 @@ async function initOnMessage( sawCode = /File exists/i.test(msg.data) ? 409 : /no such/i.test(msg.data) || /not found/i.test(msg.data) - ? 404 - : sawCode + ? 404 + : sawCode // setTimeout helps with batching setTimeout(() => { @@ -796,7 +796,7 @@ const getOrCreateChannel = async ( // when the websocket has closed, notify the user if (inBrowser()) { - const onClose = function(evt) { + const onClose = function (evt) { debug('channel has closed', evt.target, uuid) ws.removeEventListener('close', onClose) if (!tab.state.closed) { @@ -873,10 +873,10 @@ export const doExec = ( // theming // injectFont(terminal) // inject once on startup const doInjectTheme = () => injectFont(terminal, true) - eventChannelUnsafe.on('/theme/change', doInjectTheme) // and re-inject when the theme changes + Events.eventChannelUnsafe.on('/theme/change', doInjectTheme) // and re-inject when the theme changes resizer = new Resizer(terminal, tab, execOptions, ourUUID) - eventChannelUnsafe.once(`/command/stdout/done/${tab.uuid}/${execOptions.execUUID}`, () => { + Events.eventChannelUnsafe.once(`/command/stdout/done/${tab.uuid}/${execOptions.execUUID}`, () => { resizer.resize() }) @@ -888,11 +888,11 @@ export const doExec = ( injectFont(terminal, true) resizer.resize() } - eventChannelUnsafe.on('/zoom', doZoom) + Events.eventChannelUnsafe.on('/zoom', doZoom) const cleanupEventHandlers = () => { - eventChannelUnsafe.off('/zoom', doZoom) - eventChannelUnsafe.off('/theme/change', doInjectTheme) + Events.eventChannelUnsafe.off('/zoom', doZoom) + Events.eventChannelUnsafe.off('/theme/change', doInjectTheme) } // heuristic for hiding empty rows diff --git a/plugins/plugin-bash-like/src/pty/session.ts b/plugins/plugin-bash-like/src/pty/session.ts index 18117c8fcc0..6c37cdc16e5 100644 --- a/plugins/plugin-bash-like/src/pty/session.ts +++ b/plugins/plugin-bash-like/src/pty/session.ts @@ -18,7 +18,7 @@ import Debug from 'debug' -import { eventBus, inBrowser, CodedError, i18n, Tab, PreloadRegistrar } from '@kui-shell/core' +import { Events, inBrowser, CodedError, i18n, Tab, PreloadRegistrar } from '@kui-shell/core' import { Channel } from './channel' import { setOnline, setOffline } from './ui' @@ -109,8 +109,8 @@ async function newSessionForTab(tab: Tab) { /** Connection to Kui proxy has been severed */ export function invalidateSession(tab: Tab) { invalidateCache(tab) - eventBus.emit('/tab/offline', tab) - eventBus.emitWithTabId(`/tab/offline`, tab.state.uuid) + Events.eventBus.emit('/tab/offline', tab) + Events.eventBus.emitWithTabId(`/tab/offline`, tab.state.uuid) } /** diff --git a/plugins/plugin-bash-like/src/pty/ui.ts b/plugins/plugin-bash-like/src/pty/ui.ts index db38ed252a7..d425bfc2377 100644 --- a/plugins/plugin-bash-like/src/pty/ui.ts +++ b/plugins/plugin-bash-like/src/pty/ui.ts @@ -15,7 +15,7 @@ */ import Debug from 'debug' -import { eventChannelUnsafe } from '@kui-shell/core' +import { Events } from '@kui-shell/core' const debug = Debug('plugins/bash-like/pty/ui') @@ -25,7 +25,7 @@ const debug = Debug('plugins/bash-like/pty/ui') */ export function setOffline() { debug('setOffline') - eventChannelUnsafe.emit('/proxy/offline') + Events.eventChannelUnsafe.emit('/proxy/offline') } /** @@ -34,5 +34,5 @@ export function setOffline() { */ export function setOnline() { debug('setOnline') - eventChannelUnsafe.emit('/proxy/online') + Events.eventChannelUnsafe.emit('/proxy/online') } diff --git a/plugins/plugin-client-alternate/package.json b/plugins/plugin-client-alternate/package.json index cec4098c133..5f03d360a9f 100644 --- a/plugins/plugin-client-alternate/package.json +++ b/plugins/plugin-client-alternate/package.json @@ -3,6 +3,7 @@ "version": "10.7.0", "description": "", "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "scripts": { diff --git a/plugins/plugin-client-common/package.json b/plugins/plugin-client-common/package.json index 3f3516def23..15b50d98fa1 100644 --- a/plugins/plugin-client-common/package.json +++ b/plugins/plugin-client-common/package.json @@ -17,6 +17,7 @@ "plugin" ], "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "dependencies": { diff --git a/plugins/plugin-client-common/src/components/Client/InputStripe.tsx b/plugins/plugin-client-common/src/components/Client/InputStripe.tsx index 68277263d10..ac0003d5f76 100644 --- a/plugins/plugin-client-common/src/components/Client/InputStripe.tsx +++ b/plugins/plugin-client-common/src/components/Client/InputStripe.tsx @@ -15,7 +15,7 @@ */ import React, { PropsWithChildren } from 'react' -import { Tab as KuiTab, eventBus } from '@kui-shell/core' +import { Events, Tab as KuiTab } from '@kui-shell/core' import KuiContext from './context' import Block from '../Views/Terminal/Block' @@ -46,7 +46,7 @@ export default class InputStripe extends React.PureComponent { public constructor(props: Props) { super(props) - eventBus.onCommandComplete(this.props.uuid, this.onOutputRender.bind(this)) + Events.eventBus.onCommandComplete(this.props.uuid, this.onOutputRender.bind(this)) this.state = { idx: 0, diff --git a/plugins/plugin-client-common/src/components/Client/InputStripeExperimental.tsx b/plugins/plugin-client-common/src/components/Client/InputStripeExperimental.tsx index 338218024a7..3fd325d4589 100644 --- a/plugins/plugin-client-common/src/components/Client/InputStripeExperimental.tsx +++ b/plugins/plugin-client-common/src/components/Client/InputStripeExperimental.tsx @@ -15,7 +15,7 @@ */ import React from 'react' -import { Tab as KuiTab, eventBus } from '@kui-shell/core' +import { Events, Tab as KuiTab } from '@kui-shell/core' import Block from '../Views/Terminal/Block' import BlockModel, { Active } from '../Views/Terminal/Block/BlockModel' @@ -63,7 +63,7 @@ export default class InputStripe extends React.PureComponent { public constructor(props: Props) { super(props) - eventBus.onCommandComplete(this.props.uuid, this.onOutputRender.bind(this)) + Events.eventBus.onCommandComplete(this.props.uuid, this.onOutputRender.bind(this)) this.state = { idx: 0, diff --git a/plugins/plugin-client-common/src/components/Client/Kui.tsx b/plugins/plugin-client-common/src/components/Client/Kui.tsx index 55a8d702549..f5daf87c2f4 100644 --- a/plugins/plugin-client-common/src/components/Client/Kui.tsx +++ b/plugins/plugin-client-common/src/components/Client/Kui.tsx @@ -20,13 +20,13 @@ import Debug from 'debug' import React from 'react' import { + Events, i18n, REPL, Theme, pexecInCurrentTab, encodeComponent, inBrowser, - eventChannelUnsafe, findThemeByName, getPersistedThemeChoice, getDefaultTheme, @@ -112,7 +112,7 @@ export class Kui extends React.PureComponent { }) }) - eventChannelUnsafe.on('/theme/change', this.onThemeChange.bind(this)) + Events.eventChannelUnsafe.on('/theme/change', this.onThemeChange.bind(this)) setTimeout(async () => { const { theme } = await findThemeByName((await getPersistedThemeChoice()) || (await getDefaultTheme())) this.setState(curState => { diff --git a/plugins/plugin-client-common/src/components/Client/Popup.tsx b/plugins/plugin-client-common/src/components/Client/Popup.tsx index 3f89e754e17..bcab4474113 100644 --- a/plugins/plugin-client-common/src/components/Client/Popup.tsx +++ b/plugins/plugin-client-common/src/components/Client/Popup.tsx @@ -18,7 +18,7 @@ /* eslint-disable react/prop-types */ import React from 'react' -import { eventBus, Tab as KuiTab, teeToFile, pexecInCurrentTab } from '@kui-shell/core' +import { Events, Tab as KuiTab, teeToFile, pexecInCurrentTab } from '@kui-shell/core' import CommonClientProps from './props/Common' import InputStripe from '../Client/InputStripe' @@ -44,12 +44,12 @@ export default class Popup extends React.PureComponent { const tabModel = new TabModel() - eventBus.onceWithTabId('/tab/close/request', tabModel.uuid, async (_, tab: KuiTab) => { + Events.eventBus.onceWithTabId('/tab/close/request', tabModel.uuid, async (_, tab: KuiTab) => { // tab close is window close for the popup client tab.REPL.qexec('window close', undefined, undefined, { tab }) }) - eventBus.onCommandComplete(tabModel.uuid, async ({ tab, command, response }) => { + Events.eventBus.onCommandComplete(tabModel.uuid, async ({ tab, command, response }) => { if (process.env.KUI_TEE_TO_FILE) { // tee the response to a file // maybe in the future we could do this better diff --git a/plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx b/plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx index 97f17e3f799..fef922805c2 100644 --- a/plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx +++ b/plugins/plugin-client-common/src/components/Client/StatusStripe/CurrentWorkingDirectory.tsx @@ -17,7 +17,7 @@ import React from 'react' import { Icons, ViewLevel, TextWithIconWidget } from '../../../' -import { cwd, inBrowser, wireToStandardEvents, unwireToStandardEvents, i18n } from '@kui-shell/core' +import { cwd, Events, inBrowser, i18n } from '@kui-shell/core' const strings = i18n('plugin-client-common') @@ -61,12 +61,12 @@ export default class CurrentWorkingDirectory extends React.PureComponent { this.recomputeThemeList() - eventChannelUnsafe.on('/theme/change', ({ theme }: { theme: string }) => { + Events.eventChannelUnsafe.on('/theme/change', ({ theme }: { theme: string }) => { this.setState({ currentTheme: theme }) }) } diff --git a/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx b/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx index 03d0abfb6fd..0f296e2e0bf 100644 --- a/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx +++ b/plugins/plugin-client-common/src/components/Client/StatusStripe/index.tsx @@ -18,7 +18,7 @@ /* eslint-disable react/prop-types */ import React from 'react' -import { eventBus, pexecInCurrentTab, i18n, StatusStripeChangeEvent } from '@kui-shell/core' +import { Events, pexecInCurrentTab, i18n } from '@kui-shell/core' import Settings from './Settings' import Icons from '../../spi/Icons' @@ -29,14 +29,16 @@ import '../../../../web/scss/components/StatusStripe/StatusStripe.scss' const strings = i18n('plugin-client-common') -type State = StatusStripeChangeEvent +type State = Events.StatusStripeChangeEvent export type Props = Partial & { noHelp?: boolean noSettings?: boolean } /** see https://github.com/microsoft/TypeScript/issues/10485 */ -function hasType(evt: Partial): evt is Pick, 'type'> { +function hasType( + evt: Partial +): evt is Pick, 'type'> { return evt.type !== undefined } @@ -45,13 +47,15 @@ export default class StatusStripe extends React.PureComponent { public constructor(props: Props) { super(props) - eventBus.onStatusStripeChangeRequest(this.onChangeRequest.bind(this)) + Events.eventBus.onStatusStripeChangeRequest(this.onChangeRequest.bind(this)) this.state = this.withStateDefaults(props) } /** Overlay default values for required state variables */ - private withStateDefaults(evt: Partial): Omit, 'message'> { + private withStateDefaults( + evt: Partial + ): Omit, 'message'> { if (hasType(evt)) { return evt } else { @@ -60,7 +64,7 @@ export default class StatusStripe extends React.PureComponent { } /** Status Stripe change request */ - private onChangeRequest(evt: StatusStripeChangeEvent) { + private onChangeRequest(evt: Events.StatusStripeChangeEvent) { this.setState(this.withStateDefaults(evt)) } diff --git a/plugins/plugin-client-common/src/components/Client/TabContainer.tsx b/plugins/plugin-client-common/src/components/Client/TabContainer.tsx index 8bf56787174..8c9fc400364 100644 --- a/plugins/plugin-client-common/src/components/Client/TabContainer.tsx +++ b/plugins/plugin-client-common/src/components/Client/TabContainer.tsx @@ -17,7 +17,7 @@ import React from 'react' import { Page } from '@patternfly/react-core' -import { NewTabRequestEvent, Tab, eventBus, pexecInCurrentTab } from '@kui-shell/core' +import { Events, Tab, pexecInCurrentTab } from '@kui-shell/core' import TabModel, { TopTabButton } from './TabModel' import TabContent, { TabContentOptions } from './TabContent' @@ -62,7 +62,7 @@ export default class TabContainer extends React.PureComponent { activeIdx: 0 } - eventBus.on('/tab/new/request', (evt: NewTabRequestEvent) => { + Events.eventBus.on('/tab/new/request', (evt: Events.NewTabRequestEvent) => { // the protocol is: if we are opening multiple tabs in the // "foreground", then make sure the *first* of the new tabs is // active @@ -94,14 +94,14 @@ export default class TabContainer extends React.PureComponent { } }) - eventBus.on('/tab/switch/request', (idx: number) => { + Events.eventBus.on('/tab/switch/request', (idx: number) => { this.onSwitchTab(idx) }) - eventBus.on('/kui/tab/edit/toggle/index', (idx: number) => { + Events.eventBus.on('/kui/tab/edit/toggle/index', (idx: number) => { const tab = this.state.tabs[idx] if (tab && tab.uuid) { - eventBus.emitWithTabId('/kui/tab/edit/toggle', tab.uuid) + Events.eventBus.emitWithTabId('/kui/tab/edit/toggle', tab.uuid) } }) } @@ -136,7 +136,7 @@ export default class TabContainer extends React.PureComponent { }) } - setTimeout(() => eventBus.emit('/tab/switch/request/done', { idx, tab: nextTabState })) + setTimeout(() => Events.eventBus.emit('/tab/switch/request/done', { idx, tab: nextTabState })) } private readonly _onSwitchTab = this.onSwitchTab.bind(this) @@ -162,7 +162,7 @@ export default class TabContainer extends React.PureComponent { private readonly _onCloseTab = this.onCloseTab.bind(this) private listenForTabClose(model: TabModel) { - eventBus.onceWithTabId('/tab/close/request', model.uuid, async (uuid: string, tab: Tab) => { + Events.eventBus.onceWithTabId('/tab/close/request', model.uuid, async (uuid: string, tab: Tab) => { if (this.state.tabs.length === 1) { // then we are closing the last tab, so close the window tab.REPL.qexec('window close') @@ -172,7 +172,7 @@ export default class TabContainer extends React.PureComponent { }) } - private newTabModel(spec: NewTabRequestEvent['tabs'][0] = {}, doNotChangeActiveTab = false) { + private newTabModel(spec: Events.NewTabRequestEvent['tabs'][0] = {}, doNotChangeActiveTab = false) { // !this.state means: if this is the very first tab we've ever // !created, *and* we were given an initial title (via // !this.props.title), then use that @@ -196,7 +196,7 @@ export default class TabContainer extends React.PureComponent { * New Tab event * */ - private onNewTab(spec: NewTabRequestEvent['tabs'][0] = {}, doNotChangeActiveTab = false) { + private onNewTab(spec: Events.NewTabRequestEvent['tabs'][0] = {}, doNotChangeActiveTab = false) { // if we already have a tab with this title, and this isn't a // background tab, then switch to it if (spec.title) { @@ -281,7 +281,7 @@ export default class TabContainer extends React.PureComponent { // execute a command onClose? if (tabModel.onClose) { - eventBus.on('/tab/close', async tab => { + Events.eventBus.on('/tab/close', async tab => { try { await tab.REPL.qexec(tabModel.onClose) } catch (err) { diff --git a/plugins/plugin-client-common/src/components/Client/TabContent.tsx b/plugins/plugin-client-common/src/components/Client/TabContent.tsx index 2a4af97a142..a54200d60e8 100644 --- a/plugins/plugin-client-common/src/components/Client/TabContent.tsx +++ b/plugins/plugin-client-common/src/components/Client/TabContent.tsx @@ -15,7 +15,7 @@ */ import React from 'react' -import { eventChannelUnsafe, eventBus, Tab as KuiTab, TabState, initializeSession } from '@kui-shell/core' +import { Events, Tab as KuiTab, TabState, initializeSession } from '@kui-shell/core' import KuiContext from './context' const Confirm = React.lazy(() => import('../Views/Confirm')) @@ -149,22 +149,22 @@ export default class TabContent extends React.PureComponent { console.error('Error in onTabReady', err) } } - eventChannelUnsafe.once(`/tab/new/${this.props.uuid}`, onTabNew) - this.cleaners.push(() => eventChannelUnsafe.off(`/tab/new/${this.props.uuid}`, onTabNew)) + Events.eventChannelUnsafe.once(`/tab/new/${this.props.uuid}`, onTabNew) + this.cleaners.push(() => Events.eventChannelUnsafe.off(`/tab/new/${this.props.uuid}`, onTabNew)) const onError = (sessionInitError: Error) => { this.setState({ sessionInit: 'Error', sessionInitError }) } - eventChannelUnsafe.on(`/tab/new/error/${this.props.uuid}`, onError) - this.cleaners.push(() => eventChannelUnsafe.off(`/tab/new/error/${this.props.uuid}`, onError)) + Events.eventChannelUnsafe.on(`/tab/new/error/${this.props.uuid}`, onError) + this.cleaners.push(() => Events.eventChannelUnsafe.off(`/tab/new/error/${this.props.uuid}`, onError)) const onOffline = this.onOffline.bind(this) - eventBus.onWithTabId('/tab/offline', this.props.uuid, onOffline) - this.cleaners.push(() => eventBus.offWithTabId('/tab/offline', this.props.uuid, onOffline)) + Events.eventBus.onWithTabId('/tab/offline', this.props.uuid, onOffline) + this.cleaners.push(() => Events.eventBus.offWithTabId('/tab/offline', this.props.uuid, onOffline)) const onEditToggle = this.toggleEditMode - eventBus.onWithTabId('/kui/tab/edit/toggle', this.props.uuid, onEditToggle) - this.cleaners.push(() => eventBus.offWithTabId('/kui/tab/edit/toggle', this.props.uuid, onEditToggle)) + Events.eventBus.onWithTabId('/kui/tab/edit/toggle', this.props.uuid, onEditToggle) + this.cleaners.push(() => Events.eventBus.offWithTabId('/kui/tab/edit/toggle', this.props.uuid, onEditToggle)) } private async onOffline() { @@ -182,7 +182,7 @@ export default class TabContent extends React.PureComponent { } private static onSessionInitError(uuid: string, sessionInitError: Error) { - eventChannelUnsafe.emit(`/tab/new/error/${uuid}`, sessionInitError) + Events.eventChannelUnsafe.emit(`/tab/new/error/${uuid}`, sessionInitError) } private oneTimeInit() { @@ -196,8 +196,8 @@ export default class TabContent extends React.PureComponent { // session init hook goes here initializeSession(state.tab.current) .then(() => { - eventBus.emit('/tab/new', state.tab.current) - eventChannelUnsafe.emit(`/tab/new/${props.uuid}`, state.tab.current) + Events.eventBus.emit('/tab/new', state.tab.current) + Events.eventChannelUnsafe.emit(`/tab/new/${props.uuid}`, state.tab.current) }) .catch(TabContent.onSessionInitError.bind(undefined, props.uuid)) @@ -256,7 +256,7 @@ export default class TabContent extends React.PureComponent { } public componentWillUnmount() { - eventBus.emit('/tab/close', this.state.tab.current) + Events.eventBus.emit('/tab/close', this.state.tab.current) this.cleaners.forEach(cleaner => cleaner()) } diff --git a/plugins/plugin-client-common/src/components/Client/TabModel.ts b/plugins/plugin-client-common/src/components/Client/TabModel.ts index b34efd162f8..bdd10562576 100644 --- a/plugins/plugin-client-common/src/components/Client/TabModel.ts +++ b/plugins/plugin-client-common/src/components/Client/TabModel.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { NewTabRequestEvent, StatusStripeChangeEvent, TabState } from '@kui-shell/core' +import { Events, TabState } from '@kui-shell/core' /** cheapo uuid; we only need single-threaded uniqueness */ let _uuidCounter = 1 @@ -29,14 +29,14 @@ export interface TopTabButton

{ export default class TabModel { public constructor( private readonly _uuid = uuid(), - private readonly desiredStatusStripeDecoration?: StatusStripeChangeEvent, + private readonly desiredStatusStripeDecoration?: Events.StatusStripeChangeEvent, doNotChangeActiveTab?: boolean, private readonly _title?: string, private readonly _state = new TabState(_uuid, desiredStatusStripeDecoration), private readonly _buttons: TopTabButton[] = [], private readonly _initialCommandLine?: string, private readonly _onClose?: string, - private readonly _exec?: NewTabRequestEvent['tabs'][0]['exec'], + private readonly _exec?: Events.NewTabRequestEvent['tabs'][0]['exec'], /** If field is defined then this is the serialized form of the notebook to be displayed on this tab */ private readonly _snapshot?: Buffer ) { diff --git a/plugins/plugin-client-common/src/components/Client/TopTabStripe/Tab.tsx b/plugins/plugin-client-common/src/components/Client/TopTabStripe/Tab.tsx index 658a7ee55d3..9222e824668 100644 --- a/plugins/plugin-client-common/src/components/Client/TopTabStripe/Tab.tsx +++ b/plugins/plugin-client-common/src/components/Client/TopTabStripe/Tab.tsx @@ -17,9 +17,8 @@ import React from 'react' import { i18n, - eventBus, - eventChannelUnsafe, Event, + Events, ExecType, Theme, getDefaultTheme, @@ -97,9 +96,9 @@ export default class Tab extends React.PureComponent { } private removeCommandEvaluationListeners() { - eventBus.offCommandStart(this.props.uuid, this.onCommandStart) - eventBus.offCommandComplete(this.props.uuid, this.onCommandStart) - eventChannelUnsafe.off('/theme/change', this.onThemeChange) + Events.eventBus.offCommandStart(this.props.uuid, this.onCommandStart) + Events.eventBus.offCommandComplete(this.props.uuid, this.onCommandStart) + Events.eventChannelUnsafe.off('/theme/change', this.onThemeChange) } /** @@ -146,9 +145,9 @@ export default class Tab extends React.PureComponent { } } - eventBus.onCommandStart(this.props.uuid, this.onCommandStart) - eventBus.onCommandComplete(this.props.uuid, this.onCommandComplete) - eventChannelUnsafe.on('/theme/change', this.onThemeChange) + Events.eventBus.onCommandStart(this.props.uuid, this.onCommandStart) + Events.eventBus.onCommandComplete(this.props.uuid, this.onCommandComplete) + Events.eventChannelUnsafe.on('/theme/change', this.onThemeChange) } private isUsingCommandName() { diff --git a/plugins/plugin-client-common/src/components/Content/Editor/DiffEditor.tsx b/plugins/plugin-client-common/src/components/Content/Editor/DiffEditor.tsx index 65a09f254f0..fef15566917 100644 --- a/plugins/plugin-client-common/src/components/Content/Editor/DiffEditor.tsx +++ b/plugins/plugin-client-common/src/components/Content/Editor/DiffEditor.tsx @@ -18,7 +18,7 @@ import React from 'react' import { extname } from 'path' import { editor as Monaco } from 'monaco-editor' -import { eventChannelUnsafe, eventBus, MultiModalResponse, TabLayoutChangeEvent } from '@kui-shell/core' +import { Events, MultiModalResponse } from '@kui-shell/core' import { isFile } from '@kui-shell/plugin-bash-like/fs' import getKuiFontSize from './lib/fonts' @@ -133,8 +133,8 @@ export default class DiffEditor extends React.PureComponent { const onZoom = () => { editor.updateOptions({ fontSize: getKuiFontSize() }) } - eventChannelUnsafe.on('/zoom', onZoom) - cleaners.push(() => eventChannelUnsafe.off('/zoom', onZoom)) + Events.eventChannelUnsafe.on('/zoom', onZoom) + cleaners.push(() => Events.eventChannelUnsafe.off('/zoom', onZoom)) if (props.sizeToFit) { const sizeToFit = ( @@ -157,7 +157,7 @@ export default class DiffEditor extends React.PureComponent { observer.observe(state.wrapper) cleaners.push(() => observer.disconnect()) - const onTabLayoutChange = (evt: TabLayoutChangeEvent) => { + const onTabLayoutChange = (evt: Events.TabLayoutChangeEvent) => { sizeToFit() if (evt.isWidthConstrained) { editor.updateOptions({ renderSideBySide: false }) @@ -165,10 +165,10 @@ export default class DiffEditor extends React.PureComponent { editor.updateOptions({ renderSideBySide: props.renderSideBySide }) } } - eventBus.onTabLayoutChange(props.tabUUID, onTabLayoutChange) - cleaners.push(() => eventBus.offTabLayoutChange(props.tabUUID, onTabLayoutChange)) + Events.eventBus.onTabLayoutChange(props.tabUUID, onTabLayoutChange) + cleaners.push(() => Events.eventBus.offTabLayoutChange(props.tabUUID, onTabLayoutChange)) } else { - const onTabLayoutChange = (evt: TabLayoutChangeEvent) => { + const onTabLayoutChange = (evt: Events.TabLayoutChangeEvent) => { editor.layout() if (evt.isWidthConstrained) { editor.updateOptions({ renderSideBySide: false }) @@ -176,8 +176,8 @@ export default class DiffEditor extends React.PureComponent { editor.updateOptions({ renderSideBySide: props.renderSideBySide }) } } - eventBus.onTabLayoutChange(props.tabUUID, onTabLayoutChange) - cleaners.push(() => eventBus.offTabLayoutChange(props.tabUUID, onTabLayoutChange)) + Events.eventBus.onTabLayoutChange(props.tabUUID, onTabLayoutChange) + cleaners.push(() => Events.eventBus.offTabLayoutChange(props.tabUUID, onTabLayoutChange)) } state.wrapper['getValueForTests'] = () => { diff --git a/plugins/plugin-client-common/src/components/Content/Editor/SimpleEditor.tsx b/plugins/plugin-client-common/src/components/Content/Editor/SimpleEditor.tsx index 666904a9d2c..adef766f3e9 100644 --- a/plugins/plugin-client-common/src/components/Content/Editor/SimpleEditor.tsx +++ b/plugins/plugin-client-common/src/components/Content/Editor/SimpleEditor.tsx @@ -17,7 +17,7 @@ import React from 'react' import { editor as Monaco, KeyMod, KeyCode } from 'monaco-editor' -import { eventChannelUnsafe, eventBus } from '@kui-shell/core' +import { Events } from '@kui-shell/core' import getKuiFontSize from './lib/fonts' import defaultMonacoOptions, { Options as MonacoOptions } from './lib/defaults' @@ -181,15 +181,15 @@ export default class SimpleEditor extends React.Component { const onZoom = () => { editor.updateOptions({ fontSize: getKuiFontSize() }) } - eventChannelUnsafe.on('/zoom', onZoom) - cleaners.push(() => eventChannelUnsafe.off('/zoom', onZoom)) + Events.eventChannelUnsafe.on('/zoom', onZoom) + cleaners.push(() => Events.eventChannelUnsafe.off('/zoom', onZoom)) if (props.tabUUID) { const onTabLayoutChange = () => { editor.layout() } - eventBus.onTabLayoutChange(props.tabUUID, onTabLayoutChange) - cleaners.push(() => eventBus.offTabLayoutChange(props.tabUUID, onTabLayoutChange)) + Events.eventBus.onTabLayoutChange(props.tabUUID, onTabLayoutChange) + cleaners.push(() => Events.eventBus.offTabLayoutChange(props.tabUUID, onTabLayoutChange)) } cleaners.push(() => { diff --git a/plugins/plugin-client-common/src/components/Content/Editor/index.tsx b/plugins/plugin-client-common/src/components/Content/Editor/index.tsx index 7d98183279f..00101fc552f 100644 --- a/plugins/plugin-client-common/src/components/Content/Editor/index.tsx +++ b/plugins/plugin-client-common/src/components/Content/Editor/index.tsx @@ -21,6 +21,7 @@ import { IDisposable, editor as Monaco, Range } from 'monaco-editor' import { File, isFile } from '@kui-shell/plugin-bash-like/fs' import { Button, + Events, REPL, EditableSpec, SaveError, @@ -29,8 +30,6 @@ import { ToolbarProps, MultiModalResponse, encodeComponent, - eventChannelUnsafe, - eventBus, i18n } from '@kui-shell/core' @@ -382,8 +381,8 @@ export default class Editor extends React.PureComponent { const onZoom = () => { editor.updateOptions({ fontSize: getKuiFontSize() }) } - eventChannelUnsafe.on('/zoom', onZoom) - cleaners.push(() => eventChannelUnsafe.off('/zoom', onZoom)) + Events.eventChannelUnsafe.on('/zoom', onZoom) + cleaners.push(() => Events.eventChannelUnsafe.off('/zoom', onZoom)) const sizeToFit = !props.sizeToFit ? () => true @@ -409,8 +408,8 @@ export default class Editor extends React.PureComponent { sizeToFit() editor.layout() } - eventBus.onTabLayoutChange(props.tabUUID, onTabLayoutChange) - cleaners.push(() => eventBus.offTabLayoutChange(props.tabUUID, onTabLayoutChange)) + Events.eventBus.onTabLayoutChange(props.tabUUID, onTabLayoutChange) + cleaners.push(() => Events.eventBus.offTabLayoutChange(props.tabUUID, onTabLayoutChange)) editor['clearDecorations'] = () => { // debug('clearing decorations', editor['__cloudshell_decorations']) diff --git a/plugins/plugin-client-common/src/components/Content/LinkStatus.tsx b/plugins/plugin-client-common/src/components/Content/LinkStatus.tsx index 2e3e248f49f..2dffd569937 100644 --- a/plugins/plugin-client-common/src/components/Content/LinkStatus.tsx +++ b/plugins/plugin-client-common/src/components/Content/LinkStatus.tsx @@ -15,7 +15,7 @@ */ import React from 'react' -import { eventChannelUnsafe, i18n } from '@kui-shell/core' +import { Events, i18n } from '@kui-shell/core' import Icon from '../spi/Icons' import Tooltip from '../spi/Tooltip' @@ -33,14 +33,14 @@ interface State { } export function subscribeToLinkUpdates(link: string, statusUpdateHandler: (status: number[]) => void) { - eventChannelUnsafe.on(`/link/status/update/${link}`, statusUpdateHandler) + Events.eventChannelUnsafe.on(`/link/status/update/${link}`, statusUpdateHandler) // request the first update - eventChannelUnsafe.emit(`/link/status/get`, link) + Events.eventChannelUnsafe.emit(`/link/status/get`, link) } export function unsubscribeToLinkUpdates(link: string, statusUpdateHandler: (status: number[]) => void) { - eventChannelUnsafe.off(`/link/status/update/${link}`, statusUpdateHandler) + Events.eventChannelUnsafe.off(`/link/status/update/${link}`, statusUpdateHandler) } export default class TaskStatus extends React.PureComponent { diff --git a/plugins/plugin-client-common/src/components/Content/Table/TableCell.tsx b/plugins/plugin-client-common/src/components/Content/Table/TableCell.tsx index 2b916038ab5..54c826e05ee 100644 --- a/plugins/plugin-client-common/src/components/Content/Table/TableCell.tsx +++ b/plugins/plugin-client-common/src/components/Content/Table/TableCell.tsx @@ -18,13 +18,13 @@ import React from 'react' import prettyPrintDuration from 'pretty-ms' import { Td } from '@patternfly/react-table' import { + Events, split, Table as KuiTable, Cell as KuiCell, Row as KuiRow, Tab, REPL, - eventBus, pexecInCurrentTab, isHeadless } from '@kui-shell/core' @@ -69,8 +69,8 @@ export function onClickForCell( return whenNothingIsSelected((evt: React.MouseEvent) => { evt.stopPropagation() selectRow() - eventBus.emitCommandStart(handler.startEvent) - eventBus.emitCommandComplete(handler.completeEvent) + Events.eventBus.emitCommandStart(handler.startEvent) + Events.eventBus.emitCommandComplete(handler.completeEvent) return false }) } else if (handler) { diff --git a/plugins/plugin-client-common/src/components/Views/Confirm.tsx b/plugins/plugin-client-common/src/components/Views/Confirm.tsx index f21e58a30e6..6e319d90eb7 100644 --- a/plugins/plugin-client-common/src/components/Views/Confirm.tsx +++ b/plugins/plugin-client-common/src/components/Views/Confirm.tsx @@ -16,7 +16,7 @@ import React from 'react' import Modal from '../spi/Modal' -import { i18n, eventChannelUnsafe, Tab as KuiTab } from '@kui-shell/core' +import { Events, i18n, Tab as KuiTab } from '@kui-shell/core' const strings = i18n('plugin-core-support') @@ -64,7 +64,7 @@ export default class Confirm extends React.PureComponent { // done with this part... not done with all parts const done = () => { this.props.onRender() - eventChannelUnsafe.emit(`/command/stdout/done/${tabUUID}/${execUUID}`) + Events.eventChannelUnsafe.emit(`/command/stdout/done/${tabUUID}/${execUUID}`) } // part === null: the controller wants to clear any prior output @@ -167,7 +167,7 @@ export default class Output extends React.PureComponent { if (isProcessing(props.model) && !state.alreadyListen) { // listen for streaming output (unless the output has been redirected to a file) const tabUUID = props.uuid - eventChannelUnsafe.on(`/command/stdout/${tabUUID}/${props.model.execUUID}`, state.streamingConsumer) + Events.eventChannelUnsafe.on(`/command/stdout/${tabUUID}/${props.model.execUUID}`, state.streamingConsumer) return { alreadyListen: true, @@ -178,7 +178,7 @@ export default class Output extends React.PureComponent { const tabUUID = props.uuid if (!isEmpty(props.model)) { - eventChannelUnsafe.off(`/command/stdout/${tabUUID}/${props.model.execUUID}`, state.streamingConsumer) + Events.eventChannelUnsafe.off(`/command/stdout/${tabUUID}/${props.model.execUUID}`, state.streamingConsumer) } return { diff --git a/plugins/plugin-client-common/src/components/Views/Terminal/Block/index.tsx b/plugins/plugin-client-common/src/components/Views/Terminal/Block/index.tsx index e92db2ffac1..e140498f24b 100644 --- a/plugins/plugin-client-common/src/components/Views/Terminal/Block/index.tsx +++ b/plugins/plugin-client-common/src/components/Views/Terminal/Block/index.tsx @@ -15,7 +15,7 @@ */ import React from 'react' -import { Tab as KuiTab, eventBus, eventChannelUnsafe } from '@kui-shell/core' +import { Events, Tab as KuiTab } from '@kui-shell/core' import Width from '../../Sidecar/width' import SplitPosition from '../SplitPosition' @@ -137,7 +137,7 @@ export default class Block extends React.PureComponent { isMaximized: width === Width.Maximized }) setTimeout(() => { - eventBus.emitTabLayoutChange(this.props.tab.uuid) + Events.eventBus.emitTabLayoutChange(this.props.tab.uuid) if (this.state._block) { this.state._block.scrollIntoView(true) } @@ -186,7 +186,7 @@ export default class Block extends React.PureComponent { private willScreenshot() { setTimeout(() => { const element = this.state._block.querySelector('.kui--screenshotable') || this.state._block - eventChannelUnsafe.emit('/screenshot/element', element) + Events.eventChannelUnsafe.emit('/screenshot/element', element) }) } diff --git a/plugins/plugin-client-common/src/components/Views/Terminal/ClipboardTransfer.ts b/plugins/plugin-client-common/src/components/Views/Terminal/ClipboardTransfer.ts index 0769b048734..dc5ad79b31d 100644 --- a/plugins/plugin-client-common/src/components/Views/Terminal/ClipboardTransfer.ts +++ b/plugins/plugin-client-common/src/components/Views/Terminal/ClipboardTransfer.ts @@ -15,7 +15,7 @@ */ import { v4 } from 'uuid' -import { eventBus, CommandStartEvent, CommandCompleteEvent, ScalarResponse, flatten, getTabId } from '@kui-shell/core' +import { CommandStartEvent, CommandCompleteEvent, Events, ScalarResponse, flatten, getTabId } from '@kui-shell/core' import ScrollableTerminal, { getSelectionText } from './ScrollableTerminal' import { isNotebookImpl } from './Snapshot' import { FinishedBlock, hasStartEvent, isWithCompleteEvent } from './Block/BlockModel' @@ -133,7 +133,7 @@ export function onPaste(this: ScrollableTerminal, evt: ClipboardEvent) { export function onCopy(this: ScrollableTerminal, evt: ClipboardEvent, onSuccess?: (target: Target) => void) { const target = confirmTarget(this) if (target) { - eventBus.emitSnapshotRequest( + Events.eventBus.emitSnapshotRequest( { filter: (evt: CommandStartEvent) => { return evt.execUUID === target.execUUID diff --git a/plugins/plugin-client-common/src/components/Views/Terminal/ScrollableTerminal.tsx b/plugins/plugin-client-common/src/components/Views/Terminal/ScrollableTerminal.tsx index 46ae7d80b30..35eaf9ba3f2 100644 --- a/plugins/plugin-client-common/src/components/Views/Terminal/ScrollableTerminal.tsx +++ b/plugins/plugin-client-common/src/components/Views/Terminal/ScrollableTerminal.tsx @@ -18,9 +18,8 @@ import { v4, v5 } from 'uuid' import React from 'react' import { + Events, i18n, - eventBus, - eventChannelUnsafe, isAbortableResponse, ScalarResponse, Tab as KuiTab, @@ -40,8 +39,7 @@ import { executeSequentially, isWatchable, promiseEach, - Notebook, - SnapshotRequestEvent + Notebook } from '@kui-shell/core' import ScrollbackState, { ScrollbackOptions, Cleaner } from './ScrollbackState' @@ -228,12 +226,12 @@ export default class ScrollableTerminal extends React.PureComponent { + Events.eventChannelUnsafe.on('/link/status/get', (link: string) => { this.state.splits.find(({ blocks }) => blocks.find(_ => { if (isLinkified(_) && _.link === link) { const status = !hasBeenRerun(_) ? [0, 0, 0] : isOk(_) ? [1, 0, 0] : [0, 1, 0] - eventChannelUnsafe.emit(`/link/status/update/${_.link}`, status) + Events.eventChannelUnsafe.emit(`/link/status/update/${_.link}`, status) return true } }) @@ -319,7 +317,7 @@ export default class ScrollableTerminal extends React.PureComponent { + const onSnapshot = async (evt: Events.SnapshotRequestEvent) => { const splits = this.state.splits.map(({ inverseColors, position, blocks, uuid }) => { const { filter = () => true } = evt @@ -375,8 +373,8 @@ export default class ScrollableTerminal extends React.PureComponent eventBus.offSnapshotRequest(onSnapshot, getTabId(this.props.tab))) + Events.eventBus.onSnapshotRequest(onSnapshot, getTabId(this.props.tab)) + this.cleaners.push(() => Events.eventBus.offSnapshotRequest(onSnapshot, getTabId(this.props.tab))) } /** add welcome blocks at the top of scrollback */ @@ -390,7 +388,7 @@ export default class ScrollableTerminal extends React.PureComponent this.removeSplit(sbuuid)) } - eventBus.onceWithTabId('/tab/close/request', sbuuid, onTabCloseRequest) - state.cleaners.push(() => eventBus.offWithTabId('/tab/close/request', sbuuid, onTabCloseRequest)) + Events.eventBus.onceWithTabId('/tab/close/request', sbuuid, onTabCloseRequest) + state.cleaners.push(() => Events.eventBus.offWithTabId('/tab/close/request', sbuuid, onTabCloseRequest)) if (opts.cmdline) { setTimeout(() => { @@ -893,7 +891,7 @@ export default class ScrollableTerminal extends React.PureComponent { @@ -1118,16 +1116,16 @@ export default class ScrollableTerminal extends React.PureComponent eventBus.offCommandStart(state.uuid, onStartForSplitFromUser)) - state.cleaners.push(() => eventBus.offCommandStart(state.uuid, onStartForSplitFromReplay)) - state.cleaners.push(() => eventBus.offCommandComplete(state.uuid, onCompleteForSplitFromUser)) - state.cleaners.push(() => eventBus.offCommandComplete(state.uuid, onCompleteForSplitFromReplay)) + state.cleaners.push(() => Events.eventBus.offCommandStart(state.uuid, onStartForSplitFromUser)) + state.cleaners.push(() => Events.eventBus.offCommandStart(state.uuid, onStartForSplitFromReplay)) + state.cleaners.push(() => Events.eventBus.offCommandComplete(state.uuid, onCompleteForSplitFromUser)) + state.cleaners.push(() => Events.eventBus.offCommandComplete(state.uuid, onCompleteForSplitFromReplay)) } /** @@ -1138,9 +1136,9 @@ export default class ScrollableTerminal extends React.PureComponent { - eventChannelUnsafe.off(`/terminal/clear/${state.uuid}`, clear) + Events.eventChannelUnsafe.off(`/terminal/clear/${state.uuid}`, clear) }) // terminate watchable jobs when the window is closed @@ -1235,7 +1233,7 @@ export default class ScrollableTerminal extends React.PureComponent eventChannelUnsafe.emit('/zoom')) + setTimeout(() => Events.eventChannelUnsafe.emit('/zoom')) } /** diff --git a/plugins/plugin-client-common/src/components/Views/Terminal/Snapshot.ts b/plugins/plugin-client-common/src/components/Views/Terminal/Snapshot.ts index 831345e8c6a..69cd15d5a07 100644 --- a/plugins/plugin-client-common/src/components/Views/Terminal/Snapshot.ts +++ b/plugins/plugin-client-common/src/components/Views/Terminal/Snapshot.ts @@ -19,10 +19,10 @@ import { v4 as uuid } from 'uuid' import { CommandStartEvent, CommandCompleteEvent, + Events, Notebook, isNotebook, isWatchable, - eventBus, Tab, Table, isTable, @@ -99,8 +99,8 @@ export function snapshot(block: FinishedBlock): FinishedBlock { const tab = block.startEvent.tab ? block.startEvent.tab.uuid : block.completeEvent.tab - ? block.completeEvent.tab.uuid - : undefined + ? block.completeEvent.tab.uuid + : undefined const startEvent = Object.assign({}, block.startEvent, { tab }) const completeEvent = Object.assign( @@ -197,7 +197,7 @@ export function tabAlignment(block: FinishedBlock, tab: Tab): FinishedBlock { export class FlightRecorder { // eslint-disable-next-line no-useless-constructor - public constructor(private readonly tab: Tab, private readonly splits: Split[]) {} + public constructor(private readonly tab: Tab, private readonly splits: Split[]) { } private async recordTable(table: Table) { await Promise.all( @@ -218,16 +218,16 @@ export class FlightRecorder { Object.assign(onclickHome.onclick, { completeEvent }) } - eventBus.onCommandStart(fakeTab.uuid, onCommandStart) - eventBus.onCommandComplete(fakeTab.uuid, onCommandComplete) + Events.eventBus.onCommandStart(fakeTab.uuid, onCommandStart) + Events.eventBus.onCommandComplete(fakeTab.uuid, onCommandComplete) try { await fakeTab.REPL.pexec(command, { tab: fakeTab }) } catch (err) { console.error('Error recording click', command, err) } finally { - eventBus.offCommandStart(fakeTab.uuid, onCommandStart) - eventBus.offCommandComplete(fakeTab.uuid, onCommandComplete) + Events.eventBus.offCommandStart(fakeTab.uuid, onCommandStart) + Events.eventBus.offCommandComplete(fakeTab.uuid, onCommandComplete) } } } diff --git a/plugins/plugin-client-common/src/components/spi/Accordion/impl/PatternFly.tsx b/plugins/plugin-client-common/src/components/spi/Accordion/impl/PatternFly.tsx index fcf1a30e6f8..a6500a88e83 100644 --- a/plugins/plugin-client-common/src/components/spi/Accordion/impl/PatternFly.tsx +++ b/plugins/plugin-client-common/src/components/spi/Accordion/impl/PatternFly.tsx @@ -17,8 +17,7 @@ import React from 'react' import { Accordion, AccordionItem, AccordionToggle, AccordionContent } from '@patternfly/react-core' -import { eventBus, getPrimaryTabId, i18n } from '@kui-shell/core' - +import { Events, getPrimaryTabId, i18n } from '@kui-shell/core' import Props from '../model' import '../../../../../web/scss/components/Accordion/PatternFly.scss' @@ -59,7 +58,7 @@ export default class PatternFlyAccordion extends React.PureComponent { this.setState(curState => ({ expandedIdx: curState.expandedIdx !== idx ? idx : -1 })) if (this.props.tab) { - eventBus.emitTabLayoutChange(getPrimaryTabId(this.props.tab)) + Events.eventBus.emitTabLayoutChange(getPrimaryTabId(this.props.tab)) } }} isExpanded={this.state.expandedIdx === idx} diff --git a/plugins/plugin-client-common/src/controller/confirm.ts b/plugins/plugin-client-common/src/controller/confirm.ts index f0a0cb4af03..d12b0831f69 100644 --- a/plugins/plugin-client-common/src/controller/confirm.ts +++ b/plugins/plugin-client-common/src/controller/confirm.ts @@ -15,7 +15,7 @@ */ import { - eventChannelUnsafe, + Events, getPrimaryTabId, Registrar, ExecType, @@ -71,8 +71,8 @@ export default async (commandTree: Registrar) => { } } - eventChannelUnsafe.once(responseChannel, onConfirm) - eventChannelUnsafe.emit(requestChannel, { command, asking, execUUID }) + Events.eventChannelUnsafe.once(responseChannel, onConfirm) + Events.eventChannelUnsafe.emit(requestChannel, { command, asking, execUUID }) }), { usage, incognito: ['popup'] } ) diff --git a/plugins/plugin-client-default/package.json b/plugins/plugin-client-default/package.json index a3c924449df..f34590a6d83 100644 --- a/plugins/plugin-client-default/package.json +++ b/plugins/plugin-client-default/package.json @@ -3,6 +3,7 @@ "version": "10.7.0", "description": "Kui plugin that offers client defintion", "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "license": "Apache-2.0", diff --git a/plugins/plugin-client-notebook/package.json b/plugins/plugin-client-notebook/package.json index 6daa7fbb5b0..a2075be3e05 100644 --- a/plugins/plugin-client-notebook/package.json +++ b/plugins/plugin-client-notebook/package.json @@ -3,6 +3,7 @@ "version": "10.7.0", "description": "A Kui client that serves up notebooks", "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "license": "Apache-2.0", diff --git a/plugins/plugin-client-test/package.json b/plugins/plugin-client-test/package.json index 8fdf39eb46c..771506166c4 100644 --- a/plugins/plugin-client-test/package.json +++ b/plugins/plugin-client-test/package.json @@ -3,6 +3,7 @@ "version": "10.7.0", "description": "Kui plugin that offers client defintion", "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "license": "Apache-2.0", diff --git a/plugins/plugin-client-test/src/CounterWidget.tsx b/plugins/plugin-client-test/src/CounterWidget.tsx index 5098a7aefab..5c443789e6c 100644 --- a/plugins/plugin-client-test/src/CounterWidget.tsx +++ b/plugins/plugin-client-test/src/CounterWidget.tsx @@ -16,7 +16,7 @@ import React from 'react' -import { wireToStandardEvents } from '@kui-shell/core' +import { Events } from '@kui-shell/core' import { Icons, ViewLevel, TextWithIconWidget } from '@kui-shell/plugin-client-common' interface Props { @@ -58,7 +58,7 @@ export default class CounterWidget extends React.PureComponent { * */ public componentDidMount() { - wireToStandardEvents(this.update.bind(this)) + Events.wireToStandardEvents(this.update.bind(this)) } public render() { diff --git a/plugins/plugin-core-support/package.json b/plugins/plugin-core-support/package.json index 34824bca170..e98827d634c 100644 --- a/plugins/plugin-core-support/package.json +++ b/plugins/plugin-core-support/package.json @@ -20,6 +20,7 @@ "Mengting Yan" ], "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "dependencies": { diff --git a/plugins/plugin-core-support/src/lib/cmds/clear.ts b/plugins/plugin-core-support/src/lib/cmds/clear.ts index 9f75669a11d..18a7f796be7 100644 --- a/plugins/plugin-core-support/src/lib/cmds/clear.ts +++ b/plugins/plugin-core-support/src/lib/cmds/clear.ts @@ -14,13 +14,13 @@ * limitations under the License. */ -import { isHeadless, eventChannelUnsafe, getTabId, Arguments, Registrar } from '@kui-shell/core' +import { Events, isHeadless, getTabId, Arguments, Registrar } from '@kui-shell/core' const clear = ({ tab }: Arguments) => { if (!isHeadless()) { setTimeout(() => { - eventChannelUnsafe.emit(`/terminal/clear/${getTabId(tab)}`) - eventChannelUnsafe.emit(`/close/views/${getTabId(tab)}`) + Events.eventChannelUnsafe.emit(`/terminal/clear/${getTabId(tab)}`) + Events.eventChannelUnsafe.emit(`/close/views/${getTabId(tab)}`) }) } diff --git a/plugins/plugin-core-support/src/lib/cmds/replay.ts b/plugins/plugin-core-support/src/lib/cmds/replay.ts index c6119e39ae7..65b9d5a4288 100644 --- a/plugins/plugin-core-support/src/lib/cmds/replay.ts +++ b/plugins/plugin-core-support/src/lib/cmds/replay.ts @@ -15,7 +15,7 @@ */ import { - eventBus, + Events, expandHomeDir, inElectron, Arguments, @@ -23,7 +23,6 @@ import { KResponse, ParsedOptions, Registrar, - StatusStripeChangeEvent, Notebook, isNotebook, getPrimaryTabId @@ -70,7 +69,7 @@ const snapshotUsage = { interface ReplayOptions extends ParsedOptions { 'new-window': boolean - 'status-stripe': StatusStripeChangeEvent['type'] + 'status-stripe': Events.StatusStripeChangeEvent['type'] } interface SnapshotOptions extends ParsedOptions { @@ -97,7 +96,7 @@ async function loadNotebook(REPL: Arguments['REPL'], filepath: string): Promise< } /** Command registration */ -export default function(registrar: Registrar) { +export default function (registrar: Registrar) { // register the `replay` command registrar.listen( '/replay', @@ -129,7 +128,7 @@ export default function(registrar: Registrar) { return REPL.qexec( `tab new --snapshot "${filepaths.join(',')}" --quiet --status-stripe-type ${parsedOptions[ - 'status-stripe' + 'status-stripe' ] || 'blue'} ${titleOptions} ${parsedOptions.r ? ' -r' : ''}`, undefined, undefined, @@ -150,7 +149,7 @@ export default function(registrar: Registrar) { const seenExecUUIDs: Record = {} const ourMainTab = getPrimaryTabId(tab) - eventBus.emitSnapshotRequest( + Events.eventBus.emitSnapshotRequest( { filter: (evt: CommandStartEvent) => { if (!seenExecUUIDs[evt.execUUID]) { diff --git a/plugins/plugin-core-support/src/lib/cmds/tab-management.ts b/plugins/plugin-core-support/src/lib/cmds/tab-management.ts index 0ca57361a59..d6f5b4650e3 100644 --- a/plugins/plugin-core-support/src/lib/cmds/tab-management.ts +++ b/plugins/plugin-core-support/src/lib/cmds/tab-management.ts @@ -16,14 +16,12 @@ import { Arguments, + Events, expandHomeDir, - eventBus, getPrimaryTabId, i18n, KResponse, Registrar, - NewTabRequestEvent, - StatusStripeChangeEvent, Tab } from '@kui-shell/core' @@ -43,7 +41,7 @@ const usage = { */ function closeTab(tab: Tab, closeAllSplits: boolean) { const uuid = closeAllSplits ? getPrimaryTabId(tab) : tab.uuid - eventBus.emitWithTabId('/tab/close/request', uuid, tab) + Events.eventBus.emitWithTabId('/tab/close/request', uuid, tab) return true } @@ -63,7 +61,7 @@ export default function plugin(commandTree: Registrar) { '/tab/switch', ({ argvNoOptions }) => { const idx = parseInt(argvNoOptions[argvNoOptions.length - 1], 10) - eventBus.emit('/tab/switch/request', idx - 1) + Events.eventBus.emit('/tab/switch/request', idx - 1) return true }, { usage } @@ -75,9 +73,9 @@ export default function plugin(commandTree: Registrar) { */ commandTree.listen< KResponse, - Pick & { + Pick & { /** Set the status stripe decorations */ - 'status-stripe-type'?: StatusStripeChangeEvent['type'] + 'status-stripe-type'?: Events.StatusStripeChangeEvent['type'] 'status-stripe-message'?: string | string[] /** Tab titles; comma separated for multi-open */ @@ -140,8 +138,8 @@ export default function plugin(commandTree: Registrar) { content: !titles ? strings('Created a new tab') : Array.isArray(titles) && titles.length > 1 - ? strings('Created new tabs', args.parsedOptions.title) - : strings('Created a new tab named X', Array.isArray(titles) ? titles[0] : titles), + ? strings('Created new tabs', args.parsedOptions.title) + : strings('Created a new tab named X', Array.isArray(titles) ? titles[0] : titles), contentType: 'text/markdown' } @@ -152,7 +150,7 @@ export default function plugin(commandTree: Registrar) { const snapshot = await Promise.all(filepaths.map(filepath => loadSnapshotBuffer(args.REPL, filepath))) return new Promise(resolve => { - eventBus.emit('/tab/new/request', { + Events.eventBus.emit('/tab/new/request', { background: args.parsedOptions.bg, tabs: snapshot.map((snapshot, idx) => ({ snapshot, @@ -167,7 +165,7 @@ export default function plugin(commandTree: Registrar) { } else if (args.parsedOptions.cmdline) { // caller wants to invoke a given command line in the new tab return new Promise(resolve => { - eventBus.emit('/tab/new/request', { + Events.eventBus.emit('/tab/new/request', { background: args.parsedOptions.bg, tabs: (titles || ['']).map((title, idx) => ({ title, @@ -182,7 +180,7 @@ export default function plugin(commandTree: Registrar) { }) } else { // default case: tab opens without invoking a command line - eventBus.emit('/tab/new/request', { + Events.eventBus.emit('/tab/new/request', { background: args.parsedOptions.bg, tabs: statusStripeDecorations.map((statusStripeDecoration, idx) => ({ statusStripeDecoration, diff --git a/plugins/plugin-core-support/src/lib/cmds/toggle-editability.ts b/plugins/plugin-core-support/src/lib/cmds/toggle-editability.ts index ec8a05b6920..c2c0cab2db2 100644 --- a/plugins/plugin-core-support/src/lib/cmds/toggle-editability.ts +++ b/plugins/plugin-core-support/src/lib/cmds/toggle-editability.ts @@ -15,19 +15,18 @@ */ import { - eventBus, + Events, getPrimaryTabId, isOfflineClient, isReadOnlyClient, KResponse, ParsedOptions, Registrar, - StatusStripeChangeEvent } from '@kui-shell/core' interface EditOptions extends ParsedOptions { 'new-window': boolean - 'status-stripe': StatusStripeChangeEvent['type'] + 'status-stripe': Events.StatusStripeChangeEvent['type'] current?: boolean c?: boolean } @@ -53,7 +52,7 @@ function getTabIndex(argvNoOptions: string[]): number { } /** Command registration */ -export default function(registrar: Registrar) { +export default function (registrar: Registrar) { if (!(isReadOnlyClient() || isOfflineClient())) { // register the `tab edit toggle` command registrar.listen( @@ -68,11 +67,11 @@ export default function(registrar: Registrar) { if (parsedOptions.c) { // we have the uuid - eventBus.emitWithTabId('/kui/tab/edit/toggle', getPrimaryTabId(tab)) + Events.eventBus.emitWithTabId('/kui/tab/edit/toggle', getPrimaryTabId(tab)) } else { // we only have the index, so we need to broadcast for help // the event expects 0-indexed, our controller takes 1-indexed - eventBus.emit('/kui/tab/edit/toggle/index', getTabIndex(argvNoOptions) - 1) + Events.eventBus.emit('/kui/tab/edit/toggle/index', getTabIndex(argvNoOptions) - 1) } return 'Successfully toggled edit mode' diff --git a/plugins/plugin-core-support/src/lib/cmds/zoom.ts b/plugins/plugin-core-support/src/lib/cmds/zoom.ts index 019097c8aee..4dddec15af2 100644 --- a/plugins/plugin-core-support/src/lib/cmds/zoom.ts +++ b/plugins/plugin-core-support/src/lib/cmds/zoom.ts @@ -14,8 +14,7 @@ * limitations under the License. */ -import { UsageError, Arguments, Registrar } from '@kui-shell/core' - +import { Events, UsageError, Arguments, Registrar } from '@kui-shell/core' import '../../../web/css/static/zoom.css' const MAX_ZOOM_IN = 12 @@ -123,8 +122,7 @@ const listener = async (event: KeyboardEvent): Promise => { event.preventDefault() reset() setTimeout(async () => { - const { eventChannelUnsafe } = await import('@kui-shell/core') - eventChannelUnsafe.emit('/zoom', 1) + Events.eventChannelUnsafe.emit('/zoom', 1) }, 100) } else if ((char === keys.ZOOM_IN || char === keys.ZOOM_OUT) && (event.ctrlKey || event.metaKey) && !event.shiftKey) { // zooming @@ -134,8 +132,7 @@ const listener = async (event: KeyboardEvent): Promise => { const newZoom = parseInt(main.getAttribute('data-zoom') || '1', 10) + factor _set(newZoom) setTimeout(async () => { - const { eventChannelUnsafe } = await import('@kui-shell/core') - eventChannelUnsafe.emit('/zoom', newZoom) + Events.eventChannelUnsafe.emit('/zoom', newZoom) }, 100) } } diff --git a/plugins/plugin-electron-components/package.json b/plugins/plugin-electron-components/package.json index 35a8756534a..495f7287f25 100644 --- a/plugins/plugin-electron-components/package.json +++ b/plugins/plugin-electron-components/package.json @@ -17,6 +17,7 @@ "plugin" ], "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "publishConfig": { diff --git a/plugins/plugin-electron-components/src/components/Screenshot.tsx b/plugins/plugin-electron-components/src/components/Screenshot.tsx index 00e8d6adc26..07da9471c79 100644 --- a/plugins/plugin-electron-components/src/components/Screenshot.tsx +++ b/plugins/plugin-electron-components/src/components/Screenshot.tsx @@ -16,7 +16,7 @@ import React from 'react' import { Event, NativeImage } from 'electron' -import { i18n, eventChannelUnsafe } from '@kui-shell/core' +import { Events, i18n } from '@kui-shell/core' import { Alert, Button } from '@kui-shell/plugin-client-common' import '../../web/scss/components/Screenshot/Screenshot.scss' @@ -60,7 +60,7 @@ export default class Screenshot extends React.PureComponent { isActive: false } - eventChannelUnsafe.on('/screenshot/element', (element: HTMLElement) => { + Events.eventChannelUnsafe.on('/screenshot/element', (element: HTMLElement) => { this.onClickScreenshotRegion(element) }) } diff --git a/plugins/plugin-electron-components/src/components/UpdateChecker.tsx b/plugins/plugin-electron-components/src/components/UpdateChecker.tsx index b1f2060da9b..c933149b01a 100644 --- a/plugins/plugin-electron-components/src/components/UpdateChecker.tsx +++ b/plugins/plugin-electron-components/src/components/UpdateChecker.tsx @@ -24,7 +24,7 @@ import React from 'react' import needle from 'needle' -import { eventChannelUnsafe, getCurrentTab, pexecInCurrentTab, i18n } from '@kui-shell/core' +import { Events, getCurrentTab, pexecInCurrentTab, i18n } from '@kui-shell/core' import { TextWithIconWidget as Widget, TextWithIconWidgetProps, Markdown } from '@kui-shell/plugin-client-common' import '../../web/scss/components/UpdateChecker/_index.scss' @@ -195,7 +195,7 @@ export default class UpdateChecker extends React.PureComponent { const tab = getCurrentTab() if (!tab || !tab.REPL) { if (tab && !tab.REPL) { - eventChannelUnsafe.once(`/tab/new/${tab.uuid}`, () => this.getCurrentVersion()) + Events.eventChannelUnsafe.once(`/tab/new/${tab.uuid}`, () => this.getCurrentVersion()) } return } diff --git a/plugins/plugin-git/package.json b/plugins/plugin-git/package.json index 01c8d6fd212..994025502ae 100644 --- a/plugins/plugin-git/package.json +++ b/plugins/plugin-git/package.json @@ -20,6 +20,7 @@ "Mengting Yan" ], "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "publishConfig": { diff --git a/plugins/plugin-git/src/CurrentGitBranch.tsx b/plugins/plugin-git/src/CurrentGitBranch.tsx index 9a7b7970db4..a17c9a7f600 100644 --- a/plugins/plugin-git/src/CurrentGitBranch.tsx +++ b/plugins/plugin-git/src/CurrentGitBranch.tsx @@ -18,17 +18,7 @@ import React from 'react' import { basename, dirname, join } from 'path' import { Icons, ViewLevel, TextWithIconWidget } from '@kui-shell/plugin-client-common' -import { - wireToStandardEvents, - unwireToStandardEvents, - eventBus, - getCurrentTab, - inBrowser, - i18n, - encodeComponent, - pexecInCurrentTab, - CodedError -} from '@kui-shell/core' +import { Events, getCurrentTab, inBrowser, i18n, encodeComponent, pexecInCurrentTab, CodedError } from '@kui-shell/core' const strings = i18n('plugin-bash-like') const strings2 = i18n('plugin-git') @@ -137,17 +127,17 @@ export default class CurrentGitBranch extends React.PureComponent this.unmounted = false if (inBrowser()) { - eventBus.once('/tab/new', this.handler) + Events.eventBus.once('/tab/new', this.handler) } else { this.handler() } - wireToStandardEvents(this.handler) + Events.wireToStandardEvents(this.handler) } /** Make sure to unsubscribe! */ public componentWillUnmount() { this.unmounted = true - unwireToStandardEvents(this.handler) + Events.unwireToStandardEvents(this.handler) } /** @return the header for the Popover component */ diff --git a/plugins/plugin-iter8/src/modes/decisionForm.tsx b/plugins/plugin-iter8/src/modes/decisionForm.tsx index e6ddd60138d..7d575789662 100644 --- a/plugins/plugin-iter8/src/modes/decisionForm.tsx +++ b/plugins/plugin-iter8/src/modes/decisionForm.tsx @@ -15,7 +15,8 @@ */ import React from 'react' -import { eventChannelUnsafe, Tab } from '@kui-shell/core' +import { Events, Tab } from '@kui-shell/core' + // Component imports import { Alert, Button, Icons, Loading } from '@kui-shell/plugin-client-common' import { Caption, TableComposable, Thead, Tbody, Th, Tr, Td } from '@patternfly/react-table' @@ -134,7 +135,7 @@ export default class DecisionBase extends React.Component public componentDidMount() { console.log('Mounted Decision tab') this._isMounted = true - eventChannelUnsafe.on('/get/decision', formstate => { + Events.eventChannelUnsafe.on('/get/decision', formstate => { this.setState({ edgeService: formstate.edgeServiceInformation.edgeService, hostGateways: formstate.edgeServiceInformation.hostGateways, diff --git a/plugins/plugin-iter8/src/modes/exprForm.tsx b/plugins/plugin-iter8/src/modes/exprForm.tsx index c2326fa05a8..b6b454fa812 100644 --- a/plugins/plugin-iter8/src/modes/exprForm.tsx +++ b/plugins/plugin-iter8/src/modes/exprForm.tsx @@ -15,7 +15,8 @@ */ import React from 'react' -import { eventChannelUnsafe, Tab } from '@kui-shell/core' +import { Events, Tab } from '@kui-shell/core' + // Component Imports import { ActionGroup, @@ -294,7 +295,7 @@ export default class ExprBase extends React.Component { const time = d.toISOString() const jsonOutput = getRequestModel(time, this.state, this.args) // Transmit data to Decision form using eventBus - eventChannelUnsafe.emit('/get/decision', jsonOutput) + Events.eventChannelUnsafe.emit('/get/decision', jsonOutput) } // Cancels form submission event caused by "Enter" press diff --git a/plugins/plugin-kubectl/components/src/CurrentContext.tsx b/plugins/plugin-kubectl/components/src/CurrentContext.tsx index bd393d91019..b21053395a0 100644 --- a/plugins/plugin-kubectl/components/src/CurrentContext.tsx +++ b/plugins/plugin-kubectl/components/src/CurrentContext.tsx @@ -17,17 +17,7 @@ import React from 'react' import { ViewLevel, Select, TextWithIconWidget, TextWithIconWidgetOptions } from '@kui-shell/plugin-client-common' -import { - eventBus, - eventChannelUnsafe, - getCurrentTab, - getTab, - Tab, - TabState, - encodeComponent, - pexecInCurrentTab, - i18n -} from '@kui-shell/core' +import { Events, getCurrentTab, getTab, Tab, TabState, encodeComponent, pexecInCurrentTab, i18n } from '@kui-shell/core' import { KubeContext } from '@kui-shell/plugin-kubectl' type Props = TextWithIconWidgetOptions @@ -57,7 +47,7 @@ function KubernetesIcon() { } export let ready = false -eventBus.once('/tab/new', () => (ready = true)) +Events.eventBus.once('/tab/new', () => (ready = true)) export default class CurrentContext extends React.PureComponent { private readonly handler = this.reportCurrentContext.bind(this) @@ -175,7 +165,7 @@ export default class CurrentContext extends React.PureComponent { const tab = getTab(typeof idx === 'string' ? undefined : idx) if (!tab || !tab.REPL) { if (tab && !tab.REPL) { - eventChannelUnsafe.once(`/tab/new/${tab.uuid}`, () => this.reportCurrentContext()) + Events.eventChannelUnsafe.once(`/tab/new/${tab.uuid}`, () => this.reportCurrentContext()) } return } else if (this.debounce()) { @@ -300,13 +290,13 @@ export default class CurrentContext extends React.PureComponent { this.unmounted = false if (!ready) { - eventBus.once('/tab/new', this.handler) + Events.eventBus.once('/tab/new', this.handler) } else { this.handler() } - eventBus.on('/tab/switch/request/done', this.handlerNotCallingKubectl) + Events.eventBus.on('/tab/switch/request/done', this.handlerNotCallingKubectl) - eventBus.onAnyCommandComplete(this.handler) + Events.eventBus.onAnyCommandComplete(this.handler) import('@kui-shell/plugin-kubectl').then(_ => _.onKubectlConfigChangeEvents(this.handlerForConfigChange)) } @@ -314,9 +304,9 @@ export default class CurrentContext extends React.PureComponent { /** Bye! */ public componentWillUnmount() { this.unmounted = true - eventBus.off('/tab/new', this.handler) - eventBus.off('/tab/switch/request/done', this.handlerNotCallingKubectl) - eventBus.offAnyCommandComplete(this.handler) + Events.eventBus.off('/tab/new', this.handler) + Events.eventBus.off('/tab/switch/request/done', this.handlerNotCallingKubectl) + Events.eventBus.offAnyCommandComplete(this.handler) import('@kui-shell/plugin-kubectl').then(_ => _.offKubectlConfigChangeEvents(this.handlerForConfigChange)) } diff --git a/plugins/plugin-kubectl/components/src/CurrentNamespace.tsx b/plugins/plugin-kubectl/components/src/CurrentNamespace.tsx index 1b68128ebd9..5215165bc66 100644 --- a/plugins/plugin-kubectl/components/src/CurrentNamespace.tsx +++ b/plugins/plugin-kubectl/components/src/CurrentNamespace.tsx @@ -24,7 +24,7 @@ import { TextWithIconWidgetOptions } from '@kui-shell/plugin-client-common' -import { eventBus, i18n, eventChannelUnsafe, getTab, Tab, TabState, pexecInCurrentTab } from '@kui-shell/core' +import { Events, i18n, getTab, Tab, TabState, pexecInCurrentTab } from '@kui-shell/core' import { KubeContext } from '@kui-shell/plugin-kubectl' @@ -78,7 +78,7 @@ export default class CurrentNamespace extends React.PureComponent const tab = getTab(typeof idx === 'string' ? undefined : idx) if (!tab || !tab.REPL) { if (tab && !tab.REPL) { - eventChannelUnsafe.once(`/tab/new/${tab.uuid}`, () => this.reportCurrentNamespace()) + Events.eventChannelUnsafe.once(`/tab/new/${tab.uuid}`, () => this.reportCurrentNamespace()) } return } else if (this.debounce()) { @@ -151,13 +151,13 @@ export default class CurrentNamespace extends React.PureComponent public componentDidMount() { this.unmounted = false if (!ready) { - eventBus.once('/tab/new', this.handler) + Events.eventBus.once('/tab/new', this.handler) } else { this.handler() } - eventBus.on('/tab/switch/request/done', this.handlerNotCallingKubectl) + Events.eventBus.on('/tab/switch/request/done', this.handlerNotCallingKubectl) - eventBus.onAnyCommandComplete(this.handler) + Events.eventBus.onAnyCommandComplete(this.handler) import('@kui-shell/plugin-kubectl').then(_ => _.onKubectlConfigChangeEvents(this.handler)) } @@ -174,10 +174,10 @@ export default class CurrentNamespace extends React.PureComponent /** Bye! */ public componentWillUnmount() { this.unmounted = true - eventBus.off('/tab/new', this.handler) - eventBus.off('/tab/switch/request/done', this.handlerNotCallingKubectl) + Events.eventBus.off('/tab/new', this.handler) + Events.eventBus.off('/tab/switch/request/done', this.handlerNotCallingKubectl) - eventBus.offAnyCommandComplete(this.handler) + Events.eventBus.offAnyCommandComplete(this.handler) import('@kui-shell/plugin-kubectl').then(_ => _.offKubectlConfigChangeEvents(this.handler)) } diff --git a/plugins/plugin-kubectl/package.json b/plugins/plugin-kubectl/package.json index acb6d4beadf..f23707ce631 100644 --- a/plugins/plugin-kubectl/package.json +++ b/plugins/plugin-kubectl/package.json @@ -24,6 +24,7 @@ "url": "git+https://github.com/IBM/kui.git" }, "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "dependencies": { diff --git a/plugins/plugin-kubectl/src/controller/kubectl/config.ts b/plugins/plugin-kubectl/src/controller/kubectl/config.ts index e88f4c54274..c82279b77a8 100644 --- a/plugins/plugin-kubectl/src/controller/kubectl/config.ts +++ b/plugins/plugin-kubectl/src/controller/kubectl/config.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Arguments, Registrar, eventChannelUnsafe } from '@kui-shell/core' +import { Arguments, Events, Registrar } from '@kui-shell/core' import flags from './flags' import { doExecWithPty } from './exec' @@ -42,18 +42,18 @@ export function emitKubectlConfigChangeEvent( context?: string ) { try { - eventChannelUnsafe.emit(kubectlConfigChangeChannel, type, namespace, context) + Events.eventChannelUnsafe.emit(kubectlConfigChangeChannel, type, namespace, context) } catch (err) { console.error('Error in onKubectlConfigChangeEvent handler', err) } } export function onKubectlConfigChangeEvents(handler: Handler) { - eventChannelUnsafe.on(kubectlConfigChangeChannel, handler) + Events.eventChannelUnsafe.on(kubectlConfigChangeChannel, handler) } export function offKubectlConfigChangeEvents(handler: Handler) { - eventChannelUnsafe.off(kubectlConfigChangeChannel, handler) + Events.eventChannelUnsafe.off(kubectlConfigChangeChannel, handler) } /** @@ -68,8 +68,8 @@ function emitChangeEventIfNeeded(args: Arguments) { verb === 'set' || verb === 'use-context' || (verb === 'set-context' && !args.parsedOptions.current) ? 'NewContext' : verb === 'set-context' || verb === 'set-cluster' || verb === 'set-credentials' || verb === 'rename-context' - ? 'AlteredContext' - : undefined + ? 'AlteredContext' + : undefined if (change) { emitKubectlConfigChangeEvent( diff --git a/plugins/plugin-kubectl/src/lib/view/modes/Terminal.tsx b/plugins/plugin-kubectl/src/lib/view/modes/Terminal.tsx index 9c22661063b..a07e18f550a 100644 --- a/plugins/plugin-kubectl/src/lib/view/modes/Terminal.tsx +++ b/plugins/plugin-kubectl/src/lib/view/modes/Terminal.tsx @@ -19,16 +19,7 @@ import { v4 as uuid } from 'uuid' import { FitAddon } from 'xterm-addon-fit' import { Terminal as XTerminal, ITheme } from 'xterm' -import { - Job, - Streamable, - TabLayoutChangeEvent, - ToolbarText, - i18n, - eventBus, - isResizable, - eventChannelUnsafe -} from '@kui-shell/core' +import { Events, Job, Streamable, ToolbarText, i18n, isResizable } from '@kui-shell/core' import { inDebugMode, Loading } from '@kui-shell/plugin-client-common' @@ -128,21 +119,21 @@ export default class Terminal extends C this.doXon() } const focusOnEvent = `/mode/focus/on/tab/${uuid}/mode/${this.mode()}` - eventChannelUnsafe.on(focusOnEvent, focus) - this.cleaners.push(() => eventChannelUnsafe.off(focusOnEvent, focus)) + Events.eventChannelUnsafe.on(focusOnEvent, focus) + this.cleaners.push(() => Events.eventChannelUnsafe.off(focusOnEvent, focus)) const xoff = this.doXoff.bind(this) const focusOffEvent = `/mode/focus/off/tab/${uuid}/mode/${this.mode()}` - eventChannelUnsafe.on(focusOffEvent, xoff) - this.cleaners.push(() => eventChannelUnsafe.off(focusOffEvent, xoff)) + Events.eventChannelUnsafe.on(focusOffEvent, xoff) + this.cleaners.push(() => Events.eventChannelUnsafe.off(focusOffEvent, xoff)) const resizeListener = this.onWindowResize.bind(this) window.addEventListener('resize', resizeListener) this.cleaners.push(() => window.removeEventListener('resize', resizeListener)) const layoutListener = this.onTabLayoutChange.bind(this) - eventBus.onTabLayoutChange(uuid, layoutListener) - this.cleaners.push(() => eventBus.offTabLayoutChange(uuid, layoutListener)) + Events.eventBus.onTabLayoutChange(uuid, layoutListener) + this.cleaners.push(() => Events.eventBus.offTabLayoutChange(uuid, layoutListener)) } /** Which container should we focus on by default? */ @@ -242,7 +233,7 @@ export default class Terminal extends C } } - private onTabLayoutChange(evt: TabLayoutChangeEvent) { + private onTabLayoutChange(evt: Events.TabLayoutChangeEvent) { if (this.state.xterm && !evt.isSidecarNowHidden) { this.state.doResize() } @@ -546,8 +537,8 @@ export default class Terminal extends C const inject = () => Terminal.injectTheme(xterm, dom) inject() - eventChannelUnsafe.on('/theme/change', inject) - perTerminalCleaners.push(() => eventChannelUnsafe.on('/theme/change', inject)) + Events.eventChannelUnsafe.on('/theme/change', inject) + perTerminalCleaners.push(() => Events.eventChannelUnsafe.on('/theme/change', inject)) const fitAddon = new FitAddon() xterm.loadAddon(fitAddon) diff --git a/plugins/plugin-kubectl/view-utilization/src/components/ClusterUtilization.tsx b/plugins/plugin-kubectl/view-utilization/src/components/ClusterUtilization.tsx index 4e7e06332f6..f53879e430c 100644 --- a/plugins/plugin-kubectl/view-utilization/src/components/ClusterUtilization.tsx +++ b/plugins/plugin-kubectl/view-utilization/src/components/ClusterUtilization.tsx @@ -17,7 +17,7 @@ import Debug from 'debug' import React from 'react' -import { getCurrentTab, wireToStandardEvents } from '@kui-shell/core' +import { Events, getCurrentTab } from '@kui-shell/core' import { ViewLevel, TextWithIconWidget } from '@kui-shell/plugin-client-common' import { NodeSummary, BarColor, Bar, BarContainer } from '..' @@ -69,7 +69,7 @@ export default class ClusterUtilization extends React.PureComponent { this.setState({ offline: false }) } - eventChannelUnsafe.on('/proxy/online', onOnline) - this.cleaners.push(() => eventChannelUnsafe.off('/proxy/online', onOnline)) + Events.eventChannelUnsafe.on('/proxy/online', onOnline) + this.cleaners.push(() => Events.eventChannelUnsafe.off('/proxy/online', onOnline)) const onOffline = () => this.setState({ offline: true }) - eventChannelUnsafe.on('/proxy/offline', onOffline) - this.cleaners.push(() => eventChannelUnsafe.off('/proxy/offline', onOffline)) + Events.eventChannelUnsafe.on('/proxy/offline', onOffline) + this.cleaners.push(() => Events.eventChannelUnsafe.off('/proxy/offline', onOffline)) } public componentWillUnmount() { diff --git a/plugins/plugin-s3/components/src/S3Mounts.tsx b/plugins/plugin-s3/components/src/S3Mounts.tsx index 7445498a7ad..102aeec5fbf 100644 --- a/plugins/plugin-s3/components/src/S3Mounts.tsx +++ b/plugins/plugin-s3/components/src/S3Mounts.tsx @@ -18,7 +18,11 @@ import React from 'react' import commonPathPrefix from 'common-path-prefix' import { TableComposable, Tbody, Tr, Td } from '@patternfly/react-table' -import { i18n, encodeComponent } from '@kui-shell/core' +import { + // Events, + i18n, + encodeComponent +} from '@kui-shell/core' import { eventBus, Mount, getCurrentMounts } from '@kui-shell/plugin-s3' import { Ansi, @@ -97,13 +101,13 @@ export default class S3Mounts extends React.PureComponent { */ public componentDidMount() { eventBus.on('/s3/configuration/update', this.handler) - // wireToStandardEvents(this.handler) + // Events.wireToStandardEvents(this.handler) } /** Make sure to unsubscribe! */ public componentWillUnmount() { eventBus.off('/s3/configuration/update', this.handler) - // unwireToStandardEvents(this.handler) + // Events.unwireToStandardEvents(this.handler) } /** @return the header for the Popover component */ diff --git a/plugins/plugin-s3/ibm/src/controller/bind.ts b/plugins/plugin-s3/ibm/src/controller/bind.ts index 6985c71c052..00cd6798a0d 100644 --- a/plugins/plugin-s3/ibm/src/controller/bind.ts +++ b/plugins/plugin-s3/ibm/src/controller/bind.ts @@ -16,7 +16,7 @@ import Debug from 'debug' import { doExecWithStdoutViaPty } from '@kui-shell/plugin-bash-like' -import { Arguments, ExecType, ParsedOptions, encodeComponent, eventChannelUnsafe, expandHomeDir } from '@kui-shell/core' +import { Arguments, Events, ExecType, ParsedOptions, encodeComponent, expandHomeDir } from '@kui-shell/core' import findLocal from './local' import filepath from './filepath' @@ -66,7 +66,7 @@ async function bind( debug('configuring cos creds') await save({ REPL }, config) - setTimeout(() => eventChannelUnsafe.emit(updateChannel)) + setTimeout(() => Events.eventChannelUnsafe.emit(updateChannel)) return config } diff --git a/plugins/plugin-s3/ibm/src/controller/endpoint.ts b/plugins/plugin-s3/ibm/src/controller/endpoint.ts index 2637ddcb7ad..e36f724e910 100644 --- a/plugins/plugin-s3/ibm/src/controller/endpoint.ts +++ b/plugins/plugin-s3/ibm/src/controller/endpoint.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Arguments, RadioTable, encodeComponent, eventChannelUnsafe, expandHomeDir } from '@kui-shell/core' +import { Arguments, Events, RadioTable, encodeComponent, expandHomeDir } from '@kui-shell/core' import { doExecWithStdoutViaPty } from '@kui-shell/plugin-bash-like' import filepath from './filepath' @@ -45,7 +45,7 @@ async function doSetEndpoint(args: Arguments, endpoint: string) { data: JSON.stringify(config, undefined, 2) }) - eventChannelUnsafe.emit(updateChannel) + Events.eventChannelUnsafe.emit(updateChannel) return `Setting IBM Cloud Object Storage endpoint to [${endpoint}](${endpoint})` } diff --git a/plugins/plugin-s3/ibm/src/s3provider.ts b/plugins/plugin-s3/ibm/src/s3provider.ts index f66fbb6901b..80a8ef60d2b 100644 --- a/plugins/plugin-s3/ibm/src/s3provider.ts +++ b/plugins/plugin-s3/ibm/src/s3provider.ts @@ -15,7 +15,7 @@ */ import Debug from 'debug' -import { REPL, eventChannelUnsafe } from '@kui-shell/core' +import { Events, REPL } from '@kui-shell/core' import { ProviderInitializer, UnsupportedS3ProviderError } from '@kui-shell/plugin-s3' import Geos from './model/geos' @@ -46,7 +46,7 @@ async function init(geo: string, mountName: string, repl: REPL, reinit: () => vo try { if (!listeningAlready) { listeningAlready = true - eventChannelUnsafe.on(updateChannel, () => { + Events.eventChannelUnsafe.on(updateChannel, () => { currentConfig = undefined reinit() }) diff --git a/plugins/plugin-s3/package.json b/plugins/plugin-s3/package.json index 20d50a3dfad..69389486e5e 100644 --- a/plugins/plugin-s3/package.json +++ b/plugins/plugin-s3/package.json @@ -25,6 +25,7 @@ "url": "git+https://github.com/IBM/kui.git" }, "main": "dist/index.js", + "typedocMain": "src/index.ts", "module": "mdist/index.js", "types": "mdist/index.d.ts", "dependencies": { diff --git a/plugins/plugin-s3/src/providers/local-minio.ts b/plugins/plugin-s3/src/providers/local-minio.ts index f1cfc7f0328..f02bb692d90 100644 --- a/plugins/plugin-s3/src/providers/local-minio.ts +++ b/plugins/plugin-s3/src/providers/local-minio.ts @@ -15,7 +15,7 @@ */ import Debug from 'debug' -import { eventBus, REPL } from '@kui-shell/core' +import { Events, REPL } from '@kui-shell/core' import { fetchFileString } from '@kui-shell/plugin-kubectl' import Provider, { ProviderInitializer } from './model' @@ -50,12 +50,12 @@ let alreadyReportedCannotConnect = false async function init(repl: REPL, reinit: () => void) { if (!listeningAlready) { - eventBus.onEnvUpdate('MINIO_ACCESS_KEY', value => { + Events.eventBus.onEnvUpdate('MINIO_ACCESS_KEY', value => { localStorage.setItem(localStorageAccessKey, value) reinit() }) - eventBus.onEnvUpdate('MINIO_SECRET_KEY', value => { + Events.eventBus.onEnvUpdate('MINIO_SECRET_KEY', value => { localStorage.setItem(localStorageSecretKey, value) reinit() }) diff --git a/tsconfig.json b/tsconfig.json index 5f401a00c51..a93c53e395f 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -52,5 +52,14 @@ { "path": "plugins/plugin-iter8" } - ] + ], + "typedocOptions": { + "entryPoints": ["packages/core", "packages/test", "plugins/*"], + "entryPointStrategy": "packages", + "out": "docs/api", + "githubPages": false, + "readme": "none", + "name": "Kui API Documentation", + "includeVersion": true + } }