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

@davidrockin/sapling

v0.0.2

Published

A websocket framework

Downloads

4

Readme

Sapling

Sapling is an experimental Websocket framework. Inspired by Express' routing system, Sapling was designed to route Websocket requests to an appropriate handler/controller.

Sapling is still in development and misses some features. Current state is just the prototype for my own side projects. :)

Getting Started

Add Sapling to your project using npm i @davidrockin/sapling

New Projects

It's probably easier to start a new project using Sapling. Just create a new Sapling instance, and add routes as you will.

const Sapling = require('sapling');

let app = new Sapling({ port: 8000 });
app.use((req, res) => { ... });

// ... rest of code here ...

Existing Projects

If you have an existing project with an Express Server, HTTP Server and/or Websocket Server, you can just assign their instance(s) to the options object in the Sapling constructor.

const Sapling = require('sapling');

let app = new Sapling({

	express: YourExpressInstance,
	http   : HTTPServerInstance,
	ws     : WebSocketServerInstance,

	// note: if you don't specify an HTTP server instance, it'll listen
	// on the port below. If an instance exist and listening, Websocket
	// server will just hook into your existing HTTP server
	port   : 8080

});

// ...

Registering Routes use([action,] handler)

If you want to register a route that will respond to a specific action

app.use('example', (req, res) => { 
	...
})

The above will respond to a message with the example action

If you wish to register a default route, which will be called by order of precedence, they will receive the previous route response and can altar as it wishes.

app.use((req, res) => {
	...
})

Registry

The registry is a simple way to access data globally, across all routes.

  • Sapling.get(arg)
  • Sapling.set(arg, val)
  • Sapling.exists(arg)
  • Sapling.unset(arg)

Future Goals/Tasks

  • [ ] A proper routing system implementation
    • [ ] Be able to properly skip routes
    • [ ] Be able to have middlewares
  • [ ] Event system
    • [ ] Hook into the client join
    • [ ] Hook into client quit
    • [ ] Hook into client messages and errors
  • [ ] Cross client communication
    • [ ] Find specific clients to share data
    • [ ] Broadcast to all clients