PocketBase site
Preparing search index...
The search index is not available
PocketBase JSVM reference
PocketBase JSVM reference
$apis
Namespace $apis
$apis
defines commonly used PocketBase api helpers and middlewares.
Index
Functions
activity
Logger
body
Limit
enrich
Record
enrich
Records
gzip
record
Auth
Response
request
Info
require
Admin
Auth
require
Admin
Auth
Only
If
Any
require
Admin
Or
Owner
Auth
require
Admin
Or
Record
Auth
require
Guest
Only
require
Record
Auth
static
Directory
Handler
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
Pocket
Base JSVM reference
PocketBase
$apis
Functions
activity
Logger
body
Limit
enrich
Record
enrich
Records
gzip
record
Auth
Response
request
Info
require
Admin
Auth
require
Admin
Auth
Only
If
Any
require
Admin
Or
Owner
Auth
require
Admin
Or
Record
Auth
require
Guest
Only
require
Record
Auth
static
Directory
Handler
$app
$dbx
$filepath
$filesystem
$http
$mails
$os
$security
$template
$tokens
__hooks
array
Of
cron
Add
cron
Remove
migrate
on
Admin
After
Auth
Refresh
Request
on
Admin
After
Auth
With
Password
Request
on
Admin
After
Confirm
Password
Reset
Request
on
Admin
After
Create
Request
on
Admin
After
Delete
Request
on
Admin
After
Request
Password
Reset
Request
on
Admin
After
Update
Request
on
Admin
Auth
Request
on
Admin
Before
Auth
Refresh
Request
on
Admin
Before
Auth
With
Password
Request
on
Admin
Before
Confirm
Password
Reset
Request
on
Admin
Before
Create
Request
on
Admin
Before
Delete
Request
on
Admin
Before
Request
Password
Reset
Request
on
Admin
Before
Update
Request
on
Admin
View
Request
on
Admins
List
Request
on
After
Api
Error
on
After
Bootstrap
on
Before
Api
Error
on
Before
Bootstrap
on
Collection
After
Create
Request
on
Collection
After
Delete
Request
on
Collection
After
Update
Request
on
Collection
Before
Create
Request
on
Collection
Before
Delete
Request
on
Collection
Before
Update
Request
on
Collection
View
Request
on
Collections
After
Import
Request
on
Collections
Before
Import
Request
on
Collections
List
Request
on
File
After
Token
Request
on
File
Before
Token
Request
on
File
Download
Request
on
Mailer
After
Admin
Reset
Password
Send
on
Mailer
After
Record
Change
Email
Send
on
Mailer
After
Record
Reset
Password
Send
on
Mailer
After
Record
Verification
Send
on
Mailer
Before
Admin
Reset
Password
Send
on
Mailer
Before
Record
Change
Email
Send
on
Mailer
Before
Record
Reset
Password
Send
on
Mailer
Before
Record
Verification
Send
on
Model
After
Create
on
Model
After
Delete
on
Model
After
Update
on
Model
Before
Create
on
Model
Before
Delete
on
Model
Before
Update
on
Realtime
After
Message
Send
on
Realtime
After
Subscribe
Request
on
Realtime
Before
Message
Send
on
Realtime
Before
Subscribe
Request
on
Realtime
Connect
Request
on
Realtime
Disconnect
Request
on
Record
After
Auth
Refresh
Request
on
Record
After
Auth
WithOAuth2
Request
on
Record
After
Auth
With
Password
Request
on
Record
After
Confirm
Email
Change
Request
on
Record
After
Confirm
Password
Reset
Request
on
Record
After
Confirm
Verification
Request
on
Record
After
Create
Request
on
Record
After
Delete
Request
on
Record
After
Request
Email
Change
Request
on
Record
After
Request
Password
Reset
Request
on
Record
After
Request
Verification
Request
on
Record
After
Unlink
External
Auth
Request
on
Record
After
Update
Request
on
Record
Auth
Request
on
Record
Before
Auth
Refresh
Request
on
Record
Before
Auth
WithOAuth2
Request
on
Record
Before
Auth
With
Password
Request
on
Record
Before
Confirm
Email
Change
Request
on
Record
Before
Confirm
Password
Reset
Request
on
Record
Before
Confirm
Verification
Request
on
Record
Before
Create
Request
on
Record
Before
Delete
Request
on
Record
Before
Request
Email
Change
Request
on
Record
Before
Request
Password
Reset
Request
on
Record
Before
Request
Verification
Request
on
Record
Before
Unlink
External
Auth
Request
on
Record
Before
Update
Request
on
Record
List
External
Auths
Request
on
Record
View
Request
on
Records
List
Request
on
Settings
After
Update
Request
on
Settings
Before
Update
Request
on
Settings
List
Request
on
Terminate
reader
To
String
router
Add
router
Pre
router
Use
sleep
Admin
Admin
Login
Form
Admin
Password
Reset
Confirm
Form
Admin
Password
Reset
Request
Form
Admin
Upsert
Form
Api
Error
Apple
Client
Secret
Create
Form
Bad
Request
Error
Collection
Collection
Upsert
Form
Collections
Import
Form
Command
Cookie
Dao
Date
Time
Dynamic
Model
Forbidden
Error
Mailer
Message
Not
Found
Error
Realtime
Subscribe
Form
Record
Email
Change
Confirm
Form
Record
Email
Change
Request
Form
RecordOAuth2
Login
Form
Record
Password
Login
Form
Record
Password
Reset
Confirm
Form
Record
Password
Reset
Request
Form
Record
Upsert
Form
Record
Verification
Confirm
Form
Record
Verification
Request
Form
Schema
Schema
Field
Settings
Upsert
Form
Subscription
Message
Test
Email
Send
Form
Test
S3
Filesystem
Form
Unauthorized
Error
Validation
Error
Namespaces
apis
auth
blob
bufio
bytes
cobra
context
core
daos
dbx
echo
exec
filepath
filesystem
forms
fs
hook
http
io
jwt
mail
mailer
mails
middleware
migrate
models
multipart
net
oauth2
os
ozzo_
validation
pocketbase
schema
search
security
settings
slog
sql
store
subscriptions
syscall
template
textproto
time
tokens
types
url
Type Aliases
Core
App
Pocket
Base
_
Tygoja
Any
_
Tygoja
Dict
exclude
Hooks
Generated using
TypeDoc
$apisdefines commonly used PocketBase api helpers and middlewares.