文件系统路由器 · 文档

此 API 主要面向库作者。它仅支持 Next.js 风格的文件系统路由。

Next.js 风格

FileSystemRouter 类根据 pages 目录解析路由。（不支持 Next.js 13 的 app 目录。）请考虑以下 pages 目录：

Text

pages
├── index.tsx
├── settings.tsx
├── blog
│   ├── [slug].tsx
│   └── index.tsx
└── [[...catchall]].tsx

要根据此目录解析路由：

router.ts

const router = new Bun.FileSystemRouter({
  style: "nextjs",
  dir: "./pages",
  origin: "https://mydomain.com",
  assetPrefix: "_next/static/"
});

router.match("/");

// =>
{
  filePath: "/path/to/pages/index.tsx",
  kind: "exact",
  name: "/",
  pathname: "/",
  src: "https://mydomain.com/_next/static/index.tsx"
}

路由器会解析查询参数，并将其返回在 query 属性中。

TypeScript

router.match("/settings?foo=bar");

// =>
{
  filePath: "/Users/colinmcd94/Documents/bun/fun/pages/settings.tsx",
  kind: "exact",
  name: "/settings",
  pathname: "/settings?foo=bar",
  src: "https://mydomain.com/_next/static/settings.tsx",
  query: {
    foo: "bar"
  }
}

路由器会解析 URL 参数，并将其返回在 params 属性中：

TypeScript

router.match("/blog/my-cool-post");

// =>
{
  filePath: "/Users/colinmcd94/Documents/bun/fun/pages/blog/[slug].tsx",
  kind: "dynamic",
  name: "/blog/[slug]",
  pathname: "/blog/my-cool-post",
  src: "https://mydomain.com/_next/static/blog/[slug].tsx",
  params: {
    slug: "my-cool-post"
  }
}

.match() 方法也接受 Request 和 Response 对象；路由器会使用它们的 url 属性来解析路由。

TypeScript

router.match(new Request("https://example.com/blog/my-cool-post"));

路由器会在初始化时读取目录内容。要重新扫描文件，请使用 .reload() 方法。

TypeScript

router.reload();

参考

TypeScript

interface Bun {
  class FileSystemRouter {
    constructor(params: {
      dir: string;
      style: "nextjs";
      origin?: string;
      assetPrefix?: string;
      fileExtensions?: string[];
    });

    reload(): void;

    match(path: string | Request | Response): {
      filePath: string;
      kind: "exact" | "catch-all" | "optional-catch-all" | "dynamic";
      name: string;
      pathname: string;
      src: string;
      params?: Record<string, string>;
      query?: Record<string, string>;
    } | null
  }
}