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

audiovisual

v4.2.0

Published

An audio visualizer web app

Downloads

30

Readme

audiovisual

npm

An audio visualizer built using React.

CLI usage

  1. Install globally: npm install -g audiovisual
  2. Start the server: audiovisual [flags] [directory]
    • You can specify a directory containing songs to serve.
    • The first time you serve a folder (and any time you want to rescan for updated songs), you'll need to use the -s flag.
      • This will create a file named .audiovisual.json in the root of the folder containing a list of all matched files.
      • The server parses media tags from .{mp3,mp4,m4a} files using jsmediatags
        • This might take a while, so please be patient!
      • If you want to scan recursively into subdirectories, use the -r option.
    • Check below for more options, including customizing file matching expressions.
  3. Navigate to the site (localhost:10102 by default) and enjoy your audiovisual experience!

CLI options


Usage: audiovisual [flags] [directory]

        [directory]: Directory from which to serve audio files.
                If omitted, no audio files will be served.

Flags:
        -h=false        Print this help message and exit.

        -m=[.](mp3|wav|ogg)$    Regular expression to use to match scanned files.

        --mflags=i      Flags to use in regular expression matching.

        -p=10102        Port on which to serve the site.

        -s=false        Scan the files directory for new files.

        -r=false        Whether to scan recursively for files.

        -q=false        Quiet mode; don't output anything to stdout.

Node.js API

  1. Install as dependency: npm install audiovisual
  2. In your code:
const audiovisual = require('audiovisual');

/**
 * Configuration options.
 *
 * @typedef {Object} Options
 *
 * @property {string} [filesDir] - Directory from which to serve audio files.
 * If omitted, no audio files will be served.
 * @property {boolean} [scan] - `true` to scan `filesDir` for updated files.
 * @property {boolean} [recursive] - `true` to scan recursively.
 * @property {RegExp} [filesMatch=/[.](mp3|wav|ogg)$/i] - Regular expression to
 * use to match files during scanning.
 * @property {boolean} [quiet] - `true` for quiet mode; don't output anything to
 * `stdout`.
 */
const options = {};

const app = audiovisual(options);

Development

Several build-related scripts are included that can be run using npm run <script>:

  • doc: generates HTML documentation and places it into doc
  • lint: runs eslint on all source files
  • build: builds the project and places the bundle into dist
  • dist: same as above, excepts does production-level optimizations
  • watch: watches for changes, automatically rebuilding when necessary
  • live: starts a webpack-dev-server and enables hot module replacement. Access the server at http://localhost:8080.