@honua/sdk-js
    Preparing search index...

    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;
            };
            PMTiles?: PmtilesModuleLike;
        };
        protocol: ConnectSourceProtocolHint;
        refresh?: boolean;
        resolveSource?: SourceResolver;
        signal?: AbortSignal;
        stac?: StacStaticTraversalOptions;
        styleId?: string;
        tileMatrixSetId?: string;
        typeName?: string;
    }
    Index

    Properties

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

    Properties

    authorizationScopeFingerprint: string

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

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

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

    capabilityPolicy?: DiscoveryCapabilityPolicy
    client?: HonuaClient

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

    clientOptions?: Omit<HonuaClientOptions, "baseUrl">

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

    collectionId?: string

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

    endpoint: string | URL

    OGC API, STAC API, WFS 2.0, WMS/WMTS, or canonical GeoServices URL.

    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([...]).

    id?: string

    Optional dataset id; defaults to the redacted normalized endpoint.

    metadata?: Omit<HonuaMetadataRequestOptions, "signal" | "refresh">
    pmtiles?: {
        limits?: {
            maxDecompressedBytes?: number;
            maxRangeBytes?: number;
            maxRequests?: number;
            maxTotalBytes?: number;
        };
        PMTiles?: PmtilesModuleLike;
    }

    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.

    • Optional ReadonlyPMTiles?: PmtilesModuleLike

      Reader constructor from the app's own pmtiles import. A Vite build does not follow the SDK's non-literal import of that optional peer, so browser discovery passes the constructor it bundled.

    protocol: ConnectSourceProtocolHint

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

    refresh?: boolean

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

    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.

    signal?: AbortSignal
    stac?: StacStaticTraversalOptions

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

    styleId?: string

    Restrict WMS/WMTS discovery to one advertised style.

    tileMatrixSetId?: string

    Restrict WMTS discovery to one advertised tile matrix set.

    typeName?: string

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

    Settings

    Member Visibility

    On This Page

    Properties