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

@wikimedia/cassandra-storage

v1.0.3

Published

A nodejs storage engine and expressjs middleware to store HTTP responses to cassandra

Downloads

752

Readme

NodeJS cassandra storage

Description

A Cassandra DB storage abstraction to be used as a backend in nodejs projects. This library also provides an Express JS middleware to easily store/cache HTTP responses.

Usage

Install from main git branch:

> npm install https://gitlab.wikimedia.org/repos/content-transform/nodejs-cassandra-storage/-/archive/main/nodejs-cassandra-storage-main.tar.gz

Local development environment

Dependencies:

When using local nodejs for development:

  • nodejs (CI is using node18)
  • docker/docker-compose (required for backing cassandra instance)

When using a fully docker based setup:

  • docker/docker-compose

Local nodejs based setup

  • Start development cassandra instance (initialization might take some time)
> docker compose up -d cassandra
# Wait until cassandra STATUS is healthy (DB is ready for connections)
> docker compose ps cassandra
  • Install js dependencies
> npm install
  • Run linter
> npm run lint
  • Run automatic linting/formatting fixes
> npm run lint:fix
  • Run tests
> npm run tests

Docker based setup

  • Get shell access to a nodejs container:
> docker compose -it run tests bash

Then you can use the same npm commands as described in the previous section.

  • Running the tests suite
> docker compose run tests

Middleware

An example of a simple ExpressJS app using the storage middleware can be found under ./examples/middleware.

JSDocs

To generate the API documentation:

> npm run env -- jsdoc -c ./jsdoc.json  lib

HTML output is rendered in ./out