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

next-api-composer

v1.1.1

Published

A helper utility for composing Next.js API routes with per-method implementations

Downloads

2,428

Readme

Next API Composer

Your implementations of API Routes for your Next.js applications will be much easier with this library.

You have to code the API Routes like:

// api/example.ts
export default async (req, res) => {
  if (req.method === 'GET') {
    // do something
    res.json({ foo: 'bar' });
    return;
  }

  res.setHeader('Allow', 'GET');
  if (req.method === 'OPTIONS') {
    res.status(204).send(null);
  } else {
    res.status(405).send(null);
  }
};

With this library:

// api/example.ts
export default nextApi({
  GET: async (req, res) => {
    // do something
    res.json({ foo: 'bar' });
  },
});

Installation

  • npm i next-api-composer

Supported Methods

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

HTTP Error Handling

  • This library includes various HTTP Error types such as HTTP400BadRequest, which extends RouteError.
  • RouteError has a method send(res: Sendable).
  • If any errors extending RouteError is thrown in the handler, they'll be handled with calling the send method of the error.
  • If any errors other than RouteError is thrown in the handler, the handler will emit HTTP 500 error.
  • For details, see src/index.ts.
// api/example.ts
export default nextApi({
  GET: async (req, res) => {
    // Given, the function authenticate will return false
    // if the request does not have a valid token in its HTTP header.
    if (!authenticate(req)) {
      throw new HTTP401Unauthorized();
    }

    // do something
    res.json({ foo: 'bar' });
  },
});