Comment doc for Collection#getId().

2015-04-27 12:14:30 +02:00 · 2015-04-27 12:14:30 +02:00 · d78522f5e1
commit d78522f5e1
parent 3da2a618b9
1 changed files with 6 additions and 2 deletions
--- a/packages/xo-collection/src/collection.js
+++ b/packages/xo-collection/src/collection.js
@ -57,8 +57,12 @@ export default class Collection extends EventEmitter {
    this._size = 0
  }

-  getKey (item) {
-    return item && item.id
+  // Overridable method used to compute the key of an item when
+  // unspecified.
+  //
+  // Default implementation returns the `id` property.
+  getKey (value) {
+    return value && value.id
  }

  // -----------------------------------------------------------------