@calvinbonner/minifw API Reference

Version 0.2.1

`core/shared`

interface MiniContext {
  isHtmx: boolean;
  params: Record<string, string>;
  request: BunRequest;
  route?: string;
  url: URL;
}

Server context passed to MiniPage, MiniPartial, and MiniLayout render functions.

Whether the request was made via HTMX (HX-Request header present).

boolean

Route parameters extracted from the matched path pattern.

Record<string, string>

The raw incoming Bun.BunRequest, including Bun-specific metadata.

BunRequest

The matched route path used for route-specific rendering behavior.

string

The parsed request URL.

URL

interface MiniHead {
  canonical?: string;
  description?: string;
  robots?: string;
  title?: string;
}

HTML <head> metadata for a MiniPage. All fields are optional and only rendered when provided.

Canonical URL rendered in <link rel="canonical">.

string

Meta description rendered in <meta name="description">.

string

Robots directive rendered in <meta name="robots">.

string

Page title rendered in <title>.

string

type MiniCacheOptions = boolean | { ttl: number };

Cache behavior for render primitives.

boolean | { ttl: number }