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

plugin

v0.3.3

Published

Plugin library

Downloads

54,498

Readme

Plugin.js

Features

  • ability to load entire directories
  • add remote plugins (dnode)

Example

bootstrap.js

var plugin = require("plugin"),
express = require("express"),

plugin(express()).
params({
	http: { port: 8080 }
}).
require(__dirname + "/config.js").
require(__dirname + "/someRoutes.js").
load();

config.js

exports.plugin = function(server, loader) {
	server.listen(loader.params("http.port") || 80);
}

someRoutes.js

module.exports = function(server) {
    server.get("/hello", function(req, res) {
        res.end("world!");
    })
}

Plugin API

loader .plugin(plugInto, ...)

Initializes the loader for local / remote plugins. plugInto is passed into the first parameter when calling .plugin() on each required module.

loader.use(extension)

Extends the loader. This allows you to customize how modules are loaded into your sandbox.

require("plugin")().
use(require("plugin-dnode")).
require("dnode://localhost").
load();

loader.params(keyOrParams, value)

Get / set params

bootstrap.js

require("plugin")().
params("some.message", 8080).
require(__dirname + "/hello.js").
load();

server.js

exports.plugin = function(loader) {
	console.log(loader.params("some.message"));
}

loader.require(source, ...)

path to the plugins

loader.
require(__dirname + "/plugin.js").
require(__dirname + "/someDirectory.js").
require("multiple", "plugins").
require("dnode://localhost").
load();

loader.load(callback)

loads the required dependencies

loader.module(search)

Returns one loaded module based on the search query. Note that calling this method may load the given module if it hasn't already. Here's a real-world example:

bootstrap.js

require("plugin")().
params("http.port", 8080).
require(__dirname + "/server.js").
require(__dirname + "/routes.js").
load();

server.js

exports.isHttpServer = true; //not needed - just used for searching
exports.plugin = function(loader) {
	var server = express();
	server.listen(loader.params("http.port"));
	return server;
}

routes.js

exports.plugin = function(loader) {
	var server = loader.module("server");
	server.get("/hello", function(req, res) {
		res.end("hello world!");
	})
}

Also note that you can search based on attributes. Here's routes.js again:

exports.plugin = function(loader) {
	var server = loader.module({ isHttpServer: true });
	//do stuff here
}

loader.modules(search)

Just like loader.module(search), but returns multiple modules.

loader.exports

This is all the plugins combined, and it's set once everything's loaded.