Browse Source

docs(api): window label

Lucas Nogueira 3 years ago
parent
commit
c50fbc22e7
1 changed files with 2 additions and 2 deletions
  1. 2 2
      tooling/api/src/window.ts

+ 2 - 2
tooling/api/src/window.ts

@@ -246,7 +246,7 @@ export type WindowLabel = string
  * A webview window handle allows emitting and listening to events from the backend that are tied to the window.
  */
 class WebviewWindowHandle {
-  /** Window label. */
+  /** The window label. It is a unique identifier for the window, can be used to reference it later. */
   label: WindowLabel
   /** Local event listeners. */
   listeners: { [key: string]: Array<EventCallback<any>> }
@@ -1117,7 +1117,7 @@ class WindowManager extends WebviewWindowHandle {
 class WebviewWindow extends WindowManager {
   /**
    * Creates a new WebviewWindow.
-   * * @param label The webview window label. It must be alphanumeric.
+   * * @param label The webview window label, a unique identifier that can be used to reference it later. It must be alphanumeric.
    * @returns The WebviewWindow instance to communicate with the webview.
    */
   constructor(label: WindowLabel, options: WindowOptions = {}) {