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

urlprotocol

v1.0.1

Published

A minimalistic library to handle custom URL protocols in Node.js

Downloads

12

Readme

urlprotocol

A Node.js library to handle custom URL protocols and route them to specific API paths.

Installation

To install the package, use npm:

npm install urlprotocol

Usage

The library allows you to define custom URL protocols and route them to specific API paths. Below is an example of how to use the package:

Example

Create a file named test.js and add the following code:

const CustomProtocolHandler = require('urlprotocol');

const protocolHandler = new CustomProtocolHandler('hello');

protocolHandler.register('/alertmessage', (req, res) => {
    res.writeHead(200, { 'Content-Type': 'application/json' });
    res.end(JSON.stringify({ message: 'This is an alert message!' }));
});

protocolHandler.start(3000);

In this example, when the URL hello://alertmessage is called, it will respond with a JSON message: {"message":"This is an alert message!"}.

API

CustomProtocolHandler

  • constructor(protocol)

    • Creates a new CustomProtocolHandler for the specified protocol.
  • register(path, handler)

    • Registers a handler function for the specified path.
  • start(port)

    • Starts the HTTP server on the specified port.

Full Example

Here's a complete example of how to use the library:

const CustomProtocolHandler = require('urlprotocol');

const protocolHandler = new CustomProtocolHandler('hello');

protocolHandler.register('/alertmessage', (req, res) => {
    res.writeHead(200, { 'Content-Type': 'application/json' });
    res.end(JSON.stringify({ message: 'This is an alert message!' }));
});

protocolHandler.register('/greeting', (req, res) => {
    res.writeHead(200, { 'Content-Type': 'text/plain' });
    res.end('Hello, world!');
});

protocolHandler.start(3000);

In this example, two paths are registered: /alertmessage and /greeting. The hello://alertmessage URL will respond with a JSON message, and the hello://greeting URL will respond with a plain text message.