Skip to content

Commit 360dc5e

Browse files
committed
Added mutability documentation to diff
1 parent 961af43 commit 360dc5e

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

b+tree.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -573,6 +573,7 @@ export default class BTree<K=any, V=any> implements ISortedMapF<K,V>, ISortedMap
573573
* of shared data (obtained by calling the `clone` or `with` APIs) and will avoid
574574
* any iteration of shared state.
575575
* The handlers can cause computation to early exit by returning {break: R}.
576+
* Neither of the collections should be changed during the comparison process (in your callbacks), as this method assumes they will not be mutated.
576577
* @param other The tree to compute a diff against.
577578
* @param onlyThis Callback invoked for all keys only present in `this`.
578579
* @param onlyOther Callback invoked for all keys only present in `other`.

0 commit comments

Comments
 (0)