docs: update API docs for build package

climateinteractive · Jun 4, 2024 · cf5f179 · cf5f179
1 parent ed06da8
commit cf5f179
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/packages/build/docs/interfaces/ResolvedConfig.md b/packages/build/docs/interfaces/ResolvedConfig.md
@@ -67,3 +67,12 @@ ___
 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.
diff --git a/packages/build/docs/interfaces/UserConfig.md b/packages/build/docs/interfaces/UserConfig.md
@@ -64,6 +64,16 @@ defaults to 'js'.
 
 ___
 
+### outListingFile
+
+ `Optional` **outListingFile**: `string`
+
+If defined, the build process will write a JSON file to the provided path that lists
+all dimensions and variables in the model.  This can be an absolute path, or if it
+is a relative path it will be resolved relative to the `rootDir` for the project.
+
+___
+
 ### plugins
 
  `Optional` **plugins**: [`Plugin`](Plugin.md)[]