prorm API Reference
    Preparing search index...

    Interface OpenSearchStoreOptions

    Connection options for OpenSearchStore.

    node (or nodes), auth, and ssl are passed straight through to the driver's new 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, node/auth/ssl are ignored.

    interface OpenSearchStoreOptions {
        node?: string;
        nodes?: string | string[];
        auth?: Record<string, unknown>;
        ssl?: Record<string, unknown>;
        client?: any;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

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

    Index
    node? nodes? auth? ssl? client?
    node?: string

    URL of a single OpenSearch node, e.g. https://localhost:9200.

    nodes?: string | string[]

    URLs of multiple OpenSearch nodes for client-side round-robin.

    auth?: Record<string, unknown>

    Basic-auth credentials ({ username, password }) or other driver-supported auth.

    ssl?: Record<string, unknown>

    TLS options passed to the driver (e.g. { rejectUnauthorized: false }).

    client?: any

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

    Settings
    Member Visibility

    On This Page
    Properties