add documentation to enable npm workspaces type

SAP · Jan 22, 2025 · dea250e · dea250e
1 parent 811810b
commit dea250e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/fiori-elements-writer/src/types.ts b/packages/fiori-elements-writer/src/types.ts
@@ -114,6 +114,12 @@ export interface FioriElementsApp<T> extends Ui5App {
          * This will eventually move up to {@link Ui5App.appOptions}
          */
         addTests?: boolean;
+        /**
+         * Enables NPM workspaces for the application. 
+         * This is applicable when the service is of type `capService`. For more details, refer to the 
+         * `applyCAPUpdates` function at {@link ../../cap-config-writer/src/cap-writer/updates.ts}.
+         * When set to true and the CDS UI5 plugin is enabled, the application will be served using the `appId`.
+         */
         enableNPMWorkspaces?: boolean;
     };
 }