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

agnostic-router-api-builder

v0.0.1

Published

API Builder for agnostic-router package

Downloads

3

Readme

API Builder for Agnostic Router

Generate a router for a given class, using a config

Or generate an object that will then pass arguments to its functions to a router (e.g.: Create an object of functions in the browser, to match the object available on the server)

TODOs

  • Generate config automatically from JSDoc

Methods

toObject

function(apiConfig, callback)

callback(functionName, urlPath, requestArguments, functionCallback);

toRouter

function(apiConfig, targetObject, [router])

Usage

// Shared config, on the server and client
var apiConfig = {
	"lookup": {
		"pattern": "/lookup",
		"arguments": [
			{"name": "title", "level": 0, "source": "query"},
			{"name": "author", "level": 1, "source": "query"}
		]
	}
};

// On the server
var apiObject = {
	lookup: function() {
		if(arguments.length == 3) { // title, author, callback
			if(arguments[0] == 'War and Peace' && arguments[1] == 'Leo Tolstoy')
				arguments[2](null, '0140447938');
			else
				arguments[2]('not_found', null);
		}
	}
};

// Generate a router
var router = ApiRouter.toRouter(apiConfig, apiObject);

// Call from the client, through a public-facing interface (e.g.: HTTP server)
router.route('request', '/lookup', {query: {title: 'War and Peace', author: 'Leo Tolstoy'}}, function(error, isbn) {
	if(error)
		throw new Error('Function returned error');
	if(isbn != '0140447938')
		throw new Error('Function returned wrong result');
	console.log('Found the right book');
});

// On the client
function routeCallback(functionName, apiPath, request, callback) {
	// Make a conenction to the public interface here
	// Call callback when done
}

var apiObject = ApiRouter.toObject(apiConfig, routeCallback);

apiObject.lookup('War and Peace', 'Leo Tolstoy', function(error, isbn) {
	if(error)
		throw new Error(error);
	console.log("The requested book has ISBN", isbn);
});