Extends
- AbstractModule
Members
appRoot :String
- Description:
- Source code directory for the app
- Source:
Source code directory for the app
Type:
- String
buildDir :String
- Description:
- Build code directory for the app
- Source:
Build code directory for the app
Type:
- String
isProduction
- Description:
- Cached reference to isProduction config value
- Source:
Cached reference to isProduction config value
postBuildHook :Hook
- Description:
- Invoked after every UI build
- Source:
Invoked after every UI build
Type:
- Hook
preBuildHook :Hook
- Description:
- Invoked before every UI build
- Source:
Invoked before every UI build
Type:
- Hook
srcDir :String
- Description:
- Source code directory for the app
- Source:
Source code directory for the app
Type:
- String
uiPlugins :Array.<String>
- Description:
- Reference to UI plugins which need to be included in build
- Source:
Reference to UI plugins which need to be included in build
Type:
- Array.<String>
Methods
addUiPlugin(dir)
- Description:
- Copies a plugin to be built into the UI
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
dir |
String | Directory to add (can contain nested plugins) |
(async) build(status) → {Promise}
- Description:
- Builds the front-end application
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
status |
string | Reason for build. If not provided, code will attempt to predict the need for a build. |
Returns:
- Type
- Promise
buildHandler() → {function}
- Description:
- Express handler for the rebuild endpoint
- Source:
Returns:
Express handler function
- Type
- function
(async) getRebuildStatus() → {string}
- Description:
- Checks whether a rebuild is required
- Source:
Returns:
The build status
- Type
- string
(async) init()
servePage(pageName) → {function}
- Description:
- Serves a static HTML page
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
pageName |
String |
Returns:
Express handler function
- Type
- function