about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLily Foster <lily@lily.flowers>2023-06-28 08:29:30 -0400
committerLily Foster <lily@lily.flowers>2023-06-29 07:43:12 -0400
commit3990bb5b5ee89fa64a6a6b5a3e486bdabe7290b9 (patch)
treef1d7012798fcd72114e566b534eb5b6b953a8d93 /doc
parent19e48f0da9d62be9b936ca4a33f6df23a7a123b2 (diff)
doc/languages-frameworks/javascript: add npmWorkspace and npmPruneFlags args
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/javascript.section.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/languages-frameworks/javascript.section.md b/doc/languages-frameworks/javascript.section.md
index 7fd84ed0e65e5..0a2099b0a6b12 100644
--- a/doc/languages-frameworks/javascript.section.md
+++ b/doc/languages-frameworks/javascript.section.md
@@ -196,12 +196,14 @@ buildNpmPackage rec {
 * `npmDepsHash`: The output hash of the dependencies for this project. Can be calculated in advance with [`prefetch-npm-deps`](#javascript-buildNpmPackage-prefetch-npm-deps).
 * `makeCacheWritable`: Whether to make the cache writable prior to installing dependencies. Don't set this unless npm tries to write to the cache directory, as it can slow down the build.
 * `npmBuildScript`: The script to run to build the project. Defaults to `"build"`.
+* `npmWorkspace`: The workspace directory within the project to build and install.
 * `dontNpmBuild`: Option to disable running the build script. Set to `true` if the package does not have a build script. Defaults to `false`. Alternatively, setting `buildPhase` explicitly also disables this.
 * `dontNpmInstall`: Option to disable running `npm install`. Defaults to `false`. Alternatively, setting `installPhase` explicitly also disables this.
 * `npmFlags`: Flags to pass to all npm commands.
-* `npmInstallFlags`: Flags to pass to `npm ci` and `npm prune`.
+* `npmInstallFlags`: Flags to pass to `npm ci`.
 * `npmBuildFlags`: Flags to pass to `npm run ${npmBuildScript}`.
 * `npmPackFlags`: Flags to pass to `npm pack`.
+* `npmPruneFlags`: Flags to pass to `npm prune`. Defaults to the value of `npmInstallFlags`.
 
 #### prefetch-npm-deps {#javascript-buildNpmPackage-prefetch-npm-deps}