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

koaw

v0.4.3

Published

Create APIs using Koa and Waterline

Downloads

15

Readme

Koaw Build Status

Create APIs using Koa and Waterline. Koaw creates auto-generated CRUD routes, using the co approach and the middleware design pattern.

Install

With npm do:

$ npm install koaw --save

Usage

const Koa = require('koa')
const Koaw = require('koaw')
const Waterline = require('waterline')
const Stores = require('./collections/stores')

// Set collections to ORM
let waterline = new Waterline()
waterline.loadCollection(Stores)

// Create server
let server = new Koa()

// Set new controller
let controller = new Koaw({
  orm: waterline,
  model: 'store'
})

controller
  // Set methods to be used
  .methods('get post put delete')
  // Add middlewares to extend logic using generators
  .before('post', function *(next) { /* some logic */ yield next })
  .after('post', function *(next) { /* some logic */ yield next })
  .before('post put', function *(next) { /* some logic */ yield next })
  .after('post put', function *(next) { /* some logic */ yield next })
  .after('put', function *(next) { /* some logic */ yield next })
  // Register controller
  .register(server)

waterline.initialize({}, function (err) {
  server.listen(4000)
})

The above code registers the following routes:

POST /stores
GET /stores
GET /stores/:id
PUT /stores/:id
DELETE /stores/:id

API

.methods(methods)

Change default methods with an array or whitelisted string. These are default methods: post put get delete.

.override(methods, handler)

Change default handler of auto-generated routes. The methods should be specified with an array or whitelisted string.

.route(methods, path, fn)

Add custom route to given model. The methods should be specified with an array or whitelisted string. For instance, .route('get', 'custom', fn) should generate this route: GET /[collection]/custom

.before(methods[, path], fn)

Add a before middleware to one or more methods, both custom routes and auto-generated routes. The methods should be specified with an array or whitelisted string.

.after(methods[, path], fn)

Add an after middleware to one or more methods, both custom routes and auto-generated routes. The methods should be specified with an array or whitelisted string.

.register(server)

Register controller routes to server. .register must be called at the end of above methods.

Contribute

Todos

  • Add support to queries, filters and populating
  • Add support to subcontrollers to create nested routes

License

MIT