feat(*): Add JSDoc for ModelManager enableMapType option (#731)

* feat(map): add JSDoc to ModelManager for enableMapType Signed-off-by: Jonathan Casey <jonathan.casey@docusign.com> * changelog update Signed-off-by: Jonathan Casey <jonathan.casey@docusign.com> --------- Signed-off-by: Jonathan Casey <jonathan.casey@docusign.com>
accordproject · Oct 10, 2023 · 3488b77 · 3488b77
1 parent a801e7d
commit 3488b77
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/packages/concerto-core/api.txt b/packages/concerto-core/api.txt
@@ -323,7 +323,7 @@ class ModelLoader {
    + ModelManager[] loadModelManagerFromModelFiles(object[],string[],object,boolean?,boolean?,number?) 
 }
 class ModelManager extends BaseModelManager {
-   + void constructor(object?,boolean?,Object?) 
+   + void constructor(object?,boolean?,Object?,boolean?) 
    + ModelFile addCTOModel(string,string?,boolean?) throws IllegalModelException
 }
    + object getRootModel() 

diff --git a/packages/concerto-core/changelog.txt b/packages/concerto-core/changelog.txt
@@ -24,6 +24,9 @@
 # Note that the latest public API is documented using JSDocs and is available in api.txt.
 #
 
+Version 3.13.1 {f435a20a00712e49c5cd32bc73ecb06a} 2023-10-03
+- Add JSDoc for enableMapType option on ModelManager
+
 Version 3.13.1 {6b09c1c58abcc77eecbb44e375c2efb8} 2023-10-03
 - Add enableMapType option to BaseModelManager options
 

diff --git a/packages/concerto-core/lib/modelmanager.js b/packages/concerto-core/lib/modelmanager.js
@@ -59,6 +59,7 @@ class ModelManager extends BaseModelManager {
      * @param {object} [options] - ModelManager options, also passed to Serializer
      * @param {boolean} [options.strict] - require versioned namespaces and imports
      * @param {Object} [options.regExp] - An alternative regular expression engine.
+     * @param {boolean} [options.enableMapType] - When true, the Concerto Map Type feature is enabled
      */
     constructor(options) {
         super(options, ctoProcessFile(options));

diff --git a/packages/concerto-core/types/lib/modelmanager.d.ts b/packages/concerto-core/types/lib/modelmanager.d.ts
@@ -19,10 +19,12 @@ declare class ModelManager extends BaseModelManager {
      * @param {object} [options] - ModelManager options, also passed to Serializer
      * @param {boolean} [options.strict] - require versioned namespaces and imports
      * @param {Object} [options.regExp] - An alternative regular expression engine.
+     * @param {boolean} [options.enableMapType] - When true, the Concerto Map Type feature is enabled
      */
     constructor(options?: {
         strict?: boolean;
         regExp?: any;
+        enableMapType?: boolean;
     });
     /**
      * Adds a model in CTO format to the ModelManager.