xink

This deliciousness is still baking. Not even test-ready yet.

xink is a filesystem router, exclusively for the Bun HTTP server, designed for APIs. There are no plans for client-side use.

It's based on SvelteKit's implementation of filesystem routing. For example, an endpoint file needs to export a function for each HTTP method it will serve.

/* src/routes/endpoint.ts */

export const GET = async ({ url, params }) => {
  const article = await getArticle(params.slug)

  return new Response(`Here is the ${article.title} post!`)
}

export const POST = async ({ req, url }) => {
  return new Response(`This is the ${url.pathname} route, and you sent ${await req.json()}`)
}

Features like [...rest] parameters, [[optional]] parameters, and [param=matchers] are planned.

Origins

Pronounced "zinc", the name is based on the Gregorian word khinkali; which is a type of dumpling in the country of Georgia. The transcription is /ˈxink'ali/. To be clear: khinkali's beginning proununciation is dissimilar from "zinc".