Skip to content

Latest commit

 

History

History
78 lines (44 loc) · 1.77 KB

ResolvedConfig.md

File metadata and controls

78 lines (44 loc) · 1.77 KB

@sdeverywhere/build / ResolvedConfig

Interface: ResolvedConfig

The sde configuration derived from a UserConfig that has been resolved (i.e., paths have been checked). This is the config object that will be passed to plugin functions. It contains a subset of the original UserConfig (to disallow access to the plugins field of the original config).

Properties

mode

mode: BuildMode

The mode used for the build process, either 'development' or 'production'.


rootDir

rootDir: string

The absolute path to the project root directory, which has been confirmed to exist.


prepDir

prepDir: string

The absolute path to the directory used to prepare the model. This directory has been created if it did not previously exist.


modelFiles

modelFiles: string[]

The mdl files to be built.


modelInputPaths

modelInputPaths: string[]

Paths to files that are considered to be inputs to the model build process. These can be paths to files or glob patterns (relative to the project directory).


watchPaths

watchPaths: string[]

Paths to files that when changed will trigger a rebuild in watch mode. These can be paths to files or glob patterns (relative to the project directory).


genFormat

genFormat: "js" | "c"

The code format to generate. If 'js', the model will be compiled to a JavaScript file. If 'c', the model will be compiled to a C file (in which case an additional plugin will be needed to convert the C code to a WebAssembly module).


outListingFile

Optional outListingFile: string

The absolute path to the JSON file that will be written by the build process that lists all dimensions and variables in the model.