Merge pull request #120 from gtardif/docs_update

gtardif · web-flow · commit 7d705574b635 · 2022-04-04T16:29:22.000+02:00
Update docs generated from API
diff --git a/docs/dev/api/reference/README.md b/docs/dev/api/reference/README.md
@@ -16,6 +16,7 @@
 - [Docker](interfaces/Docker.md)
 - [DockerCommand](interfaces/DockerCommand.md)
 - [Exec](interfaces/Exec.md)
+- [ExecStreamOptions](interfaces/ExecStreamOptions.md)
 - [ExecResult](interfaces/ExecResult.md)
 - [RawExecResult](interfaces/RawExecResult.md)
 - [Extension](interfaces/Extension.md)
diff --git a/docs/dev/api/reference/interfaces/Docker.md b/docs/dev/api/reference/interfaces/Docker.md
@@ -20,7 +20,7 @@
 You can also directly execute the docker binary.
 
 ```typescript
-const output = await window.ddClient.docker.cli.exec(
+const output = await ddClient.docker.cli.exec(
   "info",
   ["--format", '"{{ json . }}"']
 );
@@ -41,11 +41,9 @@ Streams the output as a result of the execution of a docker command.
 Useful when the output of the command is too long or you need to get the output as a stream.
 
 ```typescript linenums="1"
