Diese API ist in erster Linie für Bibliotheksautoren gedacht. Derzeit wird nur Next.js-artiges Dateisystem-Routing unterstützt, aber andere Stile können in Zukunft hinzugefügt werden.

Next.js-Art

Die FileSystemRouter-Klasse kann Routen gegen ein pages-Verzeichnis auflösen. (Das Next.js 13 app-Verzeichnis wird noch nicht unterstützt.) Betrachten Sie das folgende pages-Verzeichnis:

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

Der FileSystemRouter kann verwendet werden, um Routen gegen dieses Verzeichnis aufzulösen:

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/pages/index.tsx"
}

Abfrageparameter werden geparst und in der query-Eigenschaft zurückgegeben.

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

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

Der Router parst automatisch URL-Parameter und gibt sie in der params-Eigenschaft zurück:

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/pages/blog/[slug].tsx",
  params: {
    slug: "my-cool-post"
  }
}

Die .match()-Methode akzeptiert auch Request- und Response-Objekte. Die url-Eigenschaft wird verwendet, um die Route aufzulösen.

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

Der Router liest den Verzeichnisinhalt bei der Initialisierung. Um die Dateien erneut zu scannen, verwenden Sie die .reload()-Methode.

router.reload();

Referenz

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
  }
}