Interface ConnectOptions

interface ConnectOptions {
    authorizationScopeFingerprint: string;
    cache?: ConnectDiscoveryCache;
    capabilitiesLimits?: {
        maxBytes?: number;
        timeoutMs?: number;
    };
    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">;
    pmtiles?: {
        limits?: {
            maxDecompressedBytes?: number;
            maxRangeBytes?: number;
            maxRequests?: number;
            maxTotalBytes?: number;
        };
    };
    protocol: ConnectSourceProtocolHint;
    refresh?: boolean;
    resolveSource?: SourceResolver;
    signal?: AbortSignal;
    stac?: StacStaticTraversalOptions;
    styleId?: string;
    tileMatrixSetId?: string;
    typeName?: string;
}

Properties

authorizationScopeFingerprint cache? capabilitiesLimits? capabilityPolicy? client? clientOptions? collectionId? endpoint geoparquet? id? metadata? pmtiles? protocol refresh? resolveSource? signal? stac? styleId? tileMatrixSetId? typeName?

Properties

ReadonlyauthorizationScopeFingerprint

authorizationScopeFingerprint: string

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

Optional Readonlycache

cache?: ConnectDiscoveryCache

Optional ReadonlycapabilitiesLimits

capabilitiesLimits?: {
    maxBytes?: number;
    timeoutMs?: number;
}

Hard bounds for the one capabilities response; caller values may only lower SDK maxima.

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, WMS/WMTS, or canonical GeoServices 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">

Optional Readonlypmtiles

pmtiles?: {
    limits?: {
        maxDecompressedBytes?: number;
        maxRangeBytes?: number;
        maxRequests?: number;
        maxTotalBytes?: number;
    };
}

Bounded direct-PMTiles archive discovery policy.

Type declaration

  • Optional Readonlylimits?: {
        maxDecompressedBytes?: number;
        maxRangeBytes?: number;
        maxRequests?: number;
        maxTotalBytes?: number;
    }
    • Optional ReadonlymaxDecompressedBytes?: number

      Inflated internal directory/metadata bytes; defaults to and cannot exceed 4 MiB.

    • Optional ReadonlymaxRangeBytes?: number

      Bytes in any one range; defaults to and cannot exceed 512 KiB.

    • Optional ReadonlymaxRequests?: number

      Physical HTTP attempts, including retries/auth replays; defaults to and cannot exceed 2.

    • Optional ReadonlymaxTotalBytes?: number

      Reserved bytes across the complete inspection; defaults to and cannot exceed 1 MiB.

Readonlyprotocol

protocol: ConnectSourceProtocolHint

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 Readonlystac

stac?: StacStaticTraversalOptions

Hard-bounded static-STAC traversal/probe policy. Ignored by STAC API discovery.

Optional ReadonlystyleId

styleId?: string

Restrict WMS/WMTS discovery to one advertised style.

Optional ReadonlytileMatrixSetId

tileMatrixSetId?: string

Restrict WMTS discovery to one advertised tile matrix set.

Optional ReadonlytypeName

typeName?: string

Restrict WFS discovery to one feature type or WMS/WMTS discovery to one named layer.

Settings

Member Visibility

On This Page

Properties