API reference
Find the public entry point, method, option or exact type you need.
Start with the readable references, then use the generated declarations for exact signatures.
Every published exports entry is included in the package reference below. Supporting declarations
are grouped by module; a symbol in a supporting module is not automatically a public import path.
| Reference | What it covers |
|---|---|
| Promise client | Client methods, lifecycle and call options |
| Effect service | Layers, requirements, success and error channels |
| File and manifest helpers | Input variants, stream contracts and validation |
| Provider options | Credentials, defaults, throttling and capabilities |
| Result types | Deployment, activation, progress and reconciliation |
Exact declarations by package
These pages are generated from the same .d.ts files installed by consumers. The docs check
fails when source declarations or embedded example files change without updating their pages.
| Package | Exact reference |
|---|---|
@deploykit/core | Core and all core subpaths |
@deploykit/node | Promise helpers and both clients |
@deploykit/vercel | Vercel adapter and control plane |
@deploykit/cloudflare | Pages adapter and control plane |
@deploykit/devtools | Dashboard and event collector |
@deploykit/test | Test provider and in-memory app store |
Type signatures describe required services and errors. Guides explain when to call them, what to persist, and how to recover. Nothing in the generated reference grants capabilities a provider or account plan does not support.
Last updated on