chore: address review

libp2p · Jul 15, 2020 · a4718ed · a4718ed
1 parent 1411c12
commit a4718ed
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/src/record/README.md b/src/record/README.md
@@ -44,7 +44,7 @@ class PeerRecord extends Record {
     // Implement and return using Protobuf
   }
 
-  isEqual (other) {
+  equals (other) {
     // Verify
   }
 }
@@ -62,9 +62,9 @@ Marshal a record to be used in a libp2p envelope.
 
 It returns a `Protobuf` containing the record data.
 
-### isEqual
+### equals
 
-- `record.isEqual(other)`
+- `record.equals(other)`
 
 Verifies if the other Record is identical to this one.
 

diff --git a/src/record/index.js b/src/record/index.js
@@ -27,8 +27,8 @@ class Record {
    * Verifies if the other provided Record is identical to this one.
    * @param {Record} other
    */
-  isEqual (other) {
-    throw errcode(new Error('isEqual must be implemented by the subclass'), 'ERR_NOT_IMPLEMENTED')
+  equals (other) {
+    throw errcode(new Error('equals must be implemented by the subclass'), 'ERR_NOT_IMPLEMENTED')
   }
 }
 

diff --git a/src/record/tests/index.js b/src/record/tests/index.js
@@ -28,8 +28,8 @@ module.exports = (test) => {
     })
 
     it('is able to compare two records', () => {
-      const isEqual = record.isEqual(record)
-      expect(isEqual).to.eql(true)
+      const equals = record.equals(record)
+      expect(equals).to.eql(true)
     })
   })
 }