1. API reference
  2. @samveys/opensearch

@samveys/opensearch

OpenSearch search driver, REST over fetch

Version
1.0.2Nov 5, 2026
Install
pnpm add @samveys/opensearch
Import 
import { opensearch } from '@samveys/opensearch'

Function (1)

opensearch Function

No documentation comment.

function opensearch(options: OpenSearchOptions): SearchDriver;

Exported from packages/opensearch/src/driver.ts

Interface (1)

OpenSearchOptions Interface

No documentation comment.

interface OpenSearchOptions {
    /** Node URL, e.g. `http://127.0.0.1:9200`. */
    readonly node: string;
    /** HTTP basic credentials. Never written into an error message. */
    readonly auth?: {
        readonly username: string;
        readonly password: string;
    };
    /** Per-request timeout, in ms. Default 30 000. */
    readonly requestTimeoutMs?: number;
}

Exported from packages/opensearch/src/driver.ts