API Reference
Autogenerated API reference for BTST
Backend (@btst/stack/api)
stack
Prop
Type
BackendPlugin
Prop
Type
BackendLibConfig
Prop
Type
BackendLib
Prop
Type
toNodeHandler
Re-exported from better-call/node. Converts a BTST handler to a Node.js compatible request handler.
Client (@btst/stack/client)
createStackClient
Prop
Type
ClientPlugin
Prop
Type
ClientLib
Prop
Type
ClientLibConfig
Prop
Type
SitemapEntry
Prop
Type
Sitemap
An array of SitemapEntry objects.
type Sitemap = Array<SitemapEntry>;sitemapEntryToXmlString
Prop
Type
metaElementsToObject
Prop
Type
normalizePath
Prop
Type
Client Components (@btst/stack/client/components)
RouteWithComponents
Prop
Type
RouteRenderer
Prop
Type
ComposedRoute
Prop
Type
FallbackProps
Prop
Type
ErrorBoundary
Prop
Type
Context (@btst/stack/context)
StackProvider
Prop
Type
useStack
Prop
Type
usePluginOverrides
Prop
Type
useBasePath
Prop
Type
useNotify
Prop
Type
Notifications are configured via the notify prop on StackProvider. Without an override, useNotify() routes to sonner toasts.
useTranslate
Prop
Type
Without an i18n provider, useTranslate() returns the English default with {{param}} interpolation.
useListState
URL-synced list state (filters, tabs, pagination) via the router's getSearchParams / setSearchParams contract. Export path: @btst/stack/client.
For SSR loaders, read initial state with parseListStateFromSearchParams(namespace, schema, requestSearchParams).
Prop
Type