From 5e732796358a32e8af0fad98fc43f9ded4bbd9ad Mon Sep 17 00:00:00 2001
From: Craig Beck <luckybonza@gmail.com>
Date: Thu, 24 Oct 2024 13:22:52 -0700
Subject: [PATCH] Comment AppOptions attributes

Co-authored-by: Eric Hwang <6915076+ericyhwang@users.noreply.github.com>
---
 src/App.ts | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/App.ts b/src/App.ts
index cffecf65..ab86ac9b 100644
--- a/src/App.ts
+++ b/src/App.ts
@@ -39,9 +39,24 @@ export function createAppPage(derby): typeof Page {
 
 export interface AppOptions {
   appMetadata?: Record<string, string>,
+  /** 
+    * Base URL that the JS bundles are served from, with no trailing slash.
+    * Used by bundler plugins such as derby-webpack and derby-browserify.
+    */
   scriptBaseUrl?: string,
+  /**
+    * If true, then Derby's <script> tags have the `crossorigin` attribute set by the bundler plugin.
+    */
   scriptCrossOrigin?: boolean,
+  /**
+    * If set, this is used for auto-refresh in development to determine whether the browser
+    * should auto-refresh due to running different code than the server. Some bundler plugins, 
+    * such as derby-webpack, do their own hot reload and don't use this mechanism.
+    */
   scriptHash?: string;
+  /**
+    * Base URL for js.map files, if different from scriptBaseUrl.
+    */
   scriptMapBaseUrl?: string,
   [key: string]: unknown,
 }