PocketBase JSVM

https://pocketbase.io/jsvm
Admin
PocketBase JSVM provides a reference for the JavaScript Virtual Machine within PocketBase, enabling...
Tokens:413,213
Snippets:5,414
Trust Score:9.6
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### start()

Source: https://pocketbase.io/jsvm/functions/_app.start.html

Documentation for the start() function in the $app JSVM reference.

```APIDOC
## start()

### Description
Starts the application by registering the default system commands (serve, superuser, version) and executing pb.RootCmd.

### Method
Function

### Signature
start(): void

### Returns
void
```

--------------------------------

### start

Source: https://pocketbase.io/jsvm/interfaces/PocketBase-1.html

Starts the application, registering default system commands and executing the root command.

```APIDOC
## start

### Description
Starts the application, registering default system commands and executing the root command.

### Method
start

### Returns
void
```

--------------------------------

### serve(app, config): void

Source: https://pocketbase.io/jsvm/interfaces/apis.serve.html

Starts a new app web server. The app should be bootstrapped before starting the web server.

```APIDOC
## serve(app, config): void

### Description
Starts a new app web server. The app should be bootstrapped before starting the web server.

### Method
serve

### Parameters
- **app** (excludeHooks<App>) - Required - The app instance to serve.
- **config** (ServeConfig) - Required - Configuration for the server.

### Returns
void

### Example
```
app.Bootstrap()
apis.Serve(app, apis.ServeConfig{
  HttpAddr:        "127.0.0.1:8080",
  ShowStartBanner: false,
})
```
```

--------------------------------

### Serve app with apis.Serve

Source: https://pocketbase.io/jsvm/interfaces/apis.serve.html

Starts a new app web server. The app should be bootstrapped before starting the web server.

```go
 app.Bootstrap()  
 apis.Serve(app, apis.ServeConfig{  
   HttpAddr:        "127.0.0.1:8080",  
   ShowStartBanner: false,  
 })
```

--------------------------------

### Start HTTP server with ListenAndServe

Source: https://pocketbase.io/jsvm/modules/http.html

Shows how to register handlers on the DefaultServeMux and start an HTTP server with ListenAndServe. The handler is nil to use DefaultServeMux.

```go
http.Handle("/foo", fooHandler)

http.HandleFunc("/bar", func(w http.ResponseWriter, r *http.Request) {
  fmt.Fprintf(w, "Hello, %q", html.EscapeString(r.URL.Path))
})

log.Fatal(http.ListenAndServe(":8080", nil))
```

--------------------------------

### begin()

Source: https://pocketbase.io/jsvm/interfaces/dbx.DB.html

Begin starts a transaction.

```APIDOC
## begin(): dbx.Tx

### Description
Begin starts a transaction.

### Returns
dbx.Tx
```

--------------------------------

### start(): void

Source: https://pocketbase.io/jsvm/interfaces/exec.Cmd.html

Starts the specified command but does not wait for it to complete. If Start returns successfully, the c.Process field will be set. After a successful call to Start, the [Cmd.Wait] method must be called to release associated system resources.

```APIDOC
## start()

### Description
Starts the specified command but does not wait for it to complete. If Start returns successfully, the c.Process field will be set. After a successful call to Start, the [Cmd.Wait] method must be called to release associated system resources.

### Method
start

### Returns
- **void** - No return value.

```

--------------------------------

### bindBody: Example struct with tags

Source: https://pocketbase.io/jsvm/interfaces/core.RecordAuthWithPasswordRequestEvent.html

Example showing a struct with json and form tags for use with BindBody.

```go
data := struct{  
   somethingPrivate string  

   Title string `json:"title" form:"title"`  
   Total int    `json:"total" form:"total"`  
}{}  
err := e.BindBody(&data)
```

--------------------------------

### $os.cmd() usage example

Source: https://pocketbase.io/jsvm/functions/_os.cmd.html

Prepares the 'ls -sl' command and executes it, returning the standard output as a string. The example uses the toString() function to convert the output.

```javascript
// prepare the command to execute  
const cmd = $os.cmd('ls', '-sl')  
  
// execute the command and return its standard output as string  
const output = toString(cmd.output());
```

--------------------------------

### start(): void

Source: https://pocketbase.io/jsvm/interfaces/cron.Cron.html

Starts the cron ticker. Calling Start() on already started cron will restart the ticker.

```APIDOC
## start(): void

### Description
Start starts the cron ticker. Calling Start() on already started cron will restart the ticker.

### Method
start

### Returns
void
```

