Skip to content

Commit 5e73279

Browse files
Comment AppOptions attributes
Co-authored-by: Eric Hwang <[email protected]>
1 parent 3f6b714 commit 5e73279

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/App.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,24 @@ export function createAppPage(derby): typeof Page {
3939

4040
export interface AppOptions {
4141
appMetadata?: Record<string, string>,
42+
/**
43+
* Base URL that the JS bundles are served from, with no trailing slash.
44+
* Used by bundler plugins such as derby-webpack and derby-browserify.
45+
*/
4246
scriptBaseUrl?: string,
47+
/**
48+
* If true, then Derby's <script> tags have the `crossorigin` attribute set by the bundler plugin.
49+
*/
4350
scriptCrossOrigin?: boolean,
51+
/**
52+
* If set, this is used for auto-refresh in development to determine whether the browser
53+
* should auto-refresh due to running different code than the server. Some bundler plugins,
54+
* such as derby-webpack, do their own hot reload and don't use this mechanism.
55+
*/
4456
scriptHash?: string;
57+
/**
58+
* Base URL for js.map files, if different from scriptBaseUrl.
59+
*/
4560
scriptMapBaseUrl?: string,
4661
[key: string]: unknown,
4762
}

0 commit comments

Comments
 (0)