@alokai/connect

@alokai/connect is the runtime backbone of an Alokai application: the middleware server that talks to your backends, the type-safe SDK your storefront calls it with, and the supporting config-switcher and logger modules.

This section is a showcase of the new API reference experience. Every type table on these pages is generated at build time from the package's own type declarations - property names, types, defaults, and descriptions come straight from the JSDoc in the source code.

Modules

What changed compared to the current reference

The current reference renders one page per exported symbol - for @alokai/connect alone that is 150+ sidebar entries of equal weight, where createServer sits next to internal helper types and finding the API you actually need means already knowing its name.

This showcase inverts that:

• Curated by task, not alphabet. Each module is one page organized around what you do with it - create a server, build an SDK module, handle errors. The important APIs are at the top; supporting types appear where they are used.
• JSDoc is the single source of truth. The tables are not hand-written copies that drift from the code. They are compiled from the shipped .d.ts files; when a property, default, or description changes in the source, the docs change on the next build - and the build fails if a documented type disappears.
• Progressive disclosure. A type table shows the shape at a glance; each row expands into the full type signature, default value, and description, so a page with five documented types stays readable.
• Examples live with the code. @example blocks in JSDoc are written by the package authors, reviewed in the same pull request as the code they describe, and surface here.

How it works