fix(packages/core): Events api created and typedoc documentation gene…

…rated
kubernetes-sigs · Nov 1, 2021 · 531461d · 531461d
1 parent dd33fb8
commit 531461d
Show file tree

Hide file tree

Showing 213 changed files with 58,777 additions and 306 deletions.
diff --git a/docs/api/README.md 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
@@ -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
@@ -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)