Bun provides a fast API for resolving routes against file-system paths. This API is primarily intended for library authors. At the moment only Next.js-style file-system routing is supported, but other styles may be added in the future. ## Next.js-style The `FileSystemRouter` class can resolve routes against a `pages` directory. (The Next.js 13 `app` directory is not yet supported.) Consider the following `pages` directory: ```txt pages ├── index.tsx ├── settings.tsx ├── blog │   ├── [slug].tsx │   └── index.tsx └── [[...catchall]].tsx ``` The `FileSystemRouter` can be used to resolve routes against this directory: ```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/pages/index.tsx" } ``` Query parameters will be parsed and returned in the `query` property. ```ts 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" } } ``` The router will automatically parse URL parameters and return them in the `params` property: ```ts 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" } } ``` The `.match()` method also accepts `Request` and `Response` objects. The `url` property will be used to resolve the route. ```ts router.match(new Request("https://example.com/blog/my-cool-post")); ``` The router will read the directory contents on initialization. To re-scan the files, use the `.reload()` method. ```ts router.reload(); ``` ## Reference ```ts 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; query?: Record; } | null } } ``` lue='dave/nodemodule-preloadmodules'>dave/nodemodule-preloadmodules Unnamed repository; edit this file 'description' to name the repository.
aboutsummaryrefslogtreecommitdiff
path: root/integration/bunjs-only-snippets/sql-raw.test.js (unfollow)
AgeCommit message (Expand)AuthorFilesLines
2022-05-16Update README.mdGravatar Jarred Sumner 1-34/+34
2022-05-16Update README.mdGravatar Jarred Sumner 1-27/+90
2022-05-16Update README.mdGravatar Jarred Sumner 1-3/+3
2022-05-16Update README.mdGravatar Jarred Sumner 1-19/+17
2022-05-16Update README.mdGravatar Jarred Sumner 1-1/+1
2022-05-16`bun:sqlite` (#167)Gravatar Jarred Sumner 52-136/+258362
2022-05-16Add go and esbuild to build instructions (#169)Gravatar Divy Srivastava 2-1/+2
2022-05-12wrangler 2 released (#166)Gravatar Hugo Romano 1-1/+1
2022-05-11Update README.mdGravatar Jarred Sumner 1-1/+1
2022-05-11Update README.mdGravatar Jarred Sumner 1-2/+3
2022-05-11Add section about napiGravatar Jarred Sumner 1-0/+37
2022-05-11Update README.mdbun-v0.0.82Gravatar Jarred Sumner 1-2/+6
2022-05-11Update build-idGravatar Jarred Sumner 1-1/+1
2022-05-11Fix several bugs in napiGravatar Jarred Sumner 3-22/+54
2022-05-11Make the napi mjs file runnable in both bun & nodeGravatar Jarred Sumner 1-7/+6
2022-05-11Update build-idbun-v0.0.81Gravatar Jarred Sumner 1-1/+1
2022-05-11disable the new target allowed errorGravatar Jarred Sumner 1-4/+5
2022-05-11Update Makefilebun-v0.0.80Gravatar Jarred Sumner 1-0/+1
2022-05-11Update MakefileGravatar Jarred Sumner 1-1/+1
2022-05-11Fix export symbols on LinuxGravatar Jarred Sumner 4-25/+153
2022-05-11Add test for import.meta.requireGravatar Jarred Sumner 2-1/+11
2022-05-11[napi] Add a couple more symbolsGravatar Jarred Sumner 1-0/+2
2022-05-11[napi] Fix panic inside napi_fatal_errorGravatar Jarred Sumner 1-11/+18
2022-05-11[napi] Stub a couple moreGravatar Jarred Sumner 3-6/+52
2022-05-11[bun.js] eagerly convert to import.meta.requireGravatar Jarred Sumner 2-3/+24
2022-05-11[json] Fix bug with negative integers in json parserGravatar Jarred Sumner 1-3/+6
2022-05-11[bun.js] Implement a polyfill for the `detect-libc` npm packageGravatar Jarred Sumner 2-0/+53
2022-05-11[bun.js] Implement `import.meta.require`Gravatar Jarred Sumner 13-158/+539
2022-05-11[bun.js] Implement `import.meta.resolveSync`Gravatar Jarred Sumner 3-1/+78
2022-05-10Include napi in plus100Gravatar Jarred Sumner 1-4/+20
2022-05-10Add test for Buffer.byteLengthGravatar Jarred Sumner 1-0/+7
2022-05-10[napi] Error on import .nodeGravatar Jarred Sumner 1-29/+1
2022-05-10Update napi.cppGravatar Jarred Sumner 1-1/+0
2022-05-10[napi] Fix string bugGravatar Jarred Sumner 4-58/+125
2022-05-10[napi] transpile require(*.node) into process.dlopenGravatar Jarred Sumner 4-3/+30
2022-05-10[bun.js] Implement `Buffer.byteLength`Gravatar Jarred Sumner 7-47/+443
2022-05-09Fix extra quote in bundled require errorsGravatar Jarred Sumner 1-2/+2
2022-05-09few more napi functionsGravatar Jarred Sumner 2-1/+30
2022-05-09Update MakefileGravatar Jarred Sumner 1-3/+3
2022-05-09Update Dockerfile.baseGravatar Jarred Sumner 1-1/+1
2022-05-09[napi] getters & setters workGravatar Jarred Sumner 1-26/+39