ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-17 14:48:13 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

docs: better docs and types for the API (#7796)

Browse Source 
* docs: fix type imports in openmct.js

* docs: fix type imports

* docs: fix types for eventHelpers

* docs: types for TypeRegistry

* docs: types for StatusAPI

* docs: fix ObjectAPI types and docs

* docs: more types

* docs: improved types for main entry

* docs: improved types

* fix: unbreak the linting

* chore: remove EventEmitter webpack alias as it hide types

* fix: return type

* fix: parameter type

* fix: types for composables

* chore: add webpack consts to eslintrc

* fix: remove usage of deprecated timeAPI methods and add a ton of docs and types

* docs: update README.md

* lint: clean up API.md

* chore: upgrade eventemitter to v5.0.2

* refactor: update imports for EventEmitter to remove alias

* format: lint

* docs: update types for Views and ViewProviders

* docs: expose common types at the base import level

* docs(types): remove unnecessary tsconfig options

* docs: ActionAPI

* docs: AnnotationAPI

* docs: import common types from the same origin

* docs: FormsAPI & TelemetryAPI types

* docs: FormController, IndicatorAPI

* docs: MenuAPI, ActionsAPI

* docs: `@memberof` is not supported by `tsc` and JSDoc generation so remove it

* docs: RootRegistry and RootObjectProvider

* docs: Transaction + Overlay

* lint: words for the word god

* fix: review comments
This commit is contained in:
Jesse Mazzella
2024-07-31 10:46:16 -07:00
committed by GitHub
parent e3fcbe1a35
commit 4ee68cccd6
117 changed files with 1494 additions and 1089 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/api/composition/CompositionCollection.js
View File

@ -21,7 +21,7 @@
*****************************************************************************/
/**
* @typedef {import('../objects/ObjectAPI').DomainObject} DomainObject
* @typedef {import('openmct').DomainObject} DomainObject
*/
/**
@ -200,10 +200,9 @@ export default class CompositionCollection {
/**
* Load the domain objects in this composition.
*
* @param {AbortSignal} abortSignal
* @param {AbortSignal} [abortSignal]
* @returns {Promise.<Array.<DomainObject>>} a promise for
* the domain objects in this composition
* @memberof {module:openmct.CompositionCollection#}
* @name load
*/
async load(abortSignal) {
@ -280,7 +279,7 @@ export default class CompositionCollection {
/**
* Handle adds from provider.
* @private
* @param {import('../objects/ObjectAPI').Identifier} childId
* @param {import('openmct').Identifier} childId
* @returns {DomainObject}
*/
#onProviderAdd(childId) {