Package reference
Plandalf publishes two packages. Open one in the sidebar to browse its functions, classes, interfaces, type aliases, and referenced source types together. The reference is generated from each package's TypeScript entrypoint, so a type appears with the package that defines or uses it.
| Package | Use it for | Reference |
|---|---|---|
@plandalf/sdk | Programmatic JavaScript checkout, promos, identity, and gates | Browse SDK exports and types |
@plandalf/react | React provider, hooks, and components | Browse React exports and types |
Common SDK types
| Type | What it tells you |
|---|---|
FlowOpenOptions | Inputs accepted when an offer opens |
MountOptions | Inputs accepted by an inline mount |
FlowHandle<T> | Promise behavior, live events, and close() |
FlowResult | Checkout completion or dismissal result |
GateResult | Access decision from a gate |
Start at the SDK overview when you want to understand how these functions work together. Use the SDK examples to choose HTML, JavaScript, or React for a real task.