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

hyperspace-mirroring-service

v1.0.7

Published

A Hyperspace service with a RPC API for mirroring.

Downloads

14

Readme

hyperspace-mirroring-service

A Hyperspace service with a RPC API for mirroring.

Installation

npm i hyperspace-mirroring-service

Usage

This service is meant to run alongside a running Hyperspace server.

With Hyperspace running in a separate terminal:

❯ ./bin/index.js
Running hyperspace-mirror/1.0.6 linux-x64 node-v14.15.0
Listening on /tmp/hyperspace-mirroring.sock

Then you can import hyperspace-mirroring-service/client inside a script, and it will auto-connect to the running server.

The mirror service provides an HRPC endpoint with methods for mirroring, unmirror, and listing mirroed Hypercore-based data structures.

Currently it supports mirroring Hyperdrives and individual Hypercores. It doesn't do data-structure detection by looking at Hypercore headers -- you gotta explicitly provide the type.

As of now, Hyperdrive mirroring doesn't handle mounts. Maybe one day

API

await client.mirror(key, type)

Start mirroring a Hypercore-based data structure.

This command will currently special-case the hyperdrive type, mirroring both metadata and content feeds.

await client.unmirror(key, type)

Stop mirroring a Hypercore-based data structure.

This command will currently special-case the hyperdrive type, unmirroring both metadata and content feeds.

await client.status(key, type)

Check if a data structure is being mirrored;

Returns an object of the form:

{
  key, // Buffer
  type, // string
  mirroring // bool
}

await client.list()

List all data structures being mirrored.

Returns an Array of status objects with the same shape as the status return value.

await client.stop()

Shut down the server.

License

MIT