--------------------------------

### QueryRow usage example

Source: https://pocketbase.io/jsvm/interfaces/sql.Stmt.html

Shows how to execute a prepared query statement and scan the result into a variable. The example uses QueryRow with an id argument and scans the result into a string variable.

```go
var name string  
 err := nameByUseridStmt.QueryRow(id).Scan(&name)
```

--------------------------------

### WithGroup usage example

Source: https://pocketbase.io/jsvm/interfaces/slog.Handler.html

Example of using WithGroup to start a group of attributes that ends at the end of the log event.

```go
logger.WithGroup("s").LogAttrs(ctx, level, msg, slog.Int("a", 1), slog.Int("b", 2))
```

--------------------------------

### Example for findFirstRecordByFilter

Source: https://pocketbase.io/jsvm/interfaces/core.App.html

Shows two example calls to findFirstRecordByFilter: one with an empty filter and one with a filter using a bound parameter. The second demonstrates binding untrusted user variables via the params argument.

```go
app.FindFirstRecordByFilter("posts", "")  
app.FindFirstRecordByFilter("posts", "slug={:slug} && status='public'", dbx.Params{"slug": "test"})
```

--------------------------------

### Router usage example

Source: https://pocketbase.io/jsvm/interfaces/router.Router.html

Shows how to create a router, bind middlewares, add routes, create a sub-group, and build the mux for serving.

```go
r := NewRouter[*MyEvent](eventFactory)  

// middlewares  
r.BindFunc(m1, m2)  

// routes  
r.GET("/test", handler1)  

// sub-routers/groups  
api := r.Group("/api")  
api.GET("/admins", handler2)  

// generate a http.ServeMux instance based on the router configurations  
mux, _ := r.BuildMux()  

http.ListenAndServe("localhost:8090", mux)
```

--------------------------------

### FileField setter keys examples

Source: https://pocketbase.io/jsvm/classes/FileField.html

Examples of using the additional setter keys 'fieldName+', '+fieldName', and 'fieldName-' to append, prepend, and subtract files from a record's file field. The examples show the resulting record values as comments.

```go
// []string{"old1.txt", "old2.txt", "new1_ajkvass.txt", "new2_klhfnwd.txt"}
record.Set("documents+", []*filesystem.File{new1, new2})
```

```go
// []string{"new1_ajkvass.txt", "new2_klhfnwd.txt", "old1.txt", "old2.txt",}
record.Set("+documents", []*filesystem.File{new1, new2})
```

```go
// []string{"old2.txt",}
record.Set("documents-", "old1.txt")
```

--------------------------------

### begin

Source: https://pocketbase.io/jsvm/interfaces/sql.DB.html

Starts a transaction with default isolation level.

```APIDOC
## begin

### Description
Starts a transaction. The default isolation level is dependent on the driver.

### Method
begin

### Endpoint
begin

### Parameters
None

### Request Example
```
begin()
```

### Response
#### Success Response
- **sql.Tx** - The transaction object.

#### Response Example
```
Tx
```
```

--------------------------------

### WriteSSE example

Source: https://pocketbase.io/jsvm/interfaces/subscriptions.Message.html

Writes the current message in SSE format into the provided writer. The example shows creating a Message with Name and Data, then calling WriteSSE with the response writer and an event ID, followed by Flush.

```go
m := Message{Name: "users/create", Data: []byte{...}}
  m.WriteSSE(e.Response, "yourEventId")
  e.Flush()
```

--------------------------------

### startProcess

Source: https://pocketbase.io/jsvm/interfaces/os.startProcess.html

Documentation for the startProcess interface, which starts a new process with the specified program, arguments, and attributes.

```APIDOC
## startProcess(name, argv, attr): Process

### Description
Starts a new process with the program, arguments and attributes specified by name, argv and attr. The argv slice will become [os.Args] in the new process, so it normally starts with the program name. If the calling goroutine has locked the operating system thread with [runtime.LockOSThread] and modified any inheritable OS-level thread state (for example, Linux or Plan 9 name spaces), the new process will inherit the caller's thread state. StartProcess is a low-level interface. The [os/exec] package provides higher-level interfaces. If there is an error, it will be of type [*PathError].

### Method
startProcess

### Parameters
- **name** (string) - Required - The program name.
- **argv** (string[]) - Required - The arguments for the new process.
- **attr** (ProcAttr) - Required - The attributes for the new process.

### Returns
- **Process** - The new process.
```

--------------------------------

### findAllRecords usage

