Skip to content
CFast
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Guides
@cfast/actions
@cfast/admin
@cfast/auth
@cfast/core
db
@cfast/db
Seeding
Transactions vs Batch
@cfast/email
@cfast/env
@cfast/forms
@cfast/pagination
patterns
Pattern: Drag and Drop
@cfast/permissions
storage
@cfast/storage
Handling Large Files
@cfast/ui
Tutorial: Build a Team Blog
1. Project Setup
2. Database Setup
3. Authentication
4. Permissions
5. CRUD with Actions
6. Admin Panel
7. File Storage
8. Email Notifications
API Reference
actions
Classes
InvalidInputError
Type Aliases
ActionContext
ActionDefinition
ActionPermissionsMap
ActionPermissionStatus
ActionsConfig
ActionServices
ClientDescriptor
ComposedActions
DispatchArgs
ForwardRequestInit
InferInput
InputField
InputParser
InputSchema
OperationsFn
RequestArgs
Serializable
Variables
z
Functions
cfastJson
checkPermissionStatus
createActions
defineInput
forwardRequest
admin
Type Aliases
AdminActionResult
AdminAuthAdapterOptions
AdminAuthConfig
AdminColumnConfig
AdminConfig
AdminLoaderData
AdminTableMeta
AdminUser
CreateDbFn
DashboardConfig
DashboardStat
DashboardWidget
RecentItem
RowAction
RowActionCallback
RowActionContext
TableAction
TableOverrides
UserManagementConfig
Functions
createAdmin
createAdminAction
createAdminAuthAdapter
createAdminComponent
createAdminLoader
introspectSchema
auth
Type Aliases
AuthConfig
AuthContext
AuthenticatedContext
AuthEnvConfig
AuthHelpers
AuthHelpersOptions
AuthInstance
AuthRolesApi
AuthUser
RoleNameOf
Functions
createAdminAuth
createAuth
createAuthHelpers
createAuthRouteHandlers
createImpersonationManager
createRoleManager
core
Classes
CfastConfigError
CfastPluginError
Type Aliases
App
AppContext
CfastPlugin
CreateAppConfig
DefaultAuthProvides
DefaultDbProvides
DefaultPluginsConfig
PluginContext
PluginProvides
PluginSetupContext
RouteArgs
Functions
createApp
createDefaultPlugins
definePlugin
definePluginFor
db
Classes
TransactionError
Type Aliases
AppDbConfig
AppDbFactory
CacheBackend
CacheConfig
CrudAction
CursorPage
CursorParams
DateToString
Db
DbConfig
DeleteBuilder
DeleteReturningBuilder
FindFirstOptions
FindManyOptions
InferQueryResult
InferRow
InsertBuilder
InsertReturningBuilder
LookupCache
OffsetPage
OffsetParams
Operation
PaginateOptions
PaginateParams
QueryBuilder
QueryCacheOptions
TransactionResult
Tx
UpdateBuilder
UpdateReturningBuilder
UpdateWhereBuilder
WithCan
Functions
compose
composeSequential
composeSequentialCallback
createAppDb
createDb
createLookupCache
parseCursorParams
parseOffsetParams
runWithLookupCache
toJSON
email
Classes
EmailDeliveryError
Type Aliases
EmailClient
EmailClientConfig
EmailMessage
EmailProvider
SendOptions
Functions
createEmailClient
env
Classes
EnvError
Type Aliases
BindingDef
BindingType
BindingTypeMap
EnvironmentDefaults
EnvironmentName
EnvValidationError
ObjectBindingDef
ParsedEnv
Schema
SecretBindingDef
VarBindingDef
Functions
defineEnv
forms
Type Aliases
ChildTableComponentProps
ChildTableConfig
FieldComponentProps
FieldConfig
FieldDefinition
FormPlugin
FormPluginComponents
FormWrapperProps
InferAutoFormValues
InputType
NestedTableConfig
SubmitButtonProps
UploadFieldMetadata
ValidationRules
Functions
createAutoForm
createFormPlugin
createResolver
DefaultChildTable
getUploadMetadata
introspectTable
upload
v
pagination
Type Aliases
UseInfiniteScrollOptions
UseInfiniteScrollResult
UseOffsetPaginationResult
UsePaginationOptions
UsePaginationResult
Functions
useInfiniteScroll
useOffsetPagination
usePagination
permissions
Classes
ForbiddenError
PermissionRegistrationError
Interfaces
LookupDb
Type Aliases
ColumnsOf
CrudAction
DrizzleTable
Grant
GrantedAction
GrantFn
LookupFn
PermissionAction
PermissionCheckResult
PermissionDescriptor
Permissions
PermissionsConfig
SchemaMap
SqlNameOf
SubjectInput
TableName
UserWithRoles
WhereClause
WithLookups
Variables
CRUD_ACTIONS
Functions
can
checkPermissions
definePermissions
getGrantedActions
getTableName
grant
resolveGrants
resolveTablePermissions
storage
Classes
StorageError
Type Aliases
ClientFiletypeConfig
ClientStorageConfig
CreateStorageRouteHandlersOptions
FileInfo
FiletypeConfig
FiletypeHooks
HandleContext
InstanceSignedUrlOptions
KeyContext
MimeGroup
MimeGroupedFiletypeOptions
MimeGroupsRecord
NormalizedMimeGroup
OwnerCheck
ServeOptions
SignedUrlOptions
StorageErrorCode
StorageErrorOptions
StorageInstance
StorageRoutesOptions
StorageRouteUser
StorageSchema
UploadResult
UploadRouteResult
Variables
createStorageRoutes
Functions
createSignedUploadUrl
createStorageRouteHandlers
defineStorage
filetype
parseSize
storageRoutes
ui
Type Aliases
ActionButtonProps
AlertSlotProps
AppShellProps
AppShellSlotProps
AvatarWithInitialsProps
BaseFieldProps
BooleanFieldProps
BreadcrumbItem
BreadcrumbSlotProps
BulkAction
ButtonSlotProps
ChipSlotProps
ColumnDef
ColumnShorthand
ConfirmDialogSlotProps
ConfirmOptions
DataTableProps
DateFieldProps
DetailViewProps
DropZoneProps
DropZoneSlotProps
EmailFieldProps
EmptyStateProps
FileFieldProps
FileListFile
FileListProps
FilterBarProps
FilterDef
FilterOption
FilterType
FormStatusData
FormStatusProps
ImageFieldProps
ImagePreviewProps
ImpersonationBannerProps
JsonFieldProps
ListViewProps
NavigationItem
NavigationProgressProps
NumberFieldProps
PageContainerSlotProps
PermissionGateProps
RelationFieldProps
RoleBadgeProps
SidebarSlotProps
TabItem
TableCellSlotProps
TableRowSlotProps
TableSectionSlotProps
TableSlotProps
TextFieldProps
ToastApi
ToastOptions
ToastSlotProps
ToastType
TooltipSlotProps
UIPlugin
UIPluginComponents
UploadFieldFile
UploadFieldProps
UrlFieldProps
UserMenuLink
UserMenuProps
WhenForbidden
Variables
ConfirmContext
ToastContext
Functions
ActionButton
AppShell
AppShellHeader
AppShellSidebar
AvatarWithInitials
BooleanField
BulkActionBar
ConfirmProvider
createUIPlugin
DataTable
DateField
DetailView
DropZone
EmailField
EmptyState
fieldForColumn
fieldsForTable
FileField
FileList
FilterBar
FormStatus
getInitials
ImageField
ImagePreview
ImpersonationBanner
JsonField
ListView
NavigationProgress
NumberField
PageContainer
PermissionGate
RelationField
RoleBadge
TextField
UIPluginProvider
UploadField
UrlField
useActionStatus
useActionToast
useColumnInference
useComponent
useConfirm
UserMenu
useToast
useUIPlugin
GitHub
Select theme
Dark
Light
Auto
CacheBackend
CacheBackend
=
"cache-api"
|
"kv"
Defined in:
packages/db/src/types.ts:85