add metadata container

tristanls · Aug 21, 2017 · 7643bd0 · 7643bd0
1 parent 9b9c3c0
commit 7643bd0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -254,6 +254,10 @@ Emitted when `contact` was removed from the bucket.
 
 Emitted when a previously existing ("previously existing" means `oldContact.id` equals `newContact.id`) contact was added to the bucket and it was replaced with `newContact`.
 
+#### Property: 'metadata'
+
+The `metadata` object serves as a container that can be used by implementations using k-bucket. One example is storing a timestamp to indicate the last time when a node in the bucket was responding to a ping.
+
 ## Releases
 
 [Current releases](https://github.com/tristanls/k-bucket/releases).

diff --git a/index.js b/index.js
@@ -73,6 +73,8 @@ function KBucket (options) {
   this.arbiter = options.arbiter || KBucket.arbiter
 
   this.root = createNode()
+
+  this.metadata = Object.assign({}, options.metadata)
 }
 
 inherits(KBucket, EventEmitter)