Reference
Every tagged public module in the four packages, generated from the JSDoc beside its source.
The reference documents every public export in packages/*/src that carries a
@primitive, @resource, @binding or @layer tag. One page is one source
module. The Source line at the top links to the file and line the text came
from.
The pages are generated. To change one, change the JSDoc in the package and run
pnpm docs:reference.
Packages
Paykit
The model, the catalog, the bindings, the database layers, and the manual provider.
Paykit Polar
Polar as a provider, and the products its tiers are sold as.
Paykit Stripe
Stripe as a provider, and the prices and meters its tiers are sold as.
Paykit Admin
The Foldkit console over the admin read contract.
What a page is
A metadata line names the kind of value a declaration exports.
- Binding is a
Binding.Servicefor one command or operation. It binds an account or a deployment, and returns the verb a caller sends. - Layer is an Effect
Layera deployment provides to close a service. - Resource is an Alchemy resource the deploy creates and reconciles with a vendor.
- Primitive is a plain exported function, type or service the other three are built from.
Each package page also lists its public entry points, so an import path in the
reference can be checked against package.json.
Package overview
Packages says what each of the four packages owns and which example deploys it.