Skip to content

Main Navigation Quickstart

Build your backend

PocketBase migrations

Deploy an application

Self-host PBVex

Go to production

Appearance

Sidebar Navigation

Start here

PBVex documentation

Quickstart

Backend primitives

How PBVex works

Guides

Build your backend

Schema and database

Querying data and designing indexes

Relationships and joins

Data types and validation

Organize a PBVex project

Backend functions

HTTP actions

Outbound HTTP requests

Components

Platform capabilities

Authentication

Migrations

Authorization

Application email templates

File storage

Image uploads and resizing

Scheduling one-shot work

Cron jobs

Environment variables and secrets

Use cases

Messaging app tutorial

Build an instant-messaging app

Messaging data model

Authentication and profiles

Contacts

Conversations and permissions

Messages and realtime

Message attachments

FakePayment tutorial

Build a fake payment flow

Payment data model

Generate checkout

Process payment webhooks

Entitlements and production

Client SDK

Client guides

Install the client SDK

Configure the client

Queries, mutations, and actions

Realtime subscriptions

Errors and troubleshooting

Frameworks

React

Hooks

React guides

Patterns

Provider

Testing React hooks

Svelte

Client and query lifecycle

Public functions

Svelte guides

Testing rune queries

Deploy & operate

Deployment

Self-hosting PBVex

Going to production

Testing

Limits and boundaries

Examples

Client

Authenticated call example

File upload flow

Client examples

Realtime list example

Vanilla TypeScript example

React

React app slice

React examples

Svelte

Svelte app slice

Svelte examples

Project

PBVex Agent Skills

Releasing PBVex

Architecture decision records

ADR 001: PBVex Deployment Protocol v1

ADR 002: PBVex Schema Migration Modes

API Reference

Overview

TypeScript

Overview

@pbvex/client

Classes

AuthApiError

AuthClient

AuthCollection

AuthStore

Client

FetchRealtimeTransport

LocalAuthStore

PBVexClient

PBVexError

Interfaces

AuthMethodsList

AuthProviderInfo

AuthRequestOptions

AuthResponse

AuthStorage

CallOptions

ClientOptions

FetchRealtimeTransportOptions

LocalAuthStoreOptions

OAuth2Options

OtpResponse

PocketBaseErrorBody

QueryResult

RealtimeTransport

WatchCallbacks

WatchOptions

Type Aliases

ArgsOf

AuthChangeListener

AuthProvider

AuthRecord

AuthRequest

ConnectionState

EmptyObject

FunctionReference

IsAny

IsOptionalArgs

OptionalArgs

PbvexValue

ReturnOf

StorageFileMetadata

StorageId

StorageImageMetadata

StorageUploadResponse

Unsubscribe

pbvex

component

Interfaces

AppDefinition

ComponentDefinitionWithKind

ComponentModule

ComponentMountDefinition

ComponentOptions

TypedComponent

TypedMount

Type Aliases

ComponentArgValidator

EnvEntry

ResolveEnv

Variables

APP_KIND

COMPONENT_KIND

Functions

buildComponentGraph

defineApp

defineComponent

isAppDefinition

isComponentDefinition

mount

index

Interfaces

IndexDefinition

SchemaDefinition

TableDefinition

Type Aliases

FunctionArgs

FunctionReference

FunctionReturnType

FunctionRoute

FunctionType

FunctionVisibility

OptionalRestArgs

SchemaTableDefinition

StorageFileMetadata

StorageId

StorageImageMetadata

StorageUploadResponse

Functions

defineSchema

defineTable

index

isSchemaDefinition

isTableDefinition

server

Classes

ApplicationError

CronJobs

Expression

IndexRange

Interfaces

ActionCtx

ActionDef

AuthContext

CronJobDefinition

CronJobsDefinition

DatabaseReader

DatabaseWriter

EmailContext

EmailSendOptions

FilterBuilder

FunctionContext

FunctionDefinition

FunctionOptions

GenericDocument

Headers

HttpActionCtx

HttpActionDef

HttpContext

HttpSendOptions

HttpSendResponse

IndexInfo

IndexRangeBuilder

LowerBoundIndexRangeBuilder

MigrationContext

MigrationDefinition

MigrationOptions

MutationCtx

MutationDef

OrderedQuery

PaginationOptions

PaginationResult

Query

QueryCtx

QueryDef

QueryInitializer

Request

Response

SchedulerContext

StorageContext

StorageGetUrlOptions

StorageImageUploadOptions

StorageReader

TableInfo

TextDecoder

TextEncoder

UpperBoundIndexRangeBuilder

URL

URLSearchParams

UserIdentity

Type Aliases

ApplicationErrorCategory

ArgDefinition

BodyInit

DocumentByName

EmailTemplateVariables

ExpressionOrValue

FieldPaths

FieldTypeFromFieldPath

GenericDataModel

HeadersInit

HttpAction

Id

IndexNamesForTable

InsertByName

JobId

JobID

NamedIndex

NamedTableInfo

NumericValue

PatchValue

RequestInit

ResponseInit

ReturnDefinition

SchedulableFunctionReference

TableNamesInDataModel

Value

Visibility

WithoutSystemFields

Variables

DAY_MS

Headers

HOUR_MS

MINUTE_MS

Request

Response

SECOND_MS

TextDecoder

TextEncoder

URL

URLSearchParams

WEEK_MS

Functions

