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

koa-body-parsers

v5.0.0

Published

collection of koa body parsers

Downloads

1,066

Readme

Koa Body Parsers

NPM version

A more functional version of body parsing. Use this module if you want to "lazily" parse the body. Other middleware automatically parse the body in the middleware chain, which might not be ideal as business logic like authentication, authorization, and routing are not done prior to body parsing.

Includes a json and urlencoded parsers.

API

Initialization:

import koaBodyParsers from 'koa-body-parsers'
import Koa from 'koa'

const app = new Koa()
koaBodyParsers(app)

// example usage
app.use(async (ctx) => {
  const currentUser = UserService.getCurrentUser(ctx)
  ctx.assert(currentUser, 401)

  ctx.assert(ctx.request.is('json'), 415)
  const body = await ctx.request.json('100kb')
  ctx.body = body
})

Because this module is a plugin for the context, the API signature is different.

Expect: 100-continue and ctx.response.writeContinue()

Expect: 100-continue is automatically supported as long as you use app.listen(). Otherwise, create your server like this:

const fn = app.callback();
const server = http.createServer(); // or whatever server you use
server.on('request', fn); // regular requests
server.on('checkContinue', function (req, res) {
  // tag requests with `Expect: 100-continue`
  req.checkContinue = true;
  fn(req, res);
});

If Expect: 100-continue was sent to the client, this will automatically response with a "100-continue". Use this right before parsing the body. Automatically called by all following body parsers, but you would still have to call it if you're doing something like:

app.use(async (ctx) => {
  if (ctx.request.is('image/*')) {
    ctx.response.writeContinue();
    const buffer = await ctx.request.buffer()
  }
})

const body = await ctx.request.json([limit])

Get the JSON body of the request, if any. limit defaults to 100kb.

const body = await ctx.request.urlencoded([limit])

Get the traditional form body of the request, if any, limit defaults to 100kb.

const text = await ctx.request.text([limit])

Get the body of the request as a single text string. limit defaults to 100kb. You could use this to create your own request body parser of some sort.

const buffer = await ctx.request.buffer([limit])

Get the body of the request as a single Buffer instance. limit defaults to 1mb.