Source: https://pocketbase.io/jsvm/interfaces/core.BaseApp.html

Example usage of the findAllRecords method. The first call returns all records for the 'example' collection. The second call demonstrates adding dbx expressions to filter records.

```go
// no extra expressions  
app.FindAllRecords("example")  
  
// with extra expressions  
expr1 := dbx.HashExp{"email": "test@example.com"}  
expr2 := dbx.NewExp("LOWER(username) = {:username}", dbx.Params{"username": "test"})  
app.FindAllRecords("example", expr1, expr2)
```

--------------------------------

### beginTx(ctx, opts)

Source: https://pocketbase.io/jsvm/interfaces/dbx.DB.html

BeginTx starts a transaction with the given context and transaction options.

```APIDOC
## beginTx(ctx, opts): dbx.Tx

### Description
BeginTx starts a transaction with the given context and transaction options.

### Parameters
- **ctx** (context.Context) - Required - The context.
- **opts** (TxOptions) - Required - The transaction options.

### Returns
dbx.Tx
```

--------------------------------

### onServe

Source: https://pocketbase.io/jsvm/interfaces/core.App.html

Registers a hook for the server start event.

```APIDOC
## onServe()

### Description
OnServe hook is triggered when the app web server is started (after starting the TCP listener but before initializing the blocking serve task), allowing you to adjust its options and attach new routes or middlewares.

### Method
Hook registration

### Returns
Hook<ServeEvent>
```

--------------------------------

### Logger.With example

Source: https://pocketbase.io/jsvm/modules/slog.html

Constructs a new logger with additional attributes (here "url" and r.URL) that will appear in the output of every call.

```go
 logger2 := logger.With("url", r.URL)
```

--------------------------------

### http.ListenAndServe

Source: https://pocketbase.io/jsvm/modules/http.html

Starts an HTTP server with a given address and handler. If handler is nil, DefaultServeMux is used.

```APIDOC
## ListenAndServe

### Description
Starts an HTTP server with a given address and handler. If handler is nil, DefaultServeMux is used.

### Method
ListenAndServe

### Endpoint
http.ListenAndServe(addr, handler)

### Parameters
#### Path Parameters
- **addr** (string) - Required - The address to listen on (e.g., ":8080").
- **handler** (Handler) - Optional - The handler to use. If nil, DefaultServeMux is used.

### Request Example
```
log.Fatal(http.ListenAndServe(":8080", nil))
```

### Response
#### Success Response (200)
- **err** (error) - An error, if any.

#### Response Example
```
log.Fatal(http.ListenAndServe(":8080", nil))
```
```

--------------------------------

### Subscribe with options

Source: https://pocketbase.io/jsvm/interfaces/subscriptions.Client.html

Example usage of the subscribe method, showing how to subscribe to a subscription with optional query parameters for options.

```typescript
Subscribe(  
    "subscriptionA",  
    `subscriptionB?options={"query":{"a":1},"headers":{"x_token":"abc"}}`,  
)
```

--------------------------------

### TextHandler output

Source: https://pocketbase.io/jsvm/modules/slog.html

Example output from TextHandler, showing key=value pairs.

```text
 time=2022-11-08T15:28:26.000-05:00 level=INFO msg=hello count=3
```

--------------------------------

### PasswordField - Set and Get Password Values

Source: https://pocketbase.io/jsvm/classes/PasswordField.html

Examples of how to set a password value using Set and SetRaw methods, and how to retrieve the bcrypt hash using the 'fieldName:hash' getter key.

```APIDOC
## PasswordField - Set and Get Password Values

### Description
Demonstrates how to set a password field value using the `Set` and `SetRaw` methods, and how to retrieve the bcrypt hash using the `fieldName:hash` getter key.

### Methods
- **Set(fieldName, value)** - Sets the field value. When setting a plain password, it will be bcrypt hashed on persist.
- **SetRaw(fieldName, value)** - Sets the field value directly as a bcrypt hash.
- **GetString(fieldName)** - Returns the plain password until persisted, otherwise empty string.
- **GetString(fieldName:hash)** - Returns the bcrypt hash string of the record field value.

### Example
```javascript
// generates a bcrypt hash of "123456" and set it as field value  
// (record.GetString("password") returns the plain password until persisted, otherwise empty string)  
record.Set("password", "123456")  

// set directly a bcrypt hash of "123456" as field value  
// (record.GetString("password") returns empty string)  
record.SetRaw("password", "$2a$10$.5Elh8fgxypNUWhpUUr/xOa2sZm0VIaE0qWuGGl9otUfobb46T1Pq")
```

### Getter Keys
- `fieldName:hash` - Returns the bcrypt hash string of the record field value (if any). For example: `record.GetString("password:hash")`
```

