@breezehr/next-static-paths
v0.4.2
Published
Static types for routing in Next.js apps
Downloads
4
Readme
next-static-paths
Statically prevent HTTP 404 Not Found in your Next.js applications using TypeScript and code generation.
Usage
$ pnpm add next-static-paths
# or
$ yarn add next-static-paths
# or
$ npm install next-static-paths
Then, from within your Next.js application root, run the following command:
# For pnpm users
$ pnpx next-static-paths
# For yarn users
$ yarn next-static-paths
# For npm users
$ npx next-static-paths
It's recommended to configure scripts in your package.json
too
{
"dev": "next-static-paths --pages-dir ./src --output . && next dev",
"generate-routes": "next-static-paths --pages-dir ./src --output . && :"
}
TypedLink
component
import { TypedLink } from "@breezehr/next-static-paths";
function MyComponent() {
return (
<TypedLink as="/some/[myArgument]" myArgument="hello world">
Hello world
</TypedLink>
);
}
pathFor
helper
import { pathFor } from "@breezehr/next-static-paths";
function getPath() {
return pathFor("/some/[myArgument]", { myArgument: "hello world" });
}