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

    Class HonuaWfsFeatureType

    Per-feature-type WFS surface. Implements the wire methods that the canonical wfsSource translates onto, and the protocol escape-hatch methods that ship raw XML payloads back to callers.

    Index

    Constructors

    Properties

    root: HonuaWfs
    typeName: string

    Methods

    • Build (but do not send) the URL the GET GetFeature request would use.

      Parameters

      • params: {
            bbox?: string;
            count?: number;
            filter?: string;
            namespace?: { prefix: string; uri: string };
            outputFormat?: string;
            startIndex?: number;
        }

      Returns string

    • Convenience: capabilities snapshot from the bound root.

      Parameters

      • Optionaloptions: { signal?: AbortSignal }

      Returns Promise<WfsCapabilitiesSnapshot>

    • Raw DescribeFeatureType XSD for the bound type name.

      Parameters

      • Optionaloptions: { signal?: AbortSignal }

      Returns Promise<{ contentType: string; text: string }>

    • Geometry property name of the bound feature type, resolved from DescribeFeatureType and cached on the root. Fails closed when the schema does not name one — see HonuaWfs.geometryPropertyName.

      Parameters

      • Optionaloptions: { signal?: AbortSignal }

      Returns Promise<string>

    • Issue a GetFeature request. Returns parsed JSON when the negotiated output format is JSON; otherwise returns the raw body as a string for downstream callers (the canonical surface throws in that case).

      Parameters

      • params: {
            bbox?: string;
            body?: string;
            count?: number;
            filter?: string;
            method?: "GET" | "POST";
            namespace?: { prefix: string; uri: string };
            outputFormat?: string;
            propertyName?: string[];
            resultType?: "results" | "hits";
            signal?: AbortSignal;
            sortBy?: string;
            srsName?: string;
            startIndex?: number;
        }

      Returns Promise<
          | { contentType: string; data: unknown; kind: "json" }
          | { contentType: string; kind: "raw"; text: string },
      >

    • Issue a GetPropertyValue request. WFS-specific (returns raw XML), so the canonical surface only reaches it via protocol("wfs").

      Parameters

      • params: {
            count?: number;
            filter?: string;
            signal?: AbortSignal;
            startIndex?: number;
            valueReference: string;
        }

      Returns Promise<{ contentType: string; text: string }>

    • Submit a <wfs:Transaction> POST body. Returns the parsed transaction summary; throws HonuaWfsExceptionError on <ows:ExceptionReport>.

      Parameters

      • params: { body: string; signal?: AbortSignal }

      Returns Promise<WfsTransactionSummary>