--------------------------------

### routerAdd example with requireAuth middleware

Source: https://pocketbase.io/jsvm/functions/routerAdd.html

Registers a GET route at /hello that returns a JSON response. The $apis.requireAuth() middleware is passed as a fourth argument, requiring authentication. This method is only available in the pb_hooks context.

```javascript
routerAdd("GET", "/hello", (e) => {  
    return e.json(200, {"message": "Hello!"})  
}, $apis.requireAuth())
```

--------------------------------

### FindFirstRecordByFilter example

Source: https://pocketbase.io/jsvm/interfaces/core.BaseApp.html

Finds the first record matching a filter. The first call uses an empty filter to get the first record in the collection. The second call uses a filter with a bound parameter to avoid injection. Returns sql.ErrNoRows if no record is found.

```go
app.FindFirstRecordByFilter("posts", "")  
 app.FindFirstRecordByFilter("posts", "slug={:slug} && status='public'", dbx.Params{"slug": "test"})
```

--------------------------------

### Create a TCP server with net.Listen

Source: https://pocketbase.io/jsvm/modules/net.html

Shows how to create a TCP server with net.Listen and accept connections in a loop. Each connection is handled in a new goroutine via handleConnection. Error handling is left as a placeholder comment.

```go
 ln, err := net.Listen("tcp", ":8080")  
 if err != nil {  
   // handle error  
 }  
 for {  
   conn, err := ln.Accept()  
   if err != nil {  
     // handle error  
   }  
   go handleConnection(conn)  
 }

```

--------------------------------

### execute

Source: https://pocketbase.io/jsvm/interfaces/PocketBase-1.html

Initializes the application (if not already) and executes the pb.RootCmd with graceful shutdown support. This method differs from pb.Start() by not registering the default system commands.

```APIDOC
## execute

### Description
Initializes the application (if not already) and executes the pb.RootCmd with graceful shutdown support. This method differs from pb.Start() by not registering the default system commands.

### Method
N/A (JSVM method)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **void** - No return value.

#### Response Example
N/A
```

--------------------------------

### Connect to a server with net.Dial

Source: https://pocketbase.io/jsvm/modules/net.html

Shows how to connect to a server using net.Dial. The example sends an HTTP request and reads the response status line. The error handling is left as a placeholder comment.

```go
 conn, err := net.Dial("tcp", "golang.org:80")  
 if err != nil {  
   // handle error  
 }  
 fmt.Fprintf(conn, "GET / HTTP/1.0\r\n\r\n")  
 status, err := bufio.NewReader(conn).ReadString('\n')  
 // ...

```

--------------------------------

### Equivalent slog.Group example

Source: https://pocketbase.io/jsvm/interfaces/slog.Handler.html

Equivalent behavior to the WithGroup example, using slog.Group to group attributes.

```go
logger.LogAttrs(ctx, level, msg, slog.Group("s", slog.Int("a", 1), slog.Int("b", 2)))
```

--------------------------------

### Create file from URL with filesystem.NewFileFromURL

Source: https://pocketbase.io/jsvm/interfaces/filesystem.newFileFromURL.html

Creates a new filesystem.File by downloading the resource from the provided URL. Uses a 30-second timeout context and handles the returned file and error.

```go
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)  
 defer cancel()  
  
 file, err := filesystem.NewFileFromURL(ctx, "https://example.com/image.png")

```

--------------------------------

### slog.Info example

Source: https://pocketbase.io/jsvm/modules/slog.html

Creates a log record with the default logger, level Info, message "hello", and a key-value pair "count" with value 3.

```go
 slog.Info("hello", "count", 3)
```

--------------------------------

### Create and save a new AuthOrigin with core.NewOrigin

Source: https://pocketbase.io/jsvm/interfaces/core.newAuthOrigin.html

Shows how to create and configure a new AuthOrigin model using the core.NewOrigin constructor, set its record reference, collection reference, and fingerprint, then persist it with app.Save.

```go
origin := core.NewOrigin(app)  
 origin.SetRecordRef(user.Id)  
 origin.SetCollectionRef(user.Collection().Id)  
 origin.SetFingerprint("...")  
 app.Save(origin)
```

--------------------------------

### Create custom http.Server with timeouts

Source: https://pocketbase.io/jsvm/modules/http.html

