@fluid-experimental/property-changeset 1.2.3-83900 → 2.0.0-internal.1.0.0

package/dist/utils.js

@@ -35,7 +35,7 @@ var Utils;
     /**
         * Traverses a ChangeSet recursively and invokes the callback for each visited property.
         *
-        * @param in_preCallback  - The (pre-order) callback function that is invoked for each property
+        * @param in_preCallback - The (pre-order) callback function that is invoked for each property
         * @param in_postCallback - The (post-order) callback function that is invoked for each property
         * @param in_context -  The traversal context for the currently processed property
         * @param in_levelCallback - A callback for when a node is reached
@@ -426,7 +426,7 @@ var Utils;
     /**
      * Traverses a ChangeSet recursively and invokes the callback for each visited property.
      *
-     * @param in_preCallback  - The (pre-order) callback function that is invoked for each property
+     * @param in_preCallback - The (pre-order) callback function that is invoked for each property
      * @param in_postCallback - The (post-order) callback function that is invoked for each property
      * @param in_context -  The traversal context for the currently processed property
      */
@@ -735,7 +735,7 @@ var Utils;
         /**
          * Returns true if the passed context is an empty object
          * @private
-         * @param in_context change set traversal context
+         * @param in_context - change set traversal context
          * @returns Wether the object is empty
          */
         _isEmptyObject(in_context) {
@@ -789,7 +789,7 @@ var Utils;
         /**
          * Replace the current nested ChangeSet by another one
          *
-         * @param in_newNestedChangeset The new content
+         * @param in_newNestedChangeset - The new content
          */
         replaceNestedChangeSet(in_newNestedChangeset) {
             let parent = this.getParentNestedChangeSet();
@@ -1075,7 +1075,7 @@ var Utils;
      * @param in_callback - A callback that is used to emit every template
      * @param in_finalizer - A callback that is called when enumeration is completed
      *
-     * @returns  All templates that appear in the ChangeSet
+     * @returns All templates that appear in the ChangeSet
      *   The returned object has members key (string), corresponding to the type and value with the
      *   definition (object)
      */
@@ -1156,7 +1156,7 @@ var Utils;
     /**
      * Searches through a ChangeSet and returns all Changes to a properties with a given typeid
      *
-     * @param in_typeid    - The typeid of the property to look for
+     * @param in_typeid - The typeid of the property to look for
      * @param in_changeSet - The ChangeSet to process
      * @param in_excludeTypeids - Exclude all typeids from the returned ChangeSet
      * @returns Returns the applied operations to entries of the given typeid. The returned maps for insert and modify map paths to ChangeSets
@@ -1504,7 +1504,7 @@ var Utils;
      * NOTE: Paths that traverse through sets and arrays are not supported.
      *
      * @param in_changeSet - The changeset to parse
-     * @param - List of paths to filter by. This can either be passed
+     * @param in_paths - List of paths to filter by. This can either be passed
      *     as a flat array of paths or as a Map with the tokenized, tree structured paths, see the
      *     documentation of getChangesToTokenizedPaths for an example.
      *     Note: duplicate paths will be ignored including ones that encompasse other paths
@@ -1701,7 +1701,7 @@ var Utils;
      * Converts an array of paths to the tree structured representation that is needed
      * as input for the function getChangesToTokenizedPaths.
      *
-     * @param  in_paths - An array with paths
+     * @param in_paths - An array with paths
      * @returns {Map} A tree structured representation of the tokenized paths that can be
      *     passed to getChangesToTokenizedPaths and getFilteredChangeSetByPaths.
      */
@@ -1805,7 +1805,7 @@ var Utils;
      *   }
      * }
      * @param in_changeSet - The changeset to extract paths from
-     * @param in_options] - Set of options
+     * @param in_options - Set of options
      * @param in_options.includeOperation - Flag to include the operation
      * @param in_options.includeTypeidInfo - Flag to include the typeid info
      * @returns - Flat list of paths