hypercore-index

hypercore-index

Linear asynchronous stateful indexing of a hypercore feed.

Traverses a hypercore feed in chronologic order and lets you consume each entry via some asynchronous function. Remembers where you left inside the feed's db and continues there on later runs.

Example

const hypercore = require('hypercore')
const index = require('hypercore-index')

const core = hypercore(db)
const feed = core.createFeed()

index(feed, function onentry (entry, next) {
  console.log('entry', entry.toString())
  next()
}, function ondone (err) {
  if (err) throw err
  console.log('Done!')
})

Installation

$ npm install hypercore-index

API

index(feed, [opts], onentry, [ondone])

Options:

• start: The first index. Default: 0
• end: The last index. Default: Infinity
• key: The key under which to store the last processed index in the db. Default: feed.key
• live: Whether to keep scanning. Default: true, unless you pass opts.end

license

MIT