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

restify-loader

v2.1.6

Published

Load in Restify and Setup basic settings. ( Remove the restify Boilerplate ).

Downloads

36

Readme

Build Status

RESTify Loader

Load in Restify and Setup basic functionality ( Remove the restify Boilerplate ).

Installation

npm install restify-loader

Usage


// REST API Server:
let server = require('restify-loader')({
	dir: __dirname,
	name: 'fresca',
	version: '1.0.0',
	dirs: {
		libs: 'libraries',
		middleware: 'middleware',
		schemas: 'schemas'
	}
}, {
	someData: 'foo'
})

// Add custom stuff to root Server object
// server.use( passport )

// Listen for connections:
server.listen( process.env.PORT || 8080, () => {
	console.log( `Listening to port: ${PORT}` )
})

Parameters

restifyLoader( options, routeParams ) returns server instance.

Note that it will always recursively load in all files in the routes directory. Do not put routes in the 'dirs' object.

  • options ( Object ) [ required ]

    • dir ( String ) [ required ] - Directory from which we execute from. Almost always pass in __dirname in your main application.
    • name ( String ) [ required ] - Default: 'rest-api' - This will be in your HTTP responses. Also this is what all debug messages will be logged under.Eg: If your app name is fresca you will enable debugging via: DEBUG=fresca* npm start.
    • version ( String ) [ required ] - Default: '1.0.0' - This will be returned in your HTTP responses. This is useful for versioning APIs.
    • dirs ( Object ) [ optional ] - This is a key value set of directories we should recursively require in and attach to every Route instance. In the above example libraries, middleware, and schemas are all directories with multiple js files. Every js file will be required in and stored as the filename. If in libraries directory you had a file named helpers.js it would be accessible in all Routes as this.libs.helpers.
    • raven ( Object ) [ optional ]
      • DSN ( String ) [ required ] - DSN string used to report back to Sentry.
      • context ( Object ) [ optional ] - Additional context to add to Sentry messages.
  • routeParams ( Object ) [ optional ] - This is arbitrary data you want passed to each route instance. Useful for passing DB connections, etc. to routes.

  • Returns :: Server ( Object ) - Instance of Restify libraries server object. Very similar to Express' server / app instance. You can attach additional things to the server object before listening. Passport or other Auth for instance.

License

MIT License