Skip to content

Commit

Permalink
Comment AppOptions attributes
Browse files Browse the repository at this point in the history
Co-authored-by: Eric Hwang <[email protected]>
  • Loading branch information
craigbeck and ericyhwang authored Oct 24, 2024
1 parent 3f6b714 commit 5e73279
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions src/App.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
}
Expand Down

0 comments on commit 5e73279

Please sign in to comment.