@calvinbonner/minifw API Reference

Version 0.2.1

`core/page`

`interface MiniPage`

interface MiniPage {
  cache?: MiniCacheOptions;
  head?: MiniPageHead;
  render(context: MiniContext): MaybePromise<string>;
  style(): MaybePromise<string>;
}

Represents a page that can be rendered and served. Pages receive server context and can optionally define MiniHead metadata.

`property cache`

MiniCacheOptions

`property head`

MiniPageHead

`method render`

render(context: MiniContext): MaybePromise<string>

`method style`

style(): MaybePromise<string>

`type-alias MiniPageHead`

type MiniPageHead = MiniHead | object;

Static or request-specific HTML <head> metadata for a MiniPage.

MiniHead | object

`function page`

page(render: PageRenderFunction, options?: PageOptions): MiniPage

Create a new MiniPage instance.

render: The render function for the page.
options: Page options, including optional MiniHead metadata.

Returns:

A new MiniPage instance.

page(render: PageRenderFunction, style: PageStyleFunction, options?: PageOptions): MiniPage

Create a new MiniPage instance.

render: The render function for the page.
options: Page options, including optional MiniHead metadata.

Returns:

A new MiniPage instance.

`function resolvePageHead`

resolvePageHead(head: MiniPageHead | undefined, context: MiniContext): Promise<MiniHead | undefined>

Resolve static or request-specific MiniPageHead metadata.