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

nextjs-route-types

v2.0.1

Published

Automatic type generation for Next.js app router routes

Downloads

253

Readme

nextjs-route-types

Automatic type generation for Next.js app router routes, ~~copied from~~ highly inspired by SvelteKit.

Version 2 only supports Next.js 15 and after. If you want to continue using Next.js 13 or 14, use version 1.1.1 of this library.

Installation

  1. Install the package from NPM:

    npm install nextjs-route-types # npm
    yarn add nextjs-route-types # yarn
    pnpm add nextjs-route-types # pnpm
    bun add nextjs-route-types # bun
  2. Use the Next.js plugin in your Next.js config file

    const { withNextJSRouteTypes } = require("nextjs-route-types");
    
    /** @type {import("next").NextConfig} */
    const nextConfig = {
      // your Next.js configurations
    };
    
    module.exports = withNextJSRouteTypes(nextConfig);
  3. Configure tsconfig.json: Add "rootDirs": [".", ".next-types"] to your compilerOptions. This step is necessary, we need this for TypeScript to know where to look when we import from ./$types.

  4. If you use Git you might want to add .next-types to .gitignore.

Usage

In any files inside the app directory (or src/app if you use it), you can import certain types from "./$types":

// app/[dynamic]/[nested]/page.tsx
import type { PageProps } from "./$types";

export default async function Page({ params }: PageProps) {
  console.log((await params).dynamic); // string
  return <div>Hello world</div>;
}
// app/[dynamic]/[...another]/route.ts
import type { RouteHandler } from "./$types";

export const GET: RouteHandler = async (request, { params }) => {
  console.log((await params).another); // string[];
  return new Response();
};

./$types exports the following types: SearchParams, Params, DefaultProps, ErrorProps, LayoutProps, LoadingProps, NotFoundProps, PageProps, TemplateProps, RouteHandlerContext and RouteHandler.

Note Editor IntelliSense might not work and you likely have to type that import statement manually. This is a known issue that I don't know how to fix – PRs welcome.

Credits

SvelteKit for the idea of using rootDirs for this.

nextjs-routes on which the Next.js plugin part of this code is based.