Interface ConnectOptions

interface ConnectOptions {
    authorizationScopeFingerprint: string;
    cache?: ConnectDiscoveryCache;
    capabilityPolicy?: DiscoveryCapabilityPolicy;
    client?: HonuaClient;
    clientOptions?: Omit<HonuaClientOptions, "baseUrl">;
    collectionId?: string;
    endpoint: string | URL;
    geoparquet?: {
        geometryColumn?: string;
        profiler: GeoParquetSourceProfiler;
        urls?: readonly string[];
    };
    id?: string;
    metadata?: Omit<HonuaMetadataRequestOptions, "signal" | "refresh">;
    protocol: ConnectProtocolHint;
    refresh?: boolean;
    resolveSource?: SourceResolver;
    signal?: AbortSignal;
    typeName?: string;
}

Properties

authorizationScopeFingerprint cache? capabilityPolicy? client? clientOptions? collectionId? endpoint geoparquet? id? metadata? protocol refresh? resolveSource? signal? typeName?

Properties

ReadonlyauthorizationScopeFingerprint

authorizationScopeFingerprint: string

Stable ACL/audience fingerprint. Never pass a bearer token or API key.

Optional Readonlycache

cache?: ConnectDiscoveryCache

Optional ReadonlycapabilityPolicy

capabilityPolicy?: DiscoveryCapabilityPolicy

Optional Readonlyclient

client?: HonuaClient

Existing client configured for the endpoint's service root, useful for persistent metadata validators.

Optional ReadonlyclientOptions

clientOptions?: Omit<HonuaClientOptions, "baseUrl">

Auth, retry, timeout, interceptor, and fetch options for an owned client.

Optional ReadonlycollectionId

collectionId?: string

Restrict discovery to one collection while retaining the service root URL.

Readonlyendpoint

endpoint: string | URL

OGC API, STAC API, WFS 2.0, or canonical GeoServices service/layer URL.

Optional Readonlygeoparquet

geoparquet?: {
    geometryColumn?: string;
    profiler: GeoParquetSourceProfiler;
    urls?: readonly string[];
}

GeoParquet / static-file discovery inputs; required for protocol: "geoparquet".

Type declaration

  • Optional ReadonlygeometryColumn?: string

    Explicit geometry column name (overrides GeoParquet metadata detection).

  • Readonlyprofiler: GeoParquetSourceProfiler

    Footer / geo metadata reader. GeoparquetRuntime (from @honua/sdk-js/geoparquet) satisfies this interface via its profile() method, so one runtime can both discover and execute.

  • Optional Readonlyurls?: readonly string[]

    Additional Parquet files unioned with the endpoint via read_parquet([...]).

Optional Readonlyid

id?: string

Optional dataset id; defaults to the redacted normalized endpoint.

Optional Readonlymetadata

metadata?: Omit<HonuaMetadataRequestOptions, "signal" | "refresh">

Readonlyprotocol

protocol: ConnectProtocolHint

Protocol hint. auto recognizes canonical GeoServices URL structure without probing.

Optional Readonlyrefresh

refresh?: boolean

Skip a caller cache read and revalidate metadata through the protocol adapter.

Optional ReadonlyresolveSource

resolveSource?: SourceResolver

Resolver for descriptors the built-in resolvers do not handle. Required to execute a discovered geoparquet source through connection.source() (pass geoparquetResolver() from @honua/sdk-js/geoparquet); the DuckDB engine must never enter the connect static graph, so it is injected here.

Optional Readonlysignal

signal?: AbortSignal

Optional ReadonlytypeName

typeName?: string

Restrict WFS discovery to one advertised namespace-qualified feature type.

Settings

Member Visibility

On This Page

Properties