-await window.ddClient.docker.cli.exec("logs", ["-f", "..."], {
+await ddClient.docker.cli.exec("logs", ["-f", "..."], {
            stream: {
-             onOutput(
-               data: { stdout: string } | { stderr: string }
-             ): void {
+             onOutput(data): void {
                  // As we can receive both `stdout` and `stderr`, we wrap them in a JSON object
                  JSON.stringify(
                    {
@@ -78,7 +76,7 @@ By default this will not list stopped containers.
 You can use the option `{"all": true}` to list all the running and stopped containers.
 
 ```typescript
-const containers = await window.ddClient.docker.listContainers();
+const containers = await ddClient.docker.listContainers();
 ```
 
 #### Parameters
@@ -100,7 +98,7 @@ ___
 Get the list of local container images
 
 ```typescript
-const images = await window.ddClient.docker.listImages();
+const images = await ddClient.docker.listImages();
 ```
 
 #### Parameters
diff --git a/docs/dev/api/reference/interfaces/DockerDesktopClient.md b/docs/dev/api/reference/interfaces/DockerDesktopClient.md
@@ -71,7 +71,7 @@ ___
 
 • `Readonly` **extension**: [`Extension`](Extension.md)
 
-The `window.ddClient.extension` object can be used to communicate with the backend defined in the vm section in the extensions metadata.
+The `ddClient.extension` object can be used to communicate with the backend defined in the vm section in the extensions metadata.
 The client is already connected to the backend.
 
 #### Inherited from
diff --git a/docs/dev/api/reference/interfaces/Exec.md b/docs/dev/api/reference/interfaces/Exec.md
@@ -36,10 +36,7 @@ Specify the `stream` if the output of your command is too long or if you need to
 | `cmd` | `string` | The command to execute. |
 | `args` | `string`[] | The arguments of the command to execute. |
 | `options` | `Object` | The list of options. |
-| `options.stream` | `Object` | Provides three functions: `onOutput` (invoked every time `stdout` or `stderr` is received), `onError` and `onClose` (invoked when the stream has ended). |
-| `options.stream.onOutput?` | (`data`: { `stdout`: `string`  } \| { `stderr`: `string`  }) => `void` | - |
-| `options.stream.onError?` | (`error`: `any`) => `void` | - |
-| `options.stream.onClose?` | (`exitCode`: `number`) => `void` | - |
+| `options.stream` | [`ExecStreamOptions`](ExecStreamOptions.md) | Provides three functions: `onOutput` (invoked every time `stdout` or `stderr` is received), `onError` and `onClose` (invoked when the stream has ended). |
 
 #### Returns
 
diff --git a/docs/dev/api/reference/interfaces/ExecStreamOptions.md b/docs/dev/api/reference/interfaces/ExecStreamOptions.md
@@ -0,0 +1,76 @@
+# Interface: ExecStreamOptions
+
+## Table of contents
+
+### Methods
+
+- [onOutput](ExecStreamOptions.md#onoutput)
+- [onError](ExecStreamOptions.md#onerror)
+- [onClose](ExecStreamOptions.md#onclose)
+
+### Properties
+
+- [splitOutputLines](ExecStreamOptions.md#splitoutputlines)
+
+## Methods
+
+### onOutput
+
+▸ `Optional` **onOutput**(`data`): `void`
+
+Invoked when receiving output from command execution.
+By default this is raw output, can be split at any position. If `splitOutputLines` is set to true, this method will be invoked once for each output line.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `data` | { `stdout`: `string` ; `stderr?`: `undefined`  } \| { `stdout?`: `undefined` ; `stderr`: `string`  } | output content. Can include either stdout string, or stderr string, one at a time. |
+
+#### Returns
+
+`void`
+
+___
+
+### onError
+
+▸ `Optional` **onError**(`error`): `void`
+
+Invoked to report error if the executed command errors.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | `any` | the error happening in the executed command |
+
+#### Returns
+
+`void`
+
+___
+
+### onClose
+
+▸ `Optional` **onClose**(`exitCode`): `void`
+
+Invoked when process exits.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `exitCode` | `number` | the process exit code |
+
+#### Returns
+
+`void`
+
+## Properties
+
+### splitOutputLines
+
+• `Optional` `Readonly` **splitOutputLines**: `boolean`
+
+Specifies the behaviour invoking `onOutput(data)`. Raw output by default, splitting output at any position. If set to true, `onOutput` will be invoked once for each line.
diff --git a/docs/dev/api/reference/interfaces/ExtensionHost.md b/docs/dev/api/reference/interfaces/ExtensionHost.md
@@ -17,7 +17,7 @@ Executes a command in the the host.
 Example: Execute the shipped binary `kubectl -h` command in the **host**:
 
 ```typescript
- await window.ddClient.extension.host.cli.exec(
+ await ddClient.extension.host.cli.exec(
    "kubectl",
    ["-h"]
  );
@@ -30,11 +30,9 @@ Streams the output of the command executed in the backend container or in the ho
 Example: Provided the `kubectl` binary is shipped as part of your extension, you can spawn the `kubectl -h` command in the **host**:
 
 ```typescript linenums="1"
-await window.ddClient.extension.host.cli.exec("kubectl", ["-h"], {
+await ddClient.extension.host.cli.exec("kubectl", ["-h"], {
            stream: {
-             onOutput(
-               data: { stdout: string } | { stderr: string }
-             ): void {
+             onOutput(data): void {
                  // As we can receive both `stdout` and `stderr`, we wrap them in a JSON object
                  JSON.stringify(
                    {
diff --git a/docs/dev/api/reference/interfaces/ExtensionVM.md b/docs/dev/api/reference/interfaces/ExtensionVM.md
@@ -18,7 +18,7 @@ Executes a command in the backend container.
 Example: Execute the command `ls -l` inside the **backend container**:
 
 ```typescript
- await window.ddClient.extension.vm.cli.exec(
+ await ddClient.extension.vm.cli.exec(
    "ls",
    ["-l"]
  );
@@ -29,11 +29,9 @@ Streams the output of the command executed in the backend container.
 Example: Spawn the command `ls -l` inside the **backend container**:
 
 ```typescript linenums="1"
-await window.ddClient.extension.vm.cli.exec("ls", ["-l"], {
+await ddClient.extension.vm.cli.exec("ls", ["-l"], {
            stream: {
-             onOutput(
-               data: { stdout: string } | { stderr: string }
-             ): void {
+             onOutput(data): void {
                  // As we can receive both `stdout` and `stderr`, we wrap them in a JSON object
                  JSON.stringify(
                    {
diff --git a/docs/dev/api/reference/interfaces/Host.md b/docs/dev/api/reference/interfaces/Host.md
@@ -6,6 +6,12 @@
 
 - [openExternal](Host.md#openexternal)
 
+### Properties
+
+- [platform](Host.md#platform)
+- [arch](Host.md#arch)
+- [hostname](Host.md#hostname)
+
 ## Methods
 
 ### openExternal
@@ -15,7 +21,7 @@
 Opens an external URL with the system default browser.
 
 ```typescript
-window.ddClient.host.openExternal("https://docker.com");
+ddClient.host.openExternal("https://docker.com");
 ```
 
 #### Parameters
@@ -27,3 +33,27 @@ window.ddClient.host.openExternal("https://docker.com");
 #### Returns
 
 `void`
+
+## Properties
+
+### platform
+
+• **platform**: `string`
+
+Returns a string identifying the operating system platform. See https://nodejs.org/api/os.html#osplatform
+
+___
+
+### arch
+
+• **arch**: `string`
+
+Returns the operating system CPU architecture. See https://nodejs.org/api/os.html#osarch
+
+___
+
+### hostname
+
+• **hostname**: `string`
+
+Returns the host name of the operating system. See https://nodejs.org/api/os.html#oshostname
diff --git a/docs/dev/api/reference/interfaces/HttpService.md b/docs/dev/api/reference/interfaces/HttpService.md
@@ -21,7 +21,7 @@
 Performs an HTTP GET request to a backend service.
 
 ```typescript
-window.ddClient.extension.vm.service
+ ddClient.extension.vm.service
  .get("/some/service")
  .then((value: any) => console.log(value)
 ```
@@ -45,7 +45,7 @@ ___
 Performs an HTTP POST request to a backend service.
 
 ```typescript
- window.ddClient.extension.vm.service
+ ddClient.extension.vm.service
  .post("/some/service", { ... })
  .then((value: any) => console.log(value));
 ```
@@ -70,7 +70,7 @@ ___
 Performs an HTTP PUT request to a backend service.
 
 ```typescript
- window.ddClient.extension.vm.service
+ ddClient.extension.vm.service
  .put("/some/service", { ... })
  .then((value: any) => console.log(value));
 ```
@@ -95,7 +95,7 @@ ___
 Performs an HTTP PATCH request to a backend service.
 
 ```typescript
- window.ddClient.extension.vm.service
+ ddClient.extension.vm.service
  .patch("/some/service", { ... })
  .then((value: any) => console.log(value));
 ```
@@ -120,7 +120,7 @@ ___
 Performs an HTTP DELETE request to a backend service.
 
 ```typescript
- window.ddClient.extension.vm.service
+ ddClient.extension.vm.service
  .delete("/some/service")
  .then((value: any) => console.log(value));
 ```
@@ -144,7 +144,7 @@ ___
 Performs an HTTP HEAD request to a backend service.
 
 ```typescript
- window.ddClient.extension.vm.service
+ ddClient.extension.vm.service
  .head("/some/service")
  .then((value: any) => console.log(value));
 ```
@@ -168,7 +168,7 @@ ___
 Performs an HTTP request to a backend service.
 
 ```typescript
- window.ddClient.extension.vm.service
+ ddClient.extension.vm.service
  .request({ url: "/url", method: "GET", headers: { 'header-key': 'header-value' }, data: { ... }})
  .then((value: any) => console.log(value));
 ```
diff --git a/docs/dev/api/reference/interfaces/NavigationIntents.md b/docs/dev/api/reference/interfaces/NavigationIntents.md
@@ -33,7 +33,7 @@
 Navigate to the containers window in the Dashboard.
 
 ```typescript
-window.ddClient.desktopUI.navigation.viewContainers()
+ddClient.desktopUI.navigation.viewContainers()
 ```
 
 #### Returns
@@ -49,7 +49,7 @@ ___
 Navigate to the container window in the Dashboard.
 
 ```typescript
-await window.ddClient.desktopUI.navigation.viewContainer(id)
+await ddClient.desktopUI.navigation.viewContainer(id)
 ```
 
 #### Parameters
@@ -73,7 +73,7 @@ ___
 Navigate to the container logs window in the Dashboard.
 
 ```typescript
-await window.ddClient.desktopUI.navigation.viewContainerLogs(id)
+await ddClient.desktopUI.navigation.viewContainerLogs(id)
 ```
 
 #### Parameters
@@ -97,7 +97,7 @@ ___
 Navigate to the container inspect window in the Dashboard.
 
 ```typescript
-await window.ddClient.desktopUI.navigation.viewContainerInspect(id)
+await ddClient.desktopUI.navigation.viewContainerInspect(id)
 ```
 
 #### Parameters
@@ -121,7 +121,7 @@ ___
 Navigate to the container stats to see the CPU, memory, disk read/write and network I/O usage.
 
 ```typescript
-await window.ddClient.desktopUI.navigation.viewContainerStats(id)
+await ddClient.desktopUI.navigation.viewContainerStats(id)
 ```
 
 #### Parameters
@@ -147,7 +147,7 @@ ___
 Navigate to the images window in the Dashboard.
 
 ```typescript
-await window.ddClient.desktopUI.navigation.viewImages()
+await ddClient.desktopUI.navigation.viewImages()
 ```
 
 #### Returns
@@ -164,7 +164,7 @@ Navigate to a specific image referenced by `id` and `tag` in the Dashboard.
 In this navigation route you can find the image layers, commands, created time and size.
 
 ```typescript
-await window.ddClient.desktopUI.navigation.viewImage(id, tag)
+await ddClient.desktopUI.navigation.viewImage(id, tag)
 ```
 
 #### Parameters
@@ -191,7 +191,7 @@ ___
 Navigate to the Dev Environments window in the Dashboard.
 
 ```typescript
-window.ddClient.desktopUI.navigation.viewDevEnvironments()
+ddClient.desktopUI.navigation.viewDevEnvironments()
 ```
 
 #### Returns
@@ -209,7 +209,7 @@ ___
 Navigate to the volumes window in the Dashboard.
 
 ```typescript
-window.ddClient.desktopUI.navigation.viewVolumes()
+ddClient.desktopUI.navigation.viewVolumes()
 ```
 
 #### Returns
@@ -225,7 +225,7 @@ ___
 Navigate to a specific volume in the Dashboard.
 
 ```typescript
-await window.ddClient.desktopUI.navigation.viewVolume(volume)
+await ddClient.desktopUI.navigation.viewVolume(volume)
 ```
 
 #### Parameters
diff --git a/docs/dev/api/reference/interfaces/Toast.md b/docs/dev/api/reference/interfaces/Toast.md
