API Reference
Every function, class, and type the Brick packages export, generated from the JSDoc in their source.
Every function, class, interface, and type that the Brick packages export, with its signature, parameters, return value, and examples, so you do not have to read the source to find out what one does. The pages are generated from the JSDoc in the source, so they are always as current as the code.
| Import | What it is | Exports |
|---|---|---|
@brickkit/core | Services, actions, tools, resources, databases, secrets, the HTTP runtime, and the typed contract of a Brick application. | 213 |
@brickkit/core/client | The typed HTTP client a frontend uses to call a Brick application, inferred from its contract. | 14 |
@brickkit/core/tanstack-query | TanStack Query options and keys for the typed client's actions. | 3 |
@brickkit/core/pg | Postgres databases for Brick services, with Drizzle's table builders. | 33 |
@brickkit/cli | The brick command's building blocks: the dev and production servers, contract generation, and the OpenAPI pages. | 6 |
@brickkit/cli/compiler | Compile and bind a Brick application's routes ahead of time. | 1 |
@brickkit/cli/vite | The Vite plugin that generates the typed client contract and serves the dashboard. | 2 |
@brickkit/cli/dev-reporter | Report a worker process's requests to a running dev dashboard. | 2 |
@brickkit/crud | CRUD actions for a resource, with access rules, filters, and hooks. | 17 |
Each page lists its functions first, with a line about each, then classes, interfaces, and types. Search finds any name. Names are re-exported from where they are defined, so a type may appear on more than one page.
Improve a description
The text on these pages is the JSDoc above each export in packages/*/src. To fix or add one, edit the comment there: the first paragraph is the summary, @param name - text describes a parameter, @returns the result, @example adds a code sample, @throws and @deprecated are shown as written, and @internal leaves an export out of this reference.