prorm API Reference
    Preparing search index...

    Interface TypesenseStoreOptions

    Connection options for TypesenseStore.

    nodes and apiKey are passed straight through to the driver's new Typesense.Client(...). Pass client to inject an already-built client instance (used in tests and when the caller wants full control over driver configuration); when present, nodes/apiKey are ignored.

    interface TypesenseStoreOptions {
        nodes?: TypesenseNode[];
        apiKey?: string;
        client?: any;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Any additional options passed through to the driver's client.

    Index
    nodes? apiKey? client?
    nodes?: TypesenseNode[]

    One or more Typesense nodes to connect to.

    apiKey?: string

    API key used to authenticate against the server.

    client?: any

    An already-constructed Typesense client to use instead of building one.

    Settings
    Member Visibility

    On This Page
    Properties