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

@synonymdev/web-relay

v1.0.9

Published

Slashtags Web Relay is a powerful abstraction library designed to simplify the management of data on Slashtags.

Downloads

308

Readme

Slashtags Web Relay

Slashtags Web Relay is a powerful abstraction library designed to simplify the management of data on Slashtags.

📦 Installation

To install the package, use the following npm command:

npm install @synonymdev/web-relay

🚀 Getting Started

1. Running the Relay

Copy and customize the configuration file.

cp config/config.example.json config/config.json

Run npm start or use pm2 pm2 start ecosystem.config.json

Setup proxy:

Web-relay uses Server-sent Events to subscribe for updates, which needs HTTP/2 to work best (especially in browsers).

If you are using Nginx, consider using the following configuration:

  location <path here> {
    proxy_pass <relay host:port here>;
    proxy_http_version 1.1;
    proxy_set_header Connection '';
    chunked_transfer_encoding off;
    proxy_buffering off;
    proxy_cache off;
  }

2. Interacting via the Client

const { Client } = require("@synonymdev/web-relay/client");

const alice = new Client({ relay: "http://localhost:3000" });

(async () => {
  const url = await alice.createURL("/foo");
  console.log("Generated URL:", url);

  await alice.put("/foo", Buffer.from("bar"));
  const saved = await alice.get("/foo");
  console.log("Saved Data:", saved.toString());

  const bob = new Client();
  const resolved = await bob.get(url);
  console.log("Resolved Data:", resolved.toString());
})();

📚 API Documentation

Table of Contents


Initialize a Client

const client = new Client({
  keyPair: { secretKey: Uint8Array, publicKey: Uint8Array },
  relay: "http://your-relay-address.com",
  storage: "./path/to/storage",
});

Access the Client's URL

console.log(client.url); // Outputs: slash:<client.id>/[?relay=<relay address>]

Generate a Slashtags URL

const myURL = await client.createURL("/examplePath");
console.log(myURL); // Outputs: Generated Slashtags URL

Create or Update a File

const options = {
  encrypted: true,
  awaitRelaySync: true,
};
await client.put("/examplePath", Buffer.from("Hello World"), options);

Delete a File

const deleteOptions = {
  awaitRelaySync: true,
};
await client.del("/examplePath", deleteOptions);

Retrieve Data

const getOptions = {
  skipCache: false, // Set to `true` to Skip the local cache and wait for the remote relay to respond with fresh data.
};
const data = await client.get(myURL, getOptions);
console.log(data); // Outputs: Retrieved data

Monitor Updates to a File

const onupdate = (value) => {
  console.log("Updated Value:", value);
};
const unsubscribe = coreData.subscribe(myURL, onupdate);
// To stop monitoring:
// unsubscribe();

Terminate Subscriptions and Close the Client

await client.close();