From cf5f1796293e183bf08b8f19434df2b3bb639a54 Mon Sep 17 00:00:00 2001 From: Chris Campbell Date: Tue, 4 Jun 2024 12:48:12 -0700 Subject: [PATCH] docs: update API docs for build package --- packages/build/docs/interfaces/ResolvedConfig.md | 9 +++++++++ packages/build/docs/interfaces/UserConfig.md | 10 ++++++++++ 2 files changed, 19 insertions(+) diff --git a/packages/build/docs/interfaces/ResolvedConfig.md b/packages/build/docs/interfaces/ResolvedConfig.md index 8b9b43a2..ac1ea183 100644 --- 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 index a306ce43..ee18c266 100644 --- 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)[]