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

package/lib/changeset_operations/array.js

@@ -33,11 +33,10 @@ var ArrayChangeSetRangeType;
     ArrayChangeSetRangeType[ArrayChangeSetRangeType["partOfApartOfB"] = 7] = "partOfApartOfB";
 })(ArrayChangeSetRangeType || (ArrayChangeSetRangeType = {}));
 /**
- * compute a range for an operation of the current change set
- * @param io_operation input
- * @param in_aOffset the offset that needs to be added to transform the operation
- * @param io_resultingRange
- * the computed range
+ * Computes a range for an operation of the current change set
+ * @param io_operation - Input
+ * @param in_aOffset - The offset that needs to be added to transform the operation
+ * @param io_resultingRange - The computed range
  */
 const getRangeForCurrentStateOperation = function (io_operation, in_aOffset, io_resultingRange) {
     if (!io_operation) {
@@ -81,10 +80,10 @@ const getRangeForCurrentStateOperation = function (io_operation, in_aOffset, io_
 };
 const getOpLength = (op) => isNumber(op[1]) ? op[1] : op[1].length;
 /**
- * computes the impact range for a given operation of the applied change set
- * @param in_operation the op
- * @param io_resultingRange the computed range
- * @param in_flag the flag for the resulting range, default is 'complete B'
+ * Computes the impact range for a given operation of the applied change set
+ * @param in_operation - The op
+ * @param io_resultingRange - The computed range
+ * @param in_flag - The flag for the resulting range, default is 'complete B'
  * @param in_options - Optional additional parameters
  */
 const getRangeForAppliedOperation = function (in_operation, io_resultingRange, in_flag, in_options) {
@@ -149,10 +148,10 @@ const getRangeForAppliedOperation = function (in_operation, io_resultingRange, i
  * Splits the second and third parameter in an array remove or modify operation into two segments.
  * This treats the three possible cases array, string and length that are allowed in a remove operation
  *
- * @param in_firstResult  - Place where the first half is stored
+ * @param in_firstResult - Place where the first half is stored
  * @param in_secondResult - Place where the second half is stored
- * @param in_data         - The original operation
- * @param in_start        - Index at which the operation is split
+ * @param in_data - The original operation
+ * @param in_start - Index at which the operation is split
  * @private
  */
 const _splitArrayParameter = function (in_firstResult, in_secondResult, in_data, in_start) {
@@ -230,13 +229,13 @@ const _copyOperation = function (in_sourceOperation, in_targetOperation) {
 /**
  * cut overlapping ranges in non-overlapping and completely overlapping segments
  * ranges of length 0 just cut lengthy ranges
- * @param io_rangeA input A
- * @param io_rangeB input B
- * @param io_resultingSegment the resulting overlapping segment
- * @param in_rebasing is this function called for rebasing - we have to implement two different
- *     behaviors of this function: one for squashing and one for rebasing, because an insert-insert
- *     operation in squashing should be separte segments, while for rebasing, we need one segment
- *     for both inserts to be able to report a conflict.
+ * @param io_rangeA - Input A
+ * @param io_rangeB - Input B
+ * @param io_resultingSegment - The resulting overlapping segment
+ * @param in_rebasing - Is this function called for rebasing - we have to implement two different
+ * behaviors of this function: one for squashing and one for rebasing, because an insert-insert
+ * operation in squashing should be separte segments, while for rebasing, we need one segment
+ * for both inserts to be able to report a conflict.
  * overlapping range or
  * (partial) A or B
  */
@@ -550,9 +549,9 @@ const splitOverlapping = function (io_rangeA, io_rangeB, io_resultingSegment, in
 /**
  * merge in_op with the last op of that category in io_changeset (if possible)
  * e.g. merge an delete [1,3] with delete [3,2] to delete [1,5]
- * @param in_op - the op to merge
- * @param io_changeset - the changeset to merge the op to
- * @param in_targetIndex the transformed target index offset
+ * @param in_op - The op to merge
+ * @param io_changeset - The changeset to merge the op to
+ * @param in_targetIndex - The transformed target index offset
  * @returns true if the merge was possible and executed
  */
 const mergeWithLastIfPossible = function (in_op, io_changeset, in_targetIndex, in_options) {
@@ -640,12 +639,12 @@ const mergeWithLastIfPossible = function (in_op, io_changeset, in_targetIndex, i
 };
 /**
  * push an operation to a changeset, will try to merge the op if possible
- * @param in_op the operation we want to push
- * @param io_changeset target
- * @param the current offset
+ * @param in_op - The operation we want to push
+ * @param io_changeset - The target
+ * @param the - The current offset
  * @param in_options - Optional additional parameters
- * @param in_lastIteratorARemove - Information about the last remove operation in iterator A
- * @param in_segment - Segment this operation is part of
+ * @param in_lastIteratorARemove - The information about the last remove operation in iterator A
+ * @param in_segment - The segment this operation is part of
  */
 const pushOp = function (in_op, io_changeset, in_indexOffset, in_options, in_lastIteratorARemove, in_segment) {
     let writeTargetIndex;
@@ -723,8 +722,8 @@ const pushOp = function (in_op, io_changeset, in_indexOffset, in_options, in_las
 /**
  * handle combinations of range operations
  * e.g. an insert and delete at the same place and same length nullify each other
- * @param in_segment the two ops to be combined
- * @param in_isPrimitiveType is it an array of primitive types
+ * @param in_segment - The two ops to be combined
+ * @param in_isPrimitiveType - Is it an array of primitive types
  * ATTENTION: We overwrite opB to save garbage (instead of creating a result OP)
  */
 const handleCombinations = function (in_segment, in_isPrimitiveType) {
@@ -884,15 +883,14 @@ const arraysHaveSameValues = function (in_arr1, in_arr2) {
  *        | [rem orig. data]| (note the user)  | [rem dupl. rem]  |
  * -------|-----------------+------------------+------------------|
  *
- * @param {{opA:{}, opB:{}}} in_segment the two ops to be combined
- * @param {Array.<property-changeset.ChangeSet.ConflictInfo>} out_conflicts -
- *     A list of paths that resulted in conflicts together with the type of the conflict
- * @param {string} in_basePath -
- *     Base path to get to the property processed by this function
- * @param {boolean} in_isPrimitiveType is it an array of primitive types
+ * @param {{opA:{}, opB:{}}} in_segment - The two ops to be combined
+ * @param {Array.<property-changeset.ChangeSet.ConflictInfo>} out_conflicts - A list of paths that resulted in
+ * conflicts together with the type of the conflict
+ * @param {string} in_basePath - Base path to get to the property processed by this function
+ * @param {boolean} in_isPrimitiveType - is it an array of primitive types
  * @param {Object} [in_options] - Optional additional parameters
  * @param {Map} [in_options.applyAfterMetaInformation] - Additional meta information which help later to obtain
- *                                                       more compact changeset during the apply operation
+ * more compact changeset during the apply operation
  */
 const handleRebaseCombinations = function (in_segment, out_conflicts, in_basePath, in_isPrimitiveType, in_options) {
     const opA = in_segment.opA;
@@ -1068,10 +1066,10 @@ const handleRebaseCombinations = function (in_segment, out_conflicts, in_basePat
 };
 /**
  * apply a range's operation to the changeset
- * @param in_segment to be applied
- * @param io_changeset target
- * @param in_currentIndexOffset current offset
- * @param in_isPrimitiveType is it an array of primitive types
+ * @param in_segment - to be applied
+ * @param io_changeset - target
+ * @param in_currentIndexOffset - current offset
+ * @param in_isPrimitiveType - is it an array of primitive types
  */
 const applySegment = function (in_segment, io_changeset, in_currentIndexOffset, lastIteratorARemove, in_isPrimitiveType, in_options) {
     if (!in_segment) {
@@ -1097,12 +1095,12 @@ const applySegment = function (in_segment, io_changeset, in_currentIndexOffset,
 };
 /**
  * apply a range's operation to the rebased changeset
- * @param in_segment to be applied
- * @param io_changeset target
- * @param in_currentIndexOffset current offset
+ * @param in_segment - to be applied
+ * @param io_changeset - target
+ * @param in_currentIndexOffset - current offset
  * @param out_conflicts - A list of paths that resulted in conflicts together with the type of the conflict
  * @param in_basePath - Base path to get to the property processed by this function
- * @param in_isPrimitiveType is it an array of primitive types
+ * @param in_isPrimitiveType - is it an array of primitive types
  */
 const applyRebaseSegment = function (in_segment, io_changeset, in_currentIndexOffset, out_conflicts, in_basePath, in_isPrimitiveType, in_options) {
     if (!in_segment) {
@@ -1130,9 +1128,9 @@ export var ChangeSetArrayFunctions;
      * property root and it will be applied behind the base ChangeSet (assuming that the changes are relative to the
      * state after the base ChangeSet has been applied. It will change the base ChangeSet.)
      *
-     * @param io_basePropertyChanges    - The ChangeSet describing the initial state
+     * @param io_basePropertyChanges - The ChangeSet describing the initial state
      * @param in_appliedPropertyChanges - The ChangeSet to apply to this state
-     * @param in_typeid                 - The typeid of the contents of the collection (without the collection type)
+     * @param in_typeid - The typeid of the contents of the collection (without the collection type)
      */
     function _performApplyAfterOnPropertyArray(io_basePropertyChanges, in_appliedPropertyChanges, in_typeid, in_options) {
         ConsoleUtils.assert(in_typeid, "_performApplyAfterOnPropertyArray: typeid missing");
@@ -1424,7 +1422,7 @@ export var ChangeSetArrayFunctions;
      *
      * @param in_ownPropertyChangeSet - The ChangeSet for the property stored in this object
      * @param io_rebasePropertyChangeSetParent - The Array containing the ChangeSet for the property to be rebased
-     * @param in_key the key to the ChangeSet in io_rebasePropertyChangeSetParent we are rebasing on
+     * @param in_key - The key to the ChangeSet in io_rebasePropertyChangeSetParent we are rebasing on
      * @param in_basePath - Base path to get to the property processed by this function
      * @param out_conflicts - A list of paths that resulted in conflicts together with the type of the conflict
      */