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 🙏

© 2025 – Pkg Stats / Ryan Hefner

next-router-config

v0.0.9

Published

path-to-regexp based custom next routes

Downloads

8

Readme

Next router config

npm

Path-to-regexp based custom routers for a Next.js apps.

Install

// yarn
yarn add next-router-config

// npm
npm i --save next-router-config

Base example

Create Routes

  1. Create routes config
// src/routes/config.ts
import { RoutesConfig } from 'next-router-config';

export enum RoutesNames {
    Home = 'home',
    Entity = 'entity',
}

export const routesConfig: RoutesConfig = [
    {
        name: RoutesNames.Home,
        page: '/home',
        pattern: '/',
    },
    {
        name: RoutesNames.Entity,
        page: '/entity',
        pattern: '/entity/:id(\\d+)',
    },
];

RouteConfig params:

  • name - route name
  • page - the path of the page in /pages
  • pattern - path-to-regexp pattern
  1. Create custom routes instance
// src/routes/index.ts
import { createRoutes } from 'next-router-config';
import { routesConfig } from './config';

export const { routes, useCustomRouteLink, useCustomRouter } = createRoutes({
    config: routesConfig,
});

On the server

// src/server/index.ts
import { createServer } from 'http';
import { parse } from 'url';

import next from 'next';
import { createServerRequestHandler } from 'next-router-config';

import { routes } from 'src/routes';

const dev = process.env.NODE_ENV !== 'production';
const app = next({ dev });

const serverRequestHandler = createServerRequestHandler({
    app,
    routes,
});

app.prepare().then(() => {
    createServer(serverRequestHandler).listen(3000, (err) => {
        if (err) throw err;
        console.log('> Ready on http://localhost:3000');
    });
});

On the client

import React, { useMemo } from 'react';
import Link from 'next/link';

import { RoutesNames, useCustomRouteLink, useCustomRouter } from 'src/routes';

const EntityPageMenuItem = ({ entityId }) => {
    const routeParams = useMemo(
        () => ({
            id: entityId,
        }),
        [entityId]
    );

    const link = useCustomRouteLink({
        routeParams,
        routeName: RoutesNames.Entity,
    });

    if (!link) {
        return null;
    }

    return (
        <Link href={link.url} as={link.as}>
            <a href={link.as}>Entity {entityId}</a>
        </Link>
    );
};

const HomePage = () => {
    const router = useCustomRouter();

    return <div>Home page</div>;
};

API reference

Routes

  • matchUrl(url: string) => RouteMatch | undefined

    • RouteMatch
      • params - parsed params from url
      • page - path of the page in /pages
      • name - route name
      • pattern - path-to-regexp pattern
  • getRoute({ routeName, routeParams }) => RouteLink | undefined

    • RouteLink
      • pathname - uri
      • page - path of the page in /pages
      • params - route params

Inspired by

next-routes