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

fusion-plugin-http-router

v0.4.1

Published

Registers http routes and handlers on the server.

Downloads

30

Readme

fusion-plugin-http-router

Register and handle Http routes in a fusion app.


Table of contents


Installation

yarn add fusion-plugin-http-router

Setup

// src/main.js
import React from 'react';
import App from 'fusion-core';
import HttpRouter, {
  HttpRouterToken,
  HttpHandlersToken,
} from 'fusion-plugin-http-router';

// Define your http routes and methods server side
const handlers = __NODE__ && {
  '/api': {
    '/users': {
      POST: async () => {
        const user = createUser();
        return user;
      },
      ':id': {
        GET: async ({params: {id}}, ctx) => {
          return {some: 'data' + id};
        },
        PUT: async ({params: {id}, query, body}, ctx) => {
          updateUser(body);
          return {some: 'data' + id};
        },
        delete: async (args, ctx) => {
          // Error Handling Example
          try {
            deleteUser();
          } catch (e) {
            const error = new Error('Failed to delete user');
            error.code = 'DELETEUSER';
            error.meta = {
              custom: 'metadata',
            };
            throw error;
          }
        },
      }
    },

    '/book': {...}
  },
};

export default () => {
  const app = new App(<div />);

  if (__NODE__) {
    app.register(HttpRouterToken, HttpRouter);
    app.register(HttpHandlersToken, handlers);
  }

  return app;
};

API

Registration API

HttpRouter
import HttpRouter from 'fusion-plugin-http-router'

The HttpRouter plugin. Registers http routes and handlers.

HttpRouterToken
import { HttpRouterToken } from 'fusion-plugin-http-router'

The canonical token for the HttpRouter plugin. Typically, it should be registered with the HttpRouter plugin.

Dependencies

HttpHandlersToken
import { HttpHandlersToken } from 'fusion-plugin-http-router'

Configures what http Router handlers exist. Required. Server-only.

Types
type Args = {
  params: Object,
  query: Object,
  body: Object,
  files: Object
}

type HttpHandlers = {
  [string]: { [string]: (args: Args, ctx: Context) => any },
}

You can register a value of type HttpHandlers.

BodyParserOptionsToken
import { BodyParserOptionsToken } from 'fusion-plugin-http-router'

Configures the options for koa-body, internally used for parsing. Optional. Server-only.