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

expi

v2.0.19

Published

Modular API framework built with express

Downloads

26

Readme

Expi Logo

expi

Modular, Minimalistic API Framework built with express.

Installation

Install expi using

$ npm install --save expi

Example

A working example can be found in the modules root folder.

$ node node_modules/expi/example/app.js

or

$ cd node_modules/expi && npm run example

TODO

  • Documentation for:
    • Module
    • Method
    • Route
    • Expi
  • Linting
  • Testing
  • Add new features
    • Dedicated session/authentication hook
    • Custom response schema
    • Extended response functionality
    • Clusterization
    • Extended versioning (Provide versioned modules under special routes for backward compatablility)
    • New layer ontop of route parameters
  • Expose all express functions without interfering with expi functionality
  • Proper releases
  • Build tasks
  • Handling preRoutes middleware while still returning 404 on module path without a route specified
  • Handle default errors, http codes, bad requests etc.

Documentation

A small overview over the functionality expi provides

Expi.Module(options)

Usage:

    let Module = require('expi').Module
    let module = new Module(options)

Configuration:

  • options
    • name: The name of the Module, this gets displayed as response.meta.name
    • version: The version of the Module, this gets displayed as response.meta.version
    • path: The base path of the module. This path is relative to the root path of the server.
    • ?middleware
      • preRoutes: Array of functions, these functions are plugged in as middleware before any routes and even before the internal expi-middleware
      • postRoutes: Array of functions, these functions are pluggin in as middleware after all routes and even after the internal expi-middleware (Caution: if expi-middleware is active, a response might be sent already!)
    • routes: Array of expi.Route instances
    • ?methods: Array of expi.Method instances

More documentation coming soon, for details take a look at the example in expi_root/example

(This module is in an early state, use with caution)