Skip to content

Commit 3d51640

Browse files
committed
jsdoc: Document ListItem.identicalTo()
1 parent aeed58c commit 3d51640

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/Task/ListItem.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,15 @@ export class ListItem {
4949
return this.parent === null;
5050
}
5151

52+
/**
53+
* Compare all the fields in another ListItem, to detect any differences from this one.
54+
*
55+
* If any field is different in any way, it will return false.
56+
*
57+
* @note Use {@link Task.identicalTo} to compare {@link Task} objects.
58+
*
59+
* @param other - if this is in fact a {@link Task}, the result of false.
60+
*/
5261
identicalTo(other: ListItem) {
5362
if (this.constructor.name !== other.constructor.name) {
5463
return false;

0 commit comments

Comments
 (0)