spelling and grammar in code comments

CHANGELOG.md

@@ -9,6 +9,7 @@ All notable changes to `@homebridge/plugin-ui-utils` will be documented in this
 - update CHANGELOG to match hb repo formats
 - update example folder package json files
 - update LICENSE file to match hb repo formats
+- spelling and grammar in code comments
 
 ## v1.0.2 (2024-03-30)
 

src/server.ts

@@ -1,6 +1,6 @@
 /**
  * Homebridge Custom Plugin UI Base Class
- * This provides the api to facilitate two way communication between a plugin
+ * This provides the api to facilitate two-way communication between a plugin
  * custom UI HTML code and the server.
  *
  * This is a base class and is intended to be extended.
@@ -59,7 +59,7 @@ export class HomebridgePluginUiServer {
     return process.env.HOMEBRIDGE_UI_VERSION;
   }
 
-  private sendResponse(request, data: any, success = true) {
+  private sendResponse(request: any, data: any, success = true) {
     if (!process.send) {
       return;
     }
@@ -185,7 +185,7 @@ export class RequestError extends Error {
 }
 
 type RequestResponse = string | number | Record<any, any> | Array<any>;
-type RequestHandler = (any) => Promise<RequestResponse> | RequestResponse;
+type RequestHandler = (arg: any) => Promise<RequestResponse> | RequestResponse;
 
 setInterval(() => {
   if (!process.connected) {

src/ui.interface.ts

@@ -112,7 +112,7 @@ export declare class IHomebridgePluginUi extends EventTarget {
   public showSpinner(): void;
 
   /**
-   * Hide theloading spinner overlay.
+   * Hide the loading spinner overlay.
    *
    * @example
    * ```ts
@@ -144,11 +144,13 @@ export declare class IHomebridgePluginUi extends EventTarget {
 
   /**
    * Create a standalone form using a generic schema.
-   * This is not linked to the main config schema model and you must listen for changes yourself.
+   * This is not linked to the main config schema model, and you must listen for changes yourself.
    *
-   * @param schema the schema used to generate the standlone form. See [schema guide](https://developers.homebridge.io/#/config-schema).
+   * @param schema the schema used to generate the standalone form. See [schema guide](https://developers.homebridge.io/#/config-schema).
    * @param data the initial form data
    *
+   * @param submitButton
+   * @param cancelButton
    * @example
    * ```ts
    * const myForm = homebridge.createForm(
@@ -221,7 +223,7 @@ export declare class IHomebridgePluginUi extends EventTarget {
 
   /**
    * Save the plugin config.
-   * You must called `homebridge.updatePluginConfig` first.
+   * You must call `homebridge.updatePluginConfig` first.
    *
    * @example
    * ```ts

src/ui.ts

@@ -7,7 +7,7 @@
 let EventTargetConstructor = window.EventTarget;
 
 /**
- * Pollyfill for older browsers that do not support EventTarget as a constructor.
+ * Polyfill for older browsers that do not support EventTarget as a constructor.
  * https://developer.mozilla.org/en-US/docs/Web/API/EventTarget
  */
 if (!Object.prototype.hasOwnProperty.call(window.EventTarget, 'caller')) {
@@ -148,7 +148,7 @@ class HomebridgePluginUi extends EventTargetConstructor {
   }
 
   private async _requestResponse(payload): Promise<any> {
-    // generate a random request id so we can link the response
+    // generate a random request id, so we can link the response
     const requestId = Math.random().toString(36).substring(2);
     payload.requestId = requestId;