Shows how to create a custom http.Server with timeouts and header size limits for more control over server behavior.

```go
s := &http.Server{
  Addr:           ":8080",
  Handler:        myHandler,
  ReadTimeout:    10 * time.Second,
  WriteTimeout:   10 * time.Second,
  MaxHeaderBytes: 1 << 20,
}
log.Fatal(s.ListenAndServe())
```

--------------------------------

### newWithConfig(config)

Source: https://pocketbase.io/jsvm/interfaces/pocketbase.newWithConfig.html

Creates a new PocketBase instance with the provided config. The application will not be initialized or bootstrapped yet; DB connections, migrations, app settings, etc. will not be accessible until PocketBase.Start is executed. To initialize before Start, manually call PocketBase.Bootstrap.

```APIDOC
## newWithConfig(config)

### Description
Creates a new PocketBase instance with the provided config. The application will not be initialized or bootstrapped yet; DB connections, migrations, app settings, etc. will not be accessible until PocketBase.Start is executed. To initialize before Start, manually call PocketBase.Bootstrap.

### Method
newWithConfig

### Parameters
#### Parameters
- **config** (Config) - Required - The configuration for the new PocketBase instance.

### Returns
- **pocketbase.PocketBase** - The newly created PocketBase instance.

```

--------------------------------

### BindBody struct example

Source: https://pocketbase.io/jsvm/interfaces/core.CollectionsListRequestEvent.html

Example of a struct used with BindBody. It shows unexported fields for private data and exported fields with json and form tags for binding. The struct is passed to e.BindBody.

```go
data := struct{  
    somethingPrivate string  

    Title string `json:"title" form:"title"`  
    Total int    `json:"total" form:"total"`  
 }{}  
 err := e.BindBody(&data)
```

--------------------------------

### FindAllCollections usage example

Source: https://pocketbase.io/jsvm/functions/_app.findAllCollections.html

Call findAllCollections with no arguments to retrieve all collections, or pass one or more collection type strings to filter results. The example shows filtering for 'auth' and 'view' collections.

```javascript
app.FindAllCollections() // all collections  
app.FindAllCollections("auth", "view") // only auth and view collections
```

--------------------------------

### Run a program with exec.Command

Source: https://pocketbase.io/jsvm/modules/exec.html

Shows how to run a program with exec.Command and cmd.Run. As of Go 1.19, this will not find and run ./prog or .\prog.exe, no matter how the current path is configured.

```go
cmd := exec.Command("prog")
if err := cmd.Run(); err != nil {
  log.Fatal(err)
}
```

--------------------------------

### ReplaceModifiers example usage

Source: https://pocketbase.io/jsvm/interfaces/core.ExternalAuth.html

Shows how to use ReplaceModifiers to apply modifier values to a record's data. The example demonstrates that modifiers like '+5' are applied to the base value, resulting in a new value.

```javascript
newData := record.ReplaceModifiers(data)  
 // record: {"field": 10}  
 // data:   {"field+": 5}  
 // result: {"field": 15}
Copy
```

--------------------------------

### get(key): T

Source: https://pocketbase.io/jsvm/interfaces/types.JSONMap.html

Get retrieves a single value from the current JSONMap[T]. This helper was added primarily to assist the goja integration since custom map types don't have direct access to the map keys.

```APIDOC
## get(key): T

### Description
Get retrieves a single value from the current JSONMap[T]. This helper was added primarily to assist the goja integration since custom map types don't have direct access to the map keys.

### Method
get

### Parameters
- **key** (string) - Required - The key to retrieve.

### Returns
- **T** - The value associated with the key.
```

--------------------------------

### local(dirPath): System

Source: https://pocketbase.io/jsvm/functions/_filesystem.local.html

Initializes a new local-only filesystem instance. Make sure to call close() after you are done working with it. Most users should prefer $app.newFilesystem() which will construct a local or S3 filesystem based on the configured application settings.

```APIDOC
## local(dirPath): System

### Description
Initializes a new local-only filesystem instance. Make sure to call `close()` after you are done working with it. Most users should prefer `$app.newFilesystem()` which will construct a local or S3 filesystem based on the configured application settings.

### Parameters
- **dirPath** (string) - Required - The directory path for the local filesystem.

### Returns
- **System** - The filesystem instance.
```

--------------------------------

### Make HTTP requests with Get, Post, and PostForm

Source: https://pocketbase.io/jsvm/modules/http.html

Shows the basic HTTP client methods Get, Post, and PostForm for making HTTP or HTTPS requests. The caller must close the response body when finished.

