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

vulpes-api

v0.5.0

Published

API generator for the Vulpes job management framework

Downloads

5

Readme

Vulpes-API

API generator for the Vulpes job management framework

Build Status

About

Vulpes is a NodeJS job management framework, designed to provide a solid base to build automation projects upon. This library provides an interface that exports an ExpressJS API (Router) that can be used to instantly provide an API endpoint for your job management platform.

Installation

Install by running npm install vulpes-api --save. Vulpes-API depends on vulpes as a peer dependency, so you must have that installed as well.

Usage

Usage is quite simple - assuming that you have an existing ExpressJS setup:

const express = require("express");
const { Service } = require("vulpes");
const { createVulpesAPIRouter } = require("vulpes-api");
const app = express();
const port = 3000;

// Create a new service
const service = new Service();

service.initialise().then(() => {
    app.get("/", (req, res) => {
        res.send("...");
    });

    app.use("/api", createVulpesAPIRouter(service));

    app.listen(port, () => {
        console.log(`Application listening on port ${port}`);
    });
});

The primary method createVulpesAPIRouter takes a Vulpes Service instance as the first paramter:

createVulpesAPIRouter(service, {
    cors: true,
    log: logInstance
});

The options parameter is optional, as are all of its subsequent properties. The log parameter expects an object or instance that provides methods like info, warn, error etc. (much like Bunyan). The exported value is basically an ExpressJS Router instance (actually from express-promise-router).