Type Alias: AppConfig
AppConfig =
object
Defined in: cli/app-config.ts:9
A configuration of a Single Page Application built on top GoatDB.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
appName? | string | Application name. Extracted from the "name" field of the project's deno.json or package.json. | cli/app-config.ts:88 |
assetsFilter? | (path) => boolean | An optional filter function for filtering only selected files out of the assets directory. The default implementation ignores files starting with '.'. | cli/app-config.ts:59 |
assetsPath? | string | Path to a directory containing static assets. If provided, all files under it will be bundled into the application and be publicly accessible through the web server. Accessible at /assets/*. | cli/app-config.ts:49 |
buildDir | string | The directory in which to perform the build process. Intermediate files as well as the final binary will be placed there. | cli/app-config.ts:14 |
cssPath? | string | Path to the main CSS file for the app. Bundled through esbuild — minified in production builds, processed by esbuildPlugins, and url() references are emitted as content-hashed assets under /assets/. CSS imported from client code is concatenated after this stylesheet. Accessible at /index.css. | cli/app-config.ts:41 |
denoJson? | string | Path to deno.json. Defaults to 'deno.json' inside the current directory. | cli/app-config.ts:63 |
esbuildPlugins? | Plugin[] | Optional custom esbuild plugins. In Deno builds, plugins register after GoatDB's adapter stubs and before its browser asset fallback and Deno resolver/loader. Your onResolve handlers receive original specifiers, while onLoad handlers can process resolved local files such as CSS before those fallbacks. Applied by both compile() and startDebugServer() rebuilds. The debug server watches only watchDir; esbuild watchFiles and watchDirs do not expand that directory. Keep auxiliary inputs under watchDir (or configure a common parent) so their changes rebuild. | cli/app-config.ts:83 |
htmlPath? | string | Path to the main HTML file for the app. If provided, all unknown paths will be redirected to this HTML file. Accessible at /index.html. | cli/app-config.ts:30 |
jsPath | string | Path to the main js entry point for the client app. The server automatically transpiles the client code for the browser code using ESBuild. Supported files: .js .jsx .ts .tsx. Accessible at /app.js | cli/app-config.ts:23 |
minify? | boolean | If set to true, the output code bundle will be minified. | cli/app-config.ts:72 |
packageJson? | string | Path to package.json (Node.js). Defaults to 'package.json' inside the current directory. | cli/app-config.ts:68 |