Added indexKey-field to entries of ReadStreams containing keys and values (#34)

README.md

@@ -79,8 +79,8 @@ posts.put('1337', {
     start: 10,
     end: 20
   }).on('data', console.log.bind(console, 'read'))
-  // => read { key: '1337', value: { id: '1337', title: 'a title', body: 'lorem ipsum' } }
-
+  // => read { key: '1337', indexKey: '11!1337', value: { id: '1337', title: 'a title', body: 'lorem ipsum' } }
+  
   posts.byLength.createKeyStream({
     start: 10,
     end: 20
@@ -128,7 +128,7 @@ Get the value that has been indexed with `key`.
 
 ### AutoIndex#create{Key,Value,Read}Stream(opts)
 
-Create a readable stream that has indexes as keys and indexed data as values.
+Create a readable streams. The order of entries matches the ordering of the indices. Keys and values are taken from the underlying level. If both `key` and `value` are requested, the entries will contains another field `indexKey`, which contains the index key for that entry.
 
 ### AutoIndex#manifest
 

example.js

@@ -45,7 +45,7 @@ posts.put('1337', {
     start: 10,
     end: 20
   }).on('data', console.log.bind(console, 'read'))
-  // => read { key: '1337', value: { id: '1337', title: 'a title', body: 'lorem ipsum' } }
+  // => read { key: '1337', indexKey: '11!1337', value: { id: '1337', title: 'a title', body: 'lorem ipsum' } }
 
   posts.byLength.createKeyStream({
     start: 10,

index.js

@@ -160,6 +160,7 @@ function AutoIndex (db, idb, reduce, opts) {
           } else {
             done(null, {
               key: dbKey,
+              indexKey: idbKey,
               value: value
             })
           }

test/multi-key.js

@@ -68,10 +68,13 @@ test('multi-key index', function (t) {
       function handleResults (data) {
         t.equal(data.length, 3)
         t.equal(data[0].key, '0')
+        t.equal(data[0].indexKey, 'foo!0')
         t.deepEqual(data[0].value, postData[0])
         t.equal(data[1].key, '20')
+        t.equal(data[1].indexKey, 'foo!20')
         t.deepEqual(data[1].value, singlePost)
         t.equal(data[2].key, '3')
+        t.equal(data[2].indexKey, 'foo!3')
         t.deepEqual(data[2].value, postData[3])
         posts.del(3, function (err) {
           t.error(err)
@@ -97,8 +100,11 @@ test('multi-key index', function (t) {
         tagIndexStream.pipe(concatStream)
         function handleResults (data) {
           t.equal(data.length, 2)
+          t.equal(data[0].key, '0')
+          t.equal(data[0].indexKey, 'foo!0')
           t.deepEqual(data[0].value, postData[0])
           t.equal(data[1].key, '20')
+          t.equal(data[1].indexKey, 'foo!20')
           t.deepEqual(data[1].value, singlePost)
           t.end()
         }

test/read-stream.js

@@ -31,6 +31,7 @@ test('read streams', function (t) {
     }).on('data', function (data) {
       t.deepEqual(data, {
         key: '1337',
+        indexKey: '11',
         value: post
       })
     })