npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hypercore-seekable-iterator

v1.1.0

Published

An async iterator for Hypercores that supports seek

Downloads

7

Readme

hypercore-seekable-iterator

A seekable AsyncIterator for Hypercores that supports AbortControllers for cancellation, and block prefetching.

By default, the iterator will linearly prefetch the next 10 blocks each time a chunk is read.

Installation

npm i hypercore-seekable-iterator

Example

const core = hypercore(ram)
const SeekableIterator = require('hypercore-seekable-iterator')

// Assuming the core contains many blocks.

const ite = new SeekableIterator(core, {
  // Start reading at byte offset 10 in the Hypercore
  byteOffset: 10,
    // Stop reading at position 60
  byteLength: 50
})

for await (const chunk of ite) {
  // Can seek during iteration.
  // Seeking is sync, and will happen before the next chunk is yielded.
  // The seek argument is relative to the initial start position.
  if (chunk.length === 10) {
    ite.seek(0)
  }
}

API

const ite = new HypercoreSeekableIterator(core, opts = {})

Create a new iterator.

Options include:

  byteOffset, // The initial byte offset
  byteLength, // The size of the range to read (defines the end position)
  startBlock, // (Optimization) If you know which block the start position is in, this speeds up the first read
  endBlock,   // (Optimization) If you know which block the end position is in, this speeds up the first read,
  prefetch    // A function of the form (ite, index) => (download range)

await ite.next()

Yield the next chunk.

ite.seek(pos)

Seek to a numeric position relative to the initial starting byte offset (e.g. ite.seek(0) will return to the initial position).

Prefetch

You can pass in a custom prefetching function to define how blocks should be downloaded in the background during iteration.

The default prefetch will always download the next 10 blocks. In the future, this will become adaptive!

A prefetch function returns arguments to Hypercore's download method:

function customPrefetch (ite, index) {
  return { start: index + 1, end: index + 5, linear: true }
}

ite is an instance of HypercoreSeekableIterator (you can use this to determine download bounds). index is the index of the current read.

License

MIT