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

pub-src-redis

v2.4.0

Published

redis source for pub-server and pub-generator - also provides cache for other sources

Downloads

116

Readme

pub-src-redis

CI

redis source for pub-server and pub-generator - also provides cache for other source

  • uses a redis hash to map file.path to file.text
  • supports non-FILE type (opaque) sources with simple key->data get and set
  • provides get() and put() for bulk reads and writes
  • also provides cache() to proxy-cache another source. This is useful for avoiding startup delays on slow/remote sources like github.

NOTE: This library uses node-redis v3.x because of difficulties upgrading this codebase to v4.x.

src(options)

var src = require('pub-src-redis');

// instantiate source
// options become properties of source
var source = src( { name:'redis-source' } );

// use redis as a cache
source.cache(otherSource, { writeThru:false });

configuring redis keyname

  • the redis keyname is derived from source.name || source.path

redis auth

  • auth configuration has to come from process.env.RCA
  • redis host and port can be configured the same way, or via source.host and source.port
export RCA={auth-pass}
export RCH={host}
export RCP={port}

source.get(cb)

  • get() uses hgetall to fetch the entire hash in one async operation - no filtering is provided
  • the result is an array of file objects each with a path: and a text: property
  • the array is sorted alphabetically by path, as if the files came from a directory tree

source.put(files, cb)

  • put() does nothing unless writable is set on the source
  • it uses hmset to write an array of file objects, overwriting any existing files with the same path
  • there is no partial file write but the array may contain a subset of the files read via get()

source.cache(src, [cacheOpts])

  • interposes src.get() and src.put(), for a different source (src) like github.

  • src.get() will read from src on the first call, and subsequently read only from redis, unless the option get({fromSource:true}, cb) is used

  • src.put() will write directly to redis. cacheOpts.writeThru means that put() will also write to src before returning

  • src.commit() writes a single file from cache back to source - only available if !cacheOpts.writeThru.

  • src.revert() reverts a single file from source - only available if !cacheOpts.writeThru.

source.clear(cb)

  • redis-specific api - used mainly for testing
  • deletes the key used by this src and everything in it - use with care

source.unref()

  • redis-specific api - e.g. used by pub -O
  • allows the server to exit after creating an instance of src-redis
  • for more information, see node_redis