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

swork-router

v1.3.3

Published

Router using the swork framework.

Downloads

26

Readme

swork-router

npm travis ci coverage download Greenkeeper badge

swork-router is router middleware for swork powered by path-to-regexp. It is built with TypeScript and async methods.

License

MIT

Installation

npm install swork-router

yarn add swork-router

Example

import { Swork, FetchContext } from "swork";
import { Router } from "swork-router";

const app = new Swork();
const router = new Router();

router.get("/hello/:id", (context: FetchContext) => {
    context.response = new Response(`world id: ${context.params.id}`);
});

app.use(router.routes());

app.listen();

Methods

get | post | put | patch | delete | head | options | all

Create a route using the HTTP verb as your method name such as router.get(...) or router.post(...). In addition, all is available to match on all HTTP verbs.

router.get("/foos", async (context: FetchContext, next: () => Promise<void>) => {
    // manipulate request
    const response = await next();
    // manipulate or cache response
    context.response = response;
});

You are able to pass in a single path or an array of paths with the middleware to be invoked when a path is matched.

router.get(["/foos", "/foos/:id"], (context) => {...});

Every verb method returns the router instance allowing chaining of path handlers.

router
    .get("/foos", (context) => {...})
    .post("/foos", (context) => {...})
    .all("/foos/:id", (context) => {...});

Route paths must start with a slash and end without one. Paths are translated to regular expressions using path-to-regexp. As a result, query strings are not evaluated when matching requests.

use

use allows the nesting of routers. This is useful when building a routes in a separate module.

const router = new Router({ prefix: "/api" });

router.use(getFooApiRouter());
router.use(getBarApiRouter());

app.use(router.routes());

Configuration

Prefix

Routes can be prefixed at the router level.

const router = new Router({
    prefix: "/foos"
});

router.get("/", ...); // responds to "/foos"
router.put("/:id", ...); // responds to "/foos/:id"

Origin

Alternate origins can be used but default to configuration.origin from swork.

const router = new Router({
    origin: "https://www.hello.com"
});

router.get("/world", () => { ... });

Url Parameters

Named route parameters are captured and added to context.params property.

router.put("/:id/:name", (context: FetchContext) => {
    console.log(context.params);
    // => { id: 99, name: "Jane" }
});

Contact

If you are using swork or any of its related middlewares, please let me know on gitter. I am always looking for feedback or additional middleware ideas.