prorm API Reference
    Preparing search index...

    Interface SurrealStoreOptions

    Connection options for SurrealStore.

    url is the SurrealDB endpoint (e.g. ws://127.0.0.1:8000/rpc or http://127.0.0.1:8000). namespace/database select the namespace and database to use() after connecting. username/password are the root (or scoped) credentials used to signin(). A pre-built Surreal client can be supplied via client to bypass the lazy require('surrealdb').

    interface SurrealStoreOptions {
        url: string;
        namespace?: string;
        database?: string;
        username?: string;
        password?: string;
        client?: any;
    }
    Index
    url namespace? database? username? password? client?
    url: string

    SurrealDB endpoint URL, e.g. ws://127.0.0.1:8000/rpc.

    namespace?: string

    Namespace to use() after connecting.

    database?: string

    Database to use() after connecting.

    username?: string

    Username for signin().

    password?: string

    Password for signin().

    client?: any

    A pre-built Surreal instance. When provided, connect() uses it directly (still calling signin()/use() when credentials/ns/db are configured) and skips require('surrealdb'). Primarily for tests and connection reuse.

    Settings
    Member Visibility

    On This Page
    Properties