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

nyats-client

v0.2.0-alpha.2

Published

Client for the nyats (Not Yet Another Thumbnail Service) IPFS thumbnailing server.

Downloads

8

Readme

nyats-client

Client for the nyats (Not Yet Another Thumbnail Service) IPFS thumbnailing server.

Installation

npm i -S nyats-client

Usage

The library consists of 2 functions:

IPNSThumbnailURL(cid, width, height)

Returns URL to load pre-existing thumbnails from cache. This URL will return a 404 if it does not, in which case a thumbnail will need to be generated.

GenerateThumbnailURL(cid, width, height, type?)

Returns a URL used to generate a thumbnail. If succesful, a redirect to an IPFS gateway is returned. The type parameter is optional and can be used to skip mimetype detection on the server. Allowed values are: image, video, document and audio.

Example

Please see demo/index.html for a minimal example implementation in pure HTML5/JS.

Configuration

In the default configuration, this library uses ipfs-search.com testing environment. There are no guarantees that we will continue this service and without prior permission, commercial usage is not allowed. You are free to run your own server, in which case the configuration can be set in two different ways:

GetClient()

import {GetClient} from "nyats-client";

const client = GetClient({
  endpoint: "<API ENDPOINT>",
  gatewayURL: "<IPFS GATEWAY>",
  ipnsRoot: "/ipns/<PEER ID>/",
});

client.IPNSThumbnailURL(...);

Override default configuration

import {DefaultConfig, IPNSThumbnailURL, GenerateThumbnailURL} from "nyats-client";

DefaultConfig.endpoint = "<API ENDPOINT>";
DefaultConfig.gatewayURL = "<IPFS GATEWAY>";
DefaultConfig.ipnsRoot = "/ipns/<PEER ID>/";
IPNSThumbnailURL(...);

Server

To run your own server (recommended), check out nyats-server.

Disclaimer

There are no guarantees provided and commercial usage is not allowed. Please contact us at [email protected] if you are interested in production-scale usage.