```go
resp, err := http.Get("http://example.com/")
...
resp, err := http.Post("http://example.com/upload", "image/jpeg", &buf)
...
resp, err := http.PostForm("http://example.com/form",
  url.Values{"key": {"Value"}, "id": {"123"}})
```

--------------------------------

### ReplaceModifiers example usage

Source: https://pocketbase.io/jsvm/interfaces/core.BaseRecordProxy.html

Shows how to use ReplaceModifiers to apply modifier values to a record's data. The example demonstrates that modifiers like '+5' are applied to the base value, resulting in a new map with resolved values.

```go
newData := record.ReplaceModifiers(data)  
 // record: {"field": 10}  
 // data:   {"field+": 5}  
 // result: {"field": 15}
```

--------------------------------

### second()

Source: https://pocketbase.io/jsvm/interfaces/time.Time.html

Method to get the second component.

```APIDOC
## second()

### Description
Returns the second offset within the minute specified by the time, in the range [0, 59].

### Method
second

### Signature
second(): number

### Returns
- **number** - The second offset.

```

--------------------------------

### newFilesystem

Source: https://pocketbase.io/jsvm/interfaces/core.App.html

Creates a new filesystem instance for regular files.

```APIDOC
## newFilesystem

### Description
Creates a new local or S3 filesystem instance for managing regular app files (ex. record uploads) based on the current app settings. Make sure to call `Close()` on the returned result after you are done working with it.

### Method
Function call

### Signature
`newFilesystem(): System`

### Returns
- **System** - A filesystem instance for regular files.
```

--------------------------------

### nanosecond()

Source: https://pocketbase.io/jsvm/interfaces/time.Time.html

Method to get the nanosecond component.

```APIDOC
## nanosecond()

### Description
Returns the nanosecond offset within the second specified by the time, in the range [0, 999999999].

### Method
nanosecond

### Signature
nanosecond(): number

### Returns
- **number** - The nanosecond offset.

```

--------------------------------

### Create custom http.Client with redirect policy

Source: https://pocketbase.io/jsvm/modules/http.html

Shows how to create an http.Client with a custom CheckRedirect policy and use it to make requests, including adding headers via http.NewRequest and client.Do.

```go
client := &http.Client{
  CheckRedirect: redirectPolicyFunc,
}

resp, err := client.Get("http://example.com")
// ...

req, err := http.NewRequest("GET", "http://example.com", nil)
// ...
req.Header.Add("If-None-Match", `W/"wyzzy"`)
resp, err := client.Do(req)
// ...
```

--------------------------------

### minute()

Source: https://pocketbase.io/jsvm/interfaces/time.Time.html

Method to get the minute component.

```APIDOC
## minute()

### Description
Returns the minute offset within the hour specified by the time, in the range [0, 59].

### Method
minute

### Signature
minute(): number

### Returns
- **number** - The minute offset.

```

--------------------------------

### newFilesystem()

Source: https://pocketbase.io/jsvm/functions/_app.newFilesystem.html

Creates a new local or S3 filesystem instance for managing regular app files based on the current app settings. The returned System must be closed with Close() after use.

```APIDOC
## newFilesystem()

### Description
Creates a new local or S3 filesystem instance for managing regular app files (ex. record uploads) based on the current app settings. Make sure to call Close() on the returned result after you are done working with it.

### Method
Function

### Signature
newFilesystem(): System

### Returns
- **System** - The filesystem instance. Must be closed with Close() after use.

### Remarks
- The filesystem is created based on the current app settings.
- Always call Close() on the returned System to release resources.
```

--------------------------------

### findFirstRecordByFilter examples

Source: https://pocketbase.io/jsvm/functions/_app.findFirstRecordByFilter.html

Two example calls to findFirstRecordByFilter. The first uses an empty filter to return the first record in the collection. The second binds a user-supplied slug value via dbx.Params to avoid injection, as recommended by the NB! note.

```go
app.FindFirstRecordByFilter("posts", "")
app.FindFirstRecordByFilter("posts", "slug={:slug} && status='public'", dbx.Params{"slug": "test"})
```

--------------------------------

### zoneBounds()

Source: https://pocketbase.io/jsvm/interfaces/time.Time.html

Returns the bounds of the time zone in effect at the time. The zone begins at start and the next zone begins at end. If the zone begins at the beginning of time, start will be a zero Time. If the zone goes on forever, end will be a zero Time.

```APIDOC
## zoneBounds()

### Description
Returns the bounds of the time zone in effect at the time. The zone begins at start and the next zone begins at end. If the zone begins at the beginning of time, start will be a zero Time. If the zone goes on forever, end will be a zero Time.

### Method
zoneBounds

### Returns
- **[Time, Time]** - A tuple containing the start and end times of the zone.

```

--------------------------------

### newLocal(dirPath): System

Source: https://pocketbase.io/jsvm/interfaces/filesystem.newLocal.html

Initializes a new local filesystem instance. Make sure to call Close() after you are done working with it.

```APIDOC
## newLocal(dirPath): System

### Description
Initializes a new local filesystem instance. NB! Make sure to call `Close()` after you are done working with it.

### Method
newLocal

### Parameters
#### Parameters
- **dirPath** (string) - Required - The directory path for the local filesystem.

### Returns
- **System** - The initialized local filesystem instance.

```

--------------------------------

### mkdir(name, perm): void

Source: https://pocketbase.io/jsvm/interfaces/os.mkdir.html

Creates a new directory with the specified name and permission bits.

```APIDOC
## mkdir(name, perm): void

### Description
Mkdir creates a new directory with the specified name and permission bits (before umask). If there is an error, it will be of type [*PathError].

### Method
mkdir

### Parameters
- **name** (string) - Required - The name of the directory to create.
- **perm** (os.FileMode) - Required - The permission bits for the new directory.

### Returns
void
```

--------------------------------

### db

Source: https://pocketbase.io/jsvm/interfaces/pocketbase.PocketBase.html

Method to get the default database builder.

```APIDOC
## db(): Builder

### Description
Returns the default app data.db builder instance. To minimize SQLITE_BUSY errors, it automatically routes the SELECT queries to the underlying concurrent db pool and everything else to the nonconcurrent one. For more finer control over the used connections pools you can call directly ConcurrentDB() or NonconcurrentDB().

### Method
db

### Returns
- **Builder** - The default database builder.
```

--------------------------------

### serveTLS(l, certFile, keyFile): void

Source: https://pocketbase.io/jsvm/interfaces/http.Server.html

Accepts incoming TLS connections on the given listener and serves requests. Requires certificate and key files unless TLSConfig is populated.

```APIDOC
## serveTLS(l, certFile, keyFile): void

### Description
ServeTLS accepts incoming connections on the Listener l, creating a new service goroutine for each. The service goroutines perform TLS setup and then read requests, calling s.Handler to reply to them. Files containing a certificate and matching private key for the server must be provided if neither the [Server]'s TLSConfig.Certificates, TLSConfig.GetCertificate nor config.GetConfigForClient are populated. If the certificate is signed by a certificate authority, the certFile should be the concatenation of the server's certificate, any intermediates, and the CA's certificate. ServeTLS always returns a non-nil error. After [Server.Shutdown] or [Server.Close], the returned error is [ErrServerClosed].

### Method
serveTLS

### Parameters
- **l** (Listener) - Required - The network listener to accept connections from.
- **certFile** (string) - Required - Path to the certificate file.
- **keyFile** (string) - Required - Path to the private key file.

### Returns
void
```

--------------------------------

### unixMilli()

Source: https://pocketbase.io/jsvm/interfaces/time.Time.html

Method to get the Unix time in milliseconds.

```APIDOC
## unixMilli()

### Description
Returns the time as a Unix time, the number of milliseconds elapsed since January 1, 1970 UTC. The result is undefined if the Unix time in milliseconds cannot be represented by an int64 (a date more than 292 million years before or after 1970). The result does not depend on the location associated with the time.

### Method
unixMilli

### Signature
unixMilli(): number

### Returns
- **number** - The Unix time in milliseconds.

```

--------------------------------

### unixMicro()

Source: https://pocketbase.io/jsvm/interfaces/time.Time.html

Method to get the Unix time in microseconds.

```APIDOC
## unixMicro()

### Description
Returns the time as a Unix time, the number of microseconds elapsed since January 1, 1970 UTC. The result is undefined if the Unix time in microseconds cannot be represented by an int64 (a date before year -290307 or after year 294246). The result does not depend on the location associated with the time.

### Method
unixMicro

### Signature
unixMicro(): number

### Returns
- **number** - The Unix time in microseconds.

```

--------------------------------

### run(): void

Source: https://pocketbase.io/jsvm/interfaces/exec.Cmd.html

Starts the specified command and waits for it to complete. The returned error is nil if the command runs successfully and exits with zero status.

```APIDOC
## run()

### Description
Starts the specified command and waits for it to complete. The returned error is nil if the command runs, has no problems copying stdin, stdout, and stderr, and exits with a zero exit status. If the command starts but does not complete successfully, the error is of type [*ExitError]. Other error types may be returned for other situations. If the calling goroutine has locked the operating system thread with [runtime.LockOSThread] and modified any inheritable OS-level thread state, the new process will inherit the caller's thread state.

### Method
run

### Returns
- **void** - No return value.

```

--------------------------------

### unix()

Source: https://pocketbase.io/jsvm/interfaces/time.Time.html

Method to get the Unix time in seconds.

```APIDOC
## unix()

### Description
Returns the time as a Unix time, the number of seconds elapsed since January 1, 1970 UTC. The result does not depend on the location associated with the time. Unix-like operating systems often record time as a 32-bit count of seconds, but since the method here returns a 64-bit value it is valid for billions of years into the past or future.

### Method
unix

### Signature
unix(): number

### Returns
- **number** - The Unix time in seconds.

```

--------------------------------

### syscallConn

Source: https://pocketbase.io/jsvm/interfaces/os.File.html

Returns a raw file.

```APIDOC
## syscallConn()

### Description
SyscallConn returns a raw file. This implements the syscall.Conn interface.

### Method
syscallConn

### Parameters
None

### Returns
syscall.RawConn
```

--------------------------------

### Open a file with os.Open

Source: https://pocketbase.io/jsvm/modules/os.html

Opens a file for reading. If the open fails, the error string will be self-explanatory, like 'open file.go: no such file or directory'.

```go
 file, err := os.Open("file.go") // For read access.  
 if err != nil {  
   log.Fatal(err)  
 }
```

--------------------------------

### string()

Source: https://pocketbase.io/jsvm/interfaces/time.Time.html

Method to get a string representation of the time.

```APIDOC
## string()

### Description
Returns the time formatted using the format string "2006-01-02 15:04:05.999999999 -0700 MST". If the time has a monotonic clock reading, the returned string includes a final field "m=±", where value is the monotonic clock reading formatted as a decimal number of seconds. The returned string is meant for debugging; for a stable serialized representation, use t.MarshalText, t.MarshalBinary, or t.Format with an explicit format string.

### Method
string

### Signature
string(): string

### Returns
- **string** - The formatted time string.

```

--------------------------------

### cron

Source: https://pocketbase.io/jsvm/interfaces/core.BaseApp.html

Method to get the app cron instance.

```APIDOC
## cron(): Cron

### Description
Returns the app cron instance.

### Method
cron

### Parameters
None

### Returns
Cron - The app cron instance.
```

--------------------------------

### concurrentDB

Source: https://pocketbase.io/jsvm/interfaces/core.BaseApp.html

Method to get the concurrent database builder instance.

```APIDOC
## concurrentDB(): Builder

### Description
Returns the concurrent app data.db builder instance. This method is used mainly internally for executing db read operations in a concurrent/non-blocking manner. Most users should use simply DB() as it will automatically route the query execution to ConcurrentDB() or NonconcurrentDB(). In a transaction the ConcurrentDB() and NonconcurrentDB() refer to the same *dbx.TX instance.

### Method
concurrentDB

### Parameters
None

### Returns
Builder - The concurrent database builder instance.
```

--------------------------------

### constructor

Source: https://pocketbase.io/jsvm/classes/TestS3FilesystemForm.html

Creates a new TestS3FilesystemForm instance with the given app.

```APIDOC
## constructor

### Description
Creates a new TestS3FilesystemForm instance.

### Signature
`new TestS3FilesystemForm(app): TestS3FilesystemForm`

### Parameters
- **app** (excludeHooks<App>) - Required - The app instance.

### Returns
TestS3FilesystemForm
```

--------------------------------

### Create and add a Command

Source: https://pocketbase.io/jsvm/classes/Command.html

Defines a new command with a 'use' string and a 'run' function that logs 'Hello world!'. The command is added to the root command via $app.rootCmd.addCommand().

```javascript
const command = new Command({  
    use: "hello",  
    run: (cmd, args) => { console.log("Hello world!") },  
})  
  
$app.rootCmd.addCommand(command);
```

--------------------------------

### hasStarted(): boolean

Source: https://pocketbase.io/jsvm/interfaces/cron.Cron.html

Checks whether the current Cron ticker has been started.

```APIDOC
## hasStarted(): boolean

### Description
HasStarted checks whether the current Cron ticker has been started.

### Method
hasStarted

### Returns
boolean
```
Tokens:
Raw