action

cronJobs

defineComponentFns

defineMigration

httpAction

internalAction

internalMutation

internalQuery

isCronJobsDefinition

isFunctionDefinition

isMigrationDefinition

mutation

normalizeArgs

normalizeReturns

paginationResultValidator

query

values

Classes

ValidationError

Interfaces

ImageValidatorOptions

Type Aliases

GenericId

ObjectValidator

ObjectValidatorFor

Validator

ValidatorKind

Variables

v

Functions

any

array

bigint

boolean

bytes

defaulted

delayed

float64

id

image

int64

isValidator

literal

nullType

number

object

optional

record

recursive

string

union

@pbvex/protocol

Interfaces

OpaqueIdEnvelope

ParsedContentType

Type Aliases

ArgsAndOptions

ComponentDefinition

ComponentGraph

ComponentMount

CronJobDescriptor

Deployment

DeploymentActivateRequest

DeploymentActivateResponse

DeploymentBundle

DeploymentConfig

DeploymentListResponse

DeploymentManifest

DeploymentProtocolVersion

DeploymentRollbackResponse

DeploymentUploadRequest

DeploymentUploadResponse

EmailTemplate

EmailTemplateManifest

EmptyObject

EnvArgDescriptor

ErrorCode

FunctionArgs

FunctionDescriptor

FunctionReference

FunctionReturnType

FunctionRoute

FunctionType

FunctionVisibility

HttpEnvelope

HttpMethod

HttpResponse

Id

IndexDescriptor

JSONObject

JSONValue

MigrationDescriptor

MigrationWarning

ModuleSource

OptionalRestArgs

PbvexValue

RealtimeEnvelope

RealtimeOp

SchemaDescriptor

SseEnvelope

StorageFileMetadata

StorageId

StorageImageMetadata

StorageUploadResponse

StructuredError

TableDescriptor

ValidatorDescriptor

Variables

DEFAULT_CONFIG

ERROR_CODES

MAX_ACTIVATION_WARNINGS

MAX_ARRAY_SIZE

MAX_BUDGET_BYTES

MAX_BUDGET_NODES

MAX_DEPLOYMENT_UPLOAD_BYTES

MAX_FIELD_LENGTH

MAX_FUNCTION_ARGS_BYTES

MAX_FUNCTION_ARGS_LIMIT

MAX_IDENTIFIER_LENGTH

MAX_MAP_SIZE

MAX_PATH_LENGTH

MAX_REALTIME_ARGS_BYTES

MAX_REALTIME_BODY_BYTES

MAX_REQUEST_TIMEOUT_MS

MAX_RESPONSE_BODY_BYTES

MAX_RETURN_VALUE_BYTES

MAX_RETURN_VALUE_LIMIT

MAX_SSE_EVENT_DATA_LENGTH

MAX_SSE_LINE_LENGTH

MAX_UNION_BRANCHES

MAX_UPLOAD_BYTES

MAX_VALUE_DEPTH

SHA256_HEX_LENGTH

Functions

authenticateComponentIds

authenticateComponentIdsSync

canonicalHash

canonicalHashSync

canonicalJson

computeComponentId

decodeId

decodeValue

encodeId

encodeReturnValue

encodeValue

errorToJson

formatOpaqueId

hashSha256

hashSha256Bytes

hashSha256Sync

hasOnlyKeys

id

isBase64String

isComponentId

isComponentRelativeModulePath

isCronExpression

isErrorCode

isExportName

isFunctionType

isFunctionVisibility

isHttpEnvelope

isHttpMethod

isHttpResponse

isIdentifier

isIsoDateString

isJsonValue

isModulePath

isNonNegativeInteger

isOptionalDescriptor

isPlainObject

isRealtimeEnvelope

isRealtimeOp

isSafeFieldName

isSha256Hex

isSseEnvelope

isStructuredError

isValidatorDescriptor

isValidValidatorDescriptor

normalizeConfig

parseContentType

parseOpaqueId

readBoundedText

structuredError

validateActivateRequest

validateActivateResponse

validateComponentFunctionBinding

validateComponents

validateDeployment

validateDeploymentListResponse

validateFieldName

validateManifest

validateModuleSources

validateRollbackResponse

validateUploadRequest

validateUploadResponse

validateValue

verifyModuleSources

@pbvex/react

Interfaces

Client

PBVexClient

PBVexError

QueryResult

Type Aliases

ArgsOf

FunctionReference

ReturnOf

Variables

PBVexContext

Functions

PBVexProvider

useAction

useMutation

usePBVexClient

useQuery

useQueryResult

useSubscription

@pbvex/svelte

Interfaces

QueryResult

Type Aliases

QueryArgs

QueryState

Skip

Variables

createQuery

skip

useQueryResult

useSubscription

Functions

getClient

setClient

useAction

useMutation

useQuery

Go

Overview

Executable

PBVex CLI

Internal packages

API server

Authentication

Deployment

Backend core

Realtime

Function runtime

Scheduler

Schema

Storage

Other packages

Go API Reference

On this page

@pbvex/protocol / SseEnvelope

Type Alias: SseEnvelope

SseEnvelope = Readonly<{ data: RealtimeEnvelope; event?: string; id?: string; }>

Pager

Previous pageSchemaDescriptor

Next pageStorageFileMetadata

Generated API reference. Source of truth is the codebase.

Copyright © 2026 PBVex authors