inline doc improvements

Author: usu

src/EmbeddedCollection.ts

@@ -1,4 +1,3 @@
-// import LoadingStoreCollection from './LoadingStoreCollection'
 import { EmbeddedCollectionMeta } from './interfaces/EmbeddedCollection'
 import { Link } from './interfaces/StoreData'
 
@@ -26,9 +25,7 @@ class EmbeddedCollection implements EmbeddedCollectionMeta {
    * @param items           array of items, which can be mixed primitive values and entity references
    * @param reloadUri       URI of the entity containing the embedded collection (for reloading)
    * @param reloadProperty  property in the containing entity under which the embedded collection is saved
-   * @param apiActions      dependency injection of API actions
-   * @param config          dependency injection of config object
-   * @param loadParent      a promise that will resolve when the parent entity has finished (re-)loading
+   * @param loadCollection  a promise that will resolve when the parent entity has finished (re-)loading
    */
   constructor (items: Array<Link>, reloadUri: string, reloadProperty: string, loadCollection: Promise<EmbeddedCollectionMeta> | null = null) {
     this._storeData = {

src/HasItems.ts

@@ -36,8 +36,8 @@ function HasItems<TBase extends HasStoreData> (Base: TBase, apiActions: ApiActio
   }
 
   /**
-     * Returns true if any of the items within 'array' is not yet known to the API (meaning it has never been loaded)
-     */
+   * Returns true if any of the items within 'array' is not yet known to the API (meaning it has never been loaded)
+   */
   function containsUnknownEntityReference (array: Array<Link>): boolean {
     return array.some(entry => isEntityReference(entry) && apiActions.isUnknown(entry.href))
   }
@@ -71,20 +71,20 @@ function HasItems<TBase extends HasStoreData> (Base: TBase, apiActions: ApiActio
      */
     _itemLoader (array: Array<Link>) : Promise<Collection> {
       if (!containsUnknownEntityReference(array)) {
-        return Promise.resolve(this as unknown as Collection)
+        return Promise.resolve(this as unknown as Collection) // we know that this object must be of type Collection
       }
 
       // eager loading of 'fetchAllUri' (e.g. parent for embedded collections)
       if (config.avoidNPlusOneRequests && reloadUri) {
-        return apiActions.reload({ _meta: { reload: { uri: reloadUri || '', property: reloadProperty || '' } } }) as Promise<Collection>
+        return apiActions.reload({ _meta: { reload: { uri: reloadUri || '', property: reloadProperty || '' } } }) as Promise<Collection> // we know that reload resolves to a type Collection
 
       // no eager loading: replace each reference (Link) with a StoreValue (Resource)
       } else {
         const arrayWithReplacedReferences = replaceEntityReferences(array)
 
         return Promise.all(
           arrayWithReplacedReferences.map(entry => entry._meta.load)
-        ).then(() => this as unknown as Collection)
+        ).then(() => this as unknown as Collection) // we know that this object must be of type Collection
       }
     }