Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Oct 10, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edf3da8
feat(map): add JSDoc to ModelManager for enableMapType
jonathan-casey Oct 10, 2023
fcd4354
changelog update
jonathan-casey Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/concerto-core/api.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
3 changes: 3 additions & 0 deletions packages/concerto-core/changelog.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions packages/concerto-core/lib/modelmanager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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));
Expand Down
2 changes: 2 additions & 0 deletions packages/concerto-core/types/lib/modelmanager.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading