API Reference

Classes

---

EndpointError

import { EndpointError } from '@camptocamp/ogc-client'

📦 Constructor

        new EndpointError(message: string, httpStatus: number, isCrossOriginRelated: boolean)
      

Parameter	Type	Description
message	string
httpStatus	number
isCrossOriginRelated	boolean

🌱️ Extends

        Error
      

---

NcwmsEndpoint

import { NcwmsEndpoint } from '@camptocamp/ogc-client'

Represents an NcWMS endpoint, a WMS extension for scientific data with additional rendering parameters (color palette, scale range, log scale).

NcWMS is used by servers such as Thredds, ERDDAP, BODC and CMEMS.

📦 Constructor

        new NcwmsEndpoint(url: string)
      

Parameter	Type	Description
url	string

🌱️ Extends

        WmsEndpoint
      

⚡️ Methods

getLayerDetails()

        getLayerDetails(layerName: string): Promise<NcwmsLayerDetails>
      

Parameter	Type	Description
layerName	string	Layer name as declared in GetCapabilities

Return type	Description
Promise<NcwmsLayerDetails>

Fetches NcWMS layer metadata. Returns null if the server does not expose NcWMS-specific metadata for this layer.

getLegendUrl()

        getLegendUrl(layerName: string, options: undefined): string
      

Parameter	Type	Description
layerName	string	Layer name
options		Style and rendering options

Return type	Description
string

Builds a GetLegendGraphic URL for the layer. No network request is made.

getMinMax()

        getMinMax(layerName: string, bbox: BoundingBox, options: undefined): Promise<NcwmsMinMax>
      

Parameter	Type	Description
layerName	string	Layer name
bbox	BoundingBox	Bounding box [west, south, east, north] in CRS:84
options		Optional TIME and ELEVATION values

Return type	Description
Promise<NcwmsMinMax>

Fetches the approximate min/max data range for the given extent. NcWMS computes this from a downsampled GetMap request.

---

OgcApiEndpoint

import { OgcApiEndpoint } from '@camptocamp/ogc-client'

Represents an OGC API endpoint advertising various collections and services.

📦 Constructor

        new OgcApiEndpoint(baseUrl: string)
      

Parameter	Type	Description
baseUrl	string	Base URL used to query the endpoint. Note that this can point to nested documents inside the endpoint, such as /collections, /collections/items etc.

Creates a new OGC API endpoint.

💡 Accessors

Accessor	Type	Description
allCollections	Promise<undefined[]>	A Promise which resolves to an array of all collection identifiers as strings.
conformanceClasses	Promise<string[]>	A Promise which resolves to an array of conformance classes.
edrCollections	Promise<string[]>
featureCollections	Promise<string[]>	A Promise which resolves to an array of feature collection identifiers as strings.
hasEnvironmentalDataRetrieval	Promise<boolean>	A Promise which resolves to a boolean indicating whether the endpoint offers environmental data retrieval (EDR) queries.
hasFeatures	Promise<boolean>	A Promise which resolves to a boolean indicating whether the endpoint offer feature collections.
hasRecords	Promise<boolean>	A Promise which resolves to a boolean indicating whether the endpoint offer record collections.
hasStyles	Promise<boolean>	A Promise which resolves to a boolean indicating whether the endpoint offer styles.
hasTiles	Promise<boolean>	A Promise which resolves to a boolean indicating whether the endpoint offer tiles.
info	Promise<OgcApiEndpointInfo>	A Promise which resolves to the endpoint information.
mapTileCollections	Promise<string[]>	A Promise which resolves to an array of map tile collection identifiers as strings.
recordCollections	Promise<string[]>	A Promise which resolves to an array of records collection identifiers as strings.
tileMatrixSets	Promise<string[]>	Retrieve the tile matrix sets identifiers advertised by the endpoint. Empty if tiles are not supported
vectorTileCollections	Promise<string[]>	A Promise which resolves to an array of vector tile collection identifiers as strings.

⚡️ Methods

allStyles()

        allStyles(collectionId: string): Promise<OgcStyleBrief[]>
      

Parameter	Type	Description
collectionId	string	Optional unique identifier for the collection.

Return type	Description
Promise<OgcStyleBrief[]>

A Promise which resolves to an array of all style items. This includes the supported style formats.

edr()

        edr(collection_id: string): Promise<EDRQueryBuilder>
      

Parameter	Type	Description
collection_id	string

Return type	Description
Promise<EDRQueryBuilder>

getCollectionInfo()

        getCollectionInfo(collectionId: string): Promise<OgcApiCollectionInfo>
      

Parameter	Type	Description
collectionId	string

Return type	Description
Promise<OgcApiCollectionInfo>

Returns a promise resolving to a document describing the specified collection.

getCollectionItem()

        getCollectionItem(collectionId: string, itemId: string): Promise<OgcApiRecord>
      

Parameter	Type	Description
collectionId	string
itemId	string

Return type	Description
Promise<OgcApiRecord>

Returns a promise resolving to a specific item from a collection.

getCollectionItems()

        getCollectionItems(collectionId: string, limit: number, offset: number, skipGeometry: boolean, sortBy: string[], boundingBox: BoundingBox, properties: string[], dateTime: DateTimeParameter, query: string): Promise<OgcApiRecord[]>
      

Parameter	Type	Description
collectionId	string
limit	number
offset	number
skipGeometry	boolean
sortBy	string[]
boundingBox	BoundingBox
properties	string[]
dateTime	DateTimeParameter	See OGC requirement: https://docs.ogc.org/is/17-069r3/17-069r3.html#_parameter_datetime
query	string	Freeform query string appended to the URL when fetching items (will be URL-encoded if necessary)

Return type	Description
Promise<OgcApiRecord[]>

Returns a promise resolving to an array of items from a collection with the given query parameters.

getCollectionItemsUrl()

        getCollectionItemsUrl(collectionId: string, options: undefined): Promise<string>
      

Parameter	Type	Description
collectionId	string	The unique identifier for the collection.
options		An object containing optional parameters: query: Additional query parameters to be included in the URL. asJson: Will query items as GeoJson or JSON-FG if available; takes precedence on outputFormat. outputFormat: The MIME type for the output format. limit: The maximum number of features to include. extent: Bounding box to limit the features. offset: Pagination offset for the returned results. outputCrs: Coordinate Reference System code for the output. extentCrs: Coordinate Reference System code for the bounding box. skipGeometry: whether to include geometry in the response or not sortBy: attributes by which to sort properties: which properties to include in the response. dateTime: Date parameter, either as a Date object or a range object with start and end properties.

Return type	Description
Promise<string>	A promise that resolves to the URL as a string or rejects if an error occurs.

Asynchronously retrieves a URL for the items of a specified collection, with optional query parameters.

getMapTilesetUrl()

        getMapTilesetUrl(collectionId: string, tileMatrixSet: string): Promise<string>
      

Parameter	Type	Description
collectionId	string	The unique identifier for the collection.
tileMatrixSet	string	The identifier of the tile matrix set to use. Default is 'WebMercatorQuad'.

Return type	Description
Promise<string>

Asynchronously retrieves a URL to render a specified collection as map tiles, with a given tile matrix set.

getStyle()

        getStyle(styleId: string, collectionId: string): Promise<OgcStyleFull | OgcStyleBrief>
      

Parameter	Type	Description
styleId	string	The style identifier
collectionId	string	Optional unique identifier for the collection.

Return type	Description
Promise<OgcStyleFull | OgcStyleBrief>

Returns a promise resolving to a document describing the style. Looks for a relation of type "describedby" to fetch metadata. If no relation is found, only basic info will be returned.

getStylesheetUrl()

        getStylesheetUrl(styleId: string, mimeType: string, collectionId: string): Promise<string>
      

Parameter	Type	Description
styleId	string	The style identifier
mimeType	string	Stylesheet MIME type
collectionId	string	Optional unique identifier for the collection.

Return type	Description
Promise<string>

Returns a promise resolving to a stylesheet URL for a given style and type.

getVectorTilesetUrl()

        getVectorTilesetUrl(collectionId: string, tileMatrixSet: string): Promise<string>
      

Parameter	Type	Description
collectionId	string	The unique identifier for the collection.
tileMatrixSet	string	The identifier of the tile matrix set to use. Default is 'WebMercatorQuad'.

Return type	Description
Promise<string>

Asynchronously retrieves a URL to render a specified collection as vector tiles, with a given tile matrix set.

---

ServiceExceptionError

import { ServiceExceptionError } from '@camptocamp/ogc-client'

Representation of an Exception reported by an OWS service

This is usually contained in a ServiceExceptionReport or ExceptionReport document and represented as a ServiceException or Exception element

📦 Constructor

        new ServiceExceptionError(message: string, requestUrl: string, code: string, locator: string, response: XmlDocument)
      

Parameter	Type	Description
message	string	Error message
requestUrl	string	URL which resulted in the ServiceException
code	string	Optional ServiceException code
locator	string	Optional ServiceException locator
response	XmlDocument	Optional response content received

Constructor

🌱️ Extends

        Error
      

---

StacEndpoint

import { StacEndpoint } from '@camptocamp/ogc-client'

Represents a STAC API endpoint for querying collections and items. STAC API is based on OGC API - Features.

📦 Constructor

        new StacEndpoint(baseUrl: string)
      

Parameter	Type	Description
baseUrl	string	Base URL of the STAC API (landing page)

Creates a new STAC API endpoint

💡 Accessors

Accessor	Type	Description
allCollections	Promise<string[]>	Returns array of all collection IDs
catalog	Promise<StacCatalog>	Returns the root catalog
conformanceClasses	Promise<string[]>	Returns array of conformance class URIs
info	Promise<StacEndpointInfo>	Returns endpoint information from the landing page
isStacApi	Promise<boolean>	Checks if the endpoint supports STAC API Core
supportsOgcFeatures	Promise<boolean>	Checks if the endpoint supports OGC API Features

⚡️ Methods

getCollection()

        getCollection(collectionId: string): Promise<StacCollection>
      

Parameter	Type	Description
collectionId	string	The collection identifier

Return type	Description
Promise<StacCollection>	Promise resolving to StacCollection

Retrieves detailed information about a specific collection

getCollectionItem()

        getCollectionItem(collectionId: string, itemId: string): Promise<StacItem>
      

Parameter	Type	Description
collectionId	string	The collection identifier
itemId	string	The item identifier

Return type	Description
Promise<StacItem>	Promise resolving to StacItem

Retrieves a single item from a collection

getCollectionItems()

        getCollectionItems(collectionId: string, options: GetCollectionItemsOptions): Promise<StacItem[]>
      

Parameter	Type	Description
collectionId	string	The collection identifier
options	GetCollectionItemsOptions	Query options (limit, bbox, datetime, etc.)

Return type	Description
Promise<StacItem[]>	Promise resolving to array of StacItem objects

Retrieves items from a collection with optional filtering

getCollectionItemsResponse()

        getCollectionItemsResponse(collectionId: string, options: GetCollectionItemsOptions): Promise<StacItemsDocument>
      

Parameter	Type	Description
collectionId	string	The collection identifier
options	GetCollectionItemsOptions	Query options (limit, bbox, datetime, etc.)

Return type	Description
Promise<StacItemsDocument>	Promise resolving to full StacItemsDocument with links

Retrieves items response document including links for pagination Use this method when you need access to pagination links (rel="next") or metadata

getCollectionItemsUrl()

        getCollectionItemsUrl(collectionId: string, options: GetCollectionItemsOptions): Promise<string>
      

Parameter	Type	Description
collectionId	string	The collection identifier
options	GetCollectionItemsOptions	Query options

Return type	Description
Promise<string>	Promise resolving to the constructed URL

Builds a URL for querying collection items with filters

fromUrl()

        fromUrl(url: string): Promise< |  | >
      

Parameter	Type	Description
url	string	Direct URL to any STAC document

Return type	Description
Promise< | | >	Promise resolving to typed resource with discriminator

Fetches and auto-detects a STAC resource from any URL Automatically detects whether the URL points to a Catalog, Collection, or Item

getItemsFromCollection()

        getItemsFromCollection(collection: StacCollection, options: GetCollectionItemsOptions): Promise<StacItemsDocument>
      

Parameter	Type	Description
collection	StacCollection	StacCollection object
options	GetCollectionItemsOptions	Query options (limit, bbox, datetime, etc.)

Return type	Description
Promise<StacItemsDocument>	Promise resolving to StacItemsDocument with features and pagination links

Queries items from a collection object with optional filtering

getItemsFromUrl()

        getItemsFromUrl(itemsUrl: string, options: GetCollectionItemsOptions): Promise<StacItemsDocument>
      

Parameter	Type	Description
itemsUrl	string	Direct URL to a STAC collection items endpoint
options	GetCollectionItemsOptions	Query options (limit, bbox, datetime, etc.)

Return type	Description
Promise<StacItemsDocument>	Promise resolving to StacItemsDocument with features and pagination links

Queries items from a collection items URL with optional filtering Applies filters directly to the provided items endpoint URL

---

TmsEndpoint

import { TmsEndpoint } from '@camptocamp/ogc-client'

Represents a TMS (Tile Map Service) endpoint for accessing tile map services. Handles fetching and processing TMS data from a given URL.

📦 Constructor

        new TmsEndpoint(baseUrl: string)
      

Parameter	Type	Description
baseUrl	string

💡 Accessors

Accessor	Type	Description
allTileMaps	Promise<TileMapReference[]>	Retrieves all available tile maps from the TMS service. If the endpoint points to a specific tile map, only that tile map will be returned.
tileMapServiceInfo	Promise<TmsEndpointInfo>	Retrieves basic information about the TMS endpoint, including title, abstract, and keywords.

⚡️ Methods

getTileMapInfo()

        getTileMapInfo(href: string): Promise<TileMapInfo>
      

Parameter	Type	Description
href	string	The URL of the tile map resource to retrieve

Return type	Description
Promise<TileMapInfo>	Promise resolving to the detailed tile map information

Retrieves detailed information about a specific tile map.

---

WfsEndpoint

import { WfsEndpoint } from '@camptocamp/ogc-client'

Represents a WFS endpoint advertising several feature types.

Always use the class like so to make sure that all its internals are correctly initialized:

const endpoint = await new WfsEndpoint(url).isReady();

📦 Constructor

        new WfsEndpoint(url: string)
      

Parameter	Type	Description
url	string	WFS endpoint url; can contain any query parameters, these will be used to initialize the endpoint

Creates a new WFS endpoint; wait for the isReady() promise before using the endpoint methods.

⚡️ Methods

getCapabilitiesUrl()

        getCapabilitiesUrl(): string
      

Return type	Description
string

Returns the Capabilities URL of the WFS

This is the URL reported by the service if available, otherwise the URL passed to the constructor

getFeatureTypeFull()

        getFeatureTypeFull(name: string): Promise<WfsFeatureTypeFull>
      

Parameter	Type	Description
name	string	Feature type name property (unique in the WFS service)

Return type	Description
Promise<WfsFeatureTypeFull>	return null if layer was not found or endpoint is not ready

Returns the complete feature type. If a namespace is specified in the name, this will be used for matching; otherwise, matching will be done without taking namespaces into account.

getFeatureTypePropDetails()

        getFeatureTypePropDetails(name: string): Promise<WfsFeatureTypePropsDetails>
      

Parameter	Type	Description
name	string	Feature type name property (unique in the WFS service)

Return type	Description
Promise<WfsFeatureTypePropsDetails>	return null if layer was not found or endpoint is not ready

Returns a promise that will resolve with details on each of the feature type properties; for now, this consists of a list of unique values in the whole dataset.

getFeatureTypes()

        getFeatureTypes(): WfsFeatureTypeBrief[]
      

Return type	Description
WfsFeatureTypeBrief[]

Returns an array of feature types

getFeatureTypeSummary()

        getFeatureTypeSummary(name: string): WfsFeatureTypeSummary
      

Parameter	Type	Description
name	string	Feature type name property (unique in the WFS service)

Return type	Description
WfsFeatureTypeSummary	return null if layer was not found or endpoint is not ready

Returns the feature type in summary format. If a namespace is specified in the name, this will be used for matching; otherwise, matching will be done without taking namespaces into account.

getFeatureUrl()

        getFeatureUrl(featureType: string, options: WfsGetFeatureOptions): string
      

Parameter	Type	Description
featureType	string
options	WfsGetFeatureOptions

Return type	Description
string	Returns null if endpoint is not ready

Returns a URL that can be used to query features from this feature type.

getOperationUrl()

        getOperationUrl(operationName: string, method: HttpMethod): string
      

Parameter	Type	Description
operationName	string	e.g. GetFeature, GetCapabilities, etc.
method	HttpMethod	HTTP method

Return type	Description
string

Returns the URL reported by the WFS for the given operation

getServiceInfo()

        getServiceInfo(): GenericEndpointInfo
      

Return type	Description
GenericEndpointInfo

A Promise which resolves to the endpoint information.

getSingleFeatureTypeName()

        getSingleFeatureTypeName(): string
      

Return type	Description
string

If only one single feature type is available, return its name; otherwise, returns null;

getVersion()

        getVersion(): WfsVersion
      

Return type	Description
WfsVersion

Returns the highest protocol version that this WFS endpoint supports. Note that if the url used for initialization does specify a version (e.g. 1.0.0), this version will most likely be used instead of the highest supported one.

isReady()

        isReady(): Promise<WfsEndpoint>
      

Return type	Description
Promise<WfsEndpoint>

This should be called before any other method to initialize the endpoint!

Resolves when the endpoint is ready to use. Returns the same endpoint object for convenience.

supportsJson()

        supportsJson(featureType: string): boolean
      

Parameter	Type	Description
featureType	string

Return type	Description
boolean

Returns true if the given feature type can be downloaded as GeoJSON

supportsStartIndex()

        supportsStartIndex(): boolean
      

Return type	Description
boolean

Returns true if the WFS service supports the startIndex parameter.

---

WmsEndpoint

import { WmsEndpoint } from '@camptocamp/ogc-client'

Represents a WMS endpoint advertising several layers arranged in a tree structure.

Always use the class like so to make sure that all its internals are correctly initialized:

const endpoint = await new WmsEndpoint(url).isReady();

📦 Constructor

        new WmsEndpoint(url: string)
      

Parameter	Type	Description
url	string	WMS endpoint url; can contain any query parameters, these will be used to initialize the endpoint

⚡️ Methods

describeLayer()

        describeLayer(layerName: string): Promise<WmsLayerDescription>
      

Parameter	Type	Description
layerName	string	Layer name to describe

Return type	Description
Promise<WmsLayerDescription>	Returns null if the endpoint is not ready or does not advertise DescribeLayer

Performs a DescribeLayer request for the given layer and returns its description, including the underlying OWS type (e.g. "WFS" for vector data).

getCapabilitiesUrl()

        getCapabilitiesUrl(): string
      

Return type	Description
string

Returns the Capabilities URL of the WMS

This is the URL reported by the service if available, otherwise the URL passed to the constructor

getFlattenedLayers()

        getFlattenedLayers(): any[]
      

Return type	Description
any[]

Returns a array of layers, same as WmsEndpoint.getLayers(), but flattened

getLayerByName()

        getLayerByName(name: string): WmsLayerFull
      

Parameter	Type	Description
name	string	Layer name property (unique in the WMS service)

Return type	Description
WmsLayerFull	return null if layer was not found

Returns the full layer information, including supported coordinate systems, available layers, bounding boxes etc. Layer name is case-sensitive.

getLayers()

        getLayers(): WmsLayerSummary[]
      

Return type	Description
WmsLayerSummary[]

Returns an array of layers in summary format; layers are organized in a tree structure with each having an optional children property

getMapUrl()

        getMapUrl(layers: string[], options: undefined): string
      

Parameter	Type	Description
layers	string[]	List of layers to render
options

Return type	Description
string	Returns null if endpoint is not ready

Returns a URL that can be used to query an image from one or several layers

getOperationUrl()

        getOperationUrl(operationName: string, method: HttpMethod): string
      

Parameter	Type	Description
operationName	string	e.g. GetMap, GetCapabilities, etc.
method	HttpMethod	HTTP method

Return type	Description
string

Returns the URL reported by the WMS for the given operation

getServiceInfo()

        getServiceInfo(): GenericEndpointInfo
      

Return type	Description
GenericEndpointInfo

Returns the service information.

getSingleLayerName()

        getSingleLayerName(): string
      

Return type	Description
string

If only one single renderable layer is available, return its name; otherwise, returns null;

getVersion()

        getVersion(): WmsVersion
      

Return type	Description
WmsVersion

Returns the highest protocol version that this WMS endpoint supports. Note that if the url used for initialization does specify a version (e.g. 1.1.0), this version will most likely be used instead of the highest supported one.

isReady()

        isReady(): Promise<WmsEndpoint>
      

Return type	Description
Promise<WmsEndpoint>

This should be called before any other method to initialize the endpoint!

Resolves when the endpoint is ready to use. Returns the same endpoint object for convenience.

---

WmtsEndpoint

import { WmtsEndpoint } from '@camptocamp/ogc-client'

Represents a WMTS endpoint advertising several layers.

Always use the class like so to make sure that all its internals are correctly initialized:

const endpoint = await new WmtsEndpoint(url).isReady();

📦 Constructor

        new WmtsEndpoint(url: string)
      

Parameter	Type	Description
url	string	WMTS endpoint url; can contain any query parameters, these will be used to initialize the endpoint

Creates a new WMTS endpoint; wait for the isReady() promise before using the endpoint methods.

⚡️ Methods

getDefaultDimensions()

        getDefaultDimensions(layerName: string): Record<string, WmtsLayerDimensionValue>
      

Parameter	Type	Description
layerName	string

Return type	Description
Record<string, WmtsLayerDimensionValue>

Return an object with all defined dimensions for the layer, as well as their default values.

getLayerByName()

        getLayerByName(name: string): WmtsLayer
      

Parameter	Type	Description
name	string	Layer name property

Return type	Description
WmtsLayer	return null if layer was not found

Returns a complete layer based on its name Note: the first matching layer will be returned

getLayerResourceLink()

        getLayerResourceLink(layerName: string, formatHint: string): WmtsLayerResourceLink
      

Parameter	Type	Description
layerName	string
formatHint	string

Return type	Description
WmtsLayerResourceLink

Returns a layer resource link. If no type hint is specified, the first resource will be returned. A resource link contains a URL as well as an image format and a request encoding (KVP or REST).

getLayers()

        getLayers(): WmtsLayer[]
      

Return type	Description
WmtsLayer[]

Returns the layers advertised in the endpoint.

getMatrixSetByIdentifier()

        getMatrixSetByIdentifier(identifier: string): WmtsMatrixSet
      

Parameter	Type	Description
identifier	string	Matrix set identifier

Return type	Description
WmtsMatrixSet	return null if matrix set was not found

Returns a matrix set by identifier

getMatrixSets()

        getMatrixSets(): WmtsMatrixSet[]
      

Return type	Description
WmtsMatrixSet[]

Returns the matrix sets available for that endpoint. Each matrix set contains a list of tile matrices as well as a supported CRS.

getOpenLayersTileGrid()

        getOpenLayersTileGrid(layerName: string, matrixSetIdentifier: string): Promise<WMTSTileGrid>
      

Parameter	Type	Description
layerName	string
matrixSetIdentifier	string

Return type	Description
Promise<WMTSTileGrid>

Creates a WMTSTileGrid instance from the 'ol' package, for a given layer. Optionally, a matrix set can be provided;

getServiceInfo()

        getServiceInfo(): WmtsEndpointInfo
      

Return type	Description
WmtsEndpointInfo

A Promise which resolves to the endpoint information.

getSingleLayerName()

        getSingleLayerName(): string
      

Return type	Description
string

If only one single layer is available, return its name; otherwise, returns null;

getTileUrl()

        getTileUrl(layerName: string, styleName: string, matrixSetName: string, tileMatrix: string, tileRow: number, tileCol: number, outputFormat: string): string
      

Parameter	Type	Description
layerName	string
styleName	string
matrixSetName	string
tileMatrix	string
tileRow	number
tileCol	number
outputFormat	string

Return type	Description
string

Generates a URL for a specific tile of a specific layer

isReady()

        isReady(): Promise<WmtsEndpoint>
      

Return type	Description
Promise<WmtsEndpoint>

This should be called before any other method to initialize the endpoint!

Resolves when the endpoint is ready to use. Returns the same endpoint object for convenience.

---

WpsEndpoint

import { WpsEndpoint } from '@camptocamp/ogc-client'

Represents a WPS endpoint advertising a set of processes.

Please note that for now, only WPS version 1.0.0 is supported!

Always use the class like so to make sure that all its internals are correctly initialized:

const endpoint = await new WpsEndpoint(url).isReady();

📦 Constructor

        new WpsEndpoint(url: string)
      

Parameter	Type	Description
url	string	WPS endpoint url; can contain any query parameters, these will be used to initialize the endpoint

⚡️ Methods

describeProcess()

        describeProcess(processId: string): Promise<WpsProcessFull>
      

Parameter	Type	Description
processId	string	Process identifier to describe

Return type	Description
Promise<WpsProcessFull>

Performs a DescribeProcess request for the given process and returns its full description (inputs, outputs, supported formats).

execute()

        execute(processId: string, options: WpsExecuteOptions): Promise<WpsExecuteResponse>
      

Parameter	Type	Description
processId	string	Process identifier to execute
options	WpsExecuteOptions	Execution options (inputs, outputs, response form flags)

Return type	Description
Promise<WpsExecuteResponse>

Executes a process (POST XML). Fetches the process description first in order to type the inputs.

getCapabilitiesUrl()

        getCapabilitiesUrl(): string
      

Return type	Description
string

Returns the Capabilities URL used to initialize the endpoint.

getOperationUrl()

        getOperationUrl(operationName: string, method: HttpMethod): string
      

Parameter	Type	Description
operationName	string	e.g. Execute, DescribeProcess, GetCapabilities
method	HttpMethod	HTTP method

Return type	Description
string

Returns the URL reported by the WPS for the given operation

getProcesses()

        getProcesses(): WpsProcessSummary[]
      

Return type	Description
WpsProcessSummary[]

Returns an array of processes advertised by the service, in summary format.

getProcessSummary()

        getProcessSummary(processId: string): WpsProcessSummary
      

Parameter	Type	Description
processId	string

Return type	Description
WpsProcessSummary

Returns the summary of a process by its identifier, or null if not found.

getServiceInfo()

        getServiceInfo(): GenericEndpointInfo
      

Return type	Description
GenericEndpointInfo

Returns the service information.

getStatus()

        getStatus(statusLocation: string): Promise<WpsExecuteResponse>
      

Parameter	Type	Description
statusLocation	string	The statusLocation URL returned by execute()

Return type	Description
Promise<WpsExecuteResponse>

Polls the status of an asynchronous execution.

getVersion()

        getVersion(): '1.0.0'
      

Return type	Description
'1.0.0'

Returns the WPS version advertised by this endpoint.

isReady()

        isReady(): Promise<WpsEndpoint>
      

Return type	Description
Promise<WpsEndpoint>

This should be called before any other method to initialize the endpoint!

Resolves when the endpoint is ready to use. Returns the same endpoint object for convenience.

Functions

---

check()

import { check } from '@camptocamp/ogc-client'

        check(response: XmlDocument, url: string): XmlDocument
      

Parameter	Type	Description
response	XmlDocument	Response to check
url	string	URL from which response was generated

Return type	Description
XmlDocument

Check the response for a ServiceExceptionReport and if present throw one

---

clearCache()

import { clearCache } from '@camptocamp/ogc-client'

        clearCache(): Promise<void>
      

Return type	Description
Promise<void>

Remove all cache entries; will not prevent the creation of new ones

---

enableFallbackWithoutWorker()

import { enableFallbackWithoutWorker } from '@camptocamp/ogc-client'

        enableFallbackWithoutWorker(): void
      

Return type	Description
void

Call once to disable Worker usage completely

---

expandDimensionValues()

import { expandDimensionValues } from '@camptocamp/ogc-client'

        expandDimensionValues(dim: WmsLayerDimension, max: number): Date[]
      

Parameter	Type	Description
dim	WmsLayerDimension
max	number

Return type	Description
Date[]

Expand a dimension's values into Date objects. Each entry is either a single ISO datetime or an interval "start/end/period". Interval entries are enumerated by their period; capped at max entries (default 3650) to avoid runaway expansion on dense series.

---

getCacheExpiryDuration()

import { getCacheExpiryDuration } from '@camptocamp/ogc-client'

        getCacheExpiryDuration(): number
      

Return type	Description
number

Returns the current cache expiry duration in ms

---

getDimensionDefaultValue()

import { getDimensionDefaultValue } from '@camptocamp/ogc-client'

        getDimensionDefaultValue(dim: WmsLayerDimension): string
      

Parameter	Type	Description
dim	WmsLayerDimension

Return type	Description
string

Resolve the value a dimension should default to: the server's declared default, otherwise the start of the first available value (an interval value is expressed as "start/end/period"). Returns null if none is available.

---

parseIso8601Duration()

import { parseIso8601Duration } from '@camptocamp/ogc-client'

        parseIso8601Duration(duration: string): Iso8601Duration
      

Parameter	Type	Description
duration	string

Return type	Description
Iso8601Duration

Parse an ISO 8601 duration (e.g. "P1Y", "P1M", "P1D", "PT1H", "PT30M"). Returns null for an unparseable duration. Years and months are kept separate from the fixed-length fields because they are not constant-length and must be applied by calendar arithmetic (see expandDimensionValues).

---

parseIso8601DurationMs()

import { parseIso8601DurationMs } from '@camptocamp/ogc-client'

        parseIso8601DurationMs(duration: string): number
      

Parameter	Type	Description
duration	string

Return type	Description
number

Parse an ISO 8601 duration into milliseconds. Years and months use civil averages (365.25d / 30.44d) and so are approximate; for exact calendar stepping use parseIso8601Duration + advanceByDuration. Returns 0 when unparseable.

---

postXmlDocument()

import { postXmlDocument } from '@camptocamp/ogc-client'

        postXmlDocument(url: string, body: string): Promise<XmlDocument>
      

Parameter	Type	Description
url	string
body	string

Return type	Description
Promise<XmlDocument>

Runs a POST HTTP request with an XML body to the provided URL and resolves to the XmlDocument. Unlike queryXmlDocument, this is not guarded against concurrent identical requests (POST is not idempotent) and does not go through sharedFetch.

---

resetFetchOptions()

import { resetFetchOptions } from '@camptocamp/ogc-client'

        resetFetchOptions(): void
      

Return type	Description
void

Resets advanced fetch() options to their defaults

---

setCacheExpiryDuration()

import { setCacheExpiryDuration } from '@camptocamp/ogc-client'

        setCacheExpiryDuration(value: number): void
      

Parameter	Type	Description
value	number	Duration in ms

Return type	Description
void

Sets a new cache expiry duration, in ms. Setting this to a value <= 0 will disable the caching logic altogether and not store cache entries at all

---

setFetchOptions()

import { setFetchOptions } from '@camptocamp/ogc-client'

        setFetchOptions(options: FetchOptions): void
      

Parameter	Type	Description
options	FetchOptions

Return type	Description
void

Set advanced options to be used by all fetch() calls

---

sharedFetch()

import { sharedFetch } from '@camptocamp/ogc-client'

        sharedFetch(url: string, method: 'GET' | 'HEAD', asJson: boolean, customAcceptHeader: string): Promise<any>
      

Parameter	Type	Description
url	string
method	'GET' | 'HEAD'
asJson	boolean
customAcceptHeader	string

Return type	Description
Promise<any>

Returns a promise equivalent to fetch(url) but guarded against identical concurrent requests Note: this should only be used for GET requests!

---

useCache()

import { useCache } from '@camptocamp/ogc-client'

        useCache(factory: () => T | Promise<T>, ...keys: string[]): Promise<T>
      

Parameter	Type	Description
factory	() => T | Promise<T>	A function encapsulating the long/expensive task; non-serializable properties of the returned object will be set to null
keys	string[]	Keys will be concatenated for storage

Return type	Description
Promise<T>	Resolves to either a cached object or a fresh one

This will skip a long/expensive task and use a cached value if available, otherwise the task will be run normally Note: outside of a browser's main thread, caching will never happen!

Types

---

Address

Property	Type	Description
administrativeArea	string
city	string
country	string
deliveryPoint	string
postalCode	string

---

Attribution

Property	Type	Description
logo
title	string

---

CollectionParameter

Property	Type	Description
name	string
title	string
type	'string' | 'number' | 'integer' | 'date' | 'linestring' | 'polygon' | 'point' | 'geometry'

---

CommonMetadata

Property	Type	Description
constellation	string	Name of the constellation to which the platform belongs
created	string	Creation date and time in UTC (ISO 8601)
description	string	Detailed description using CommonMark syntax
gsd	number	Ground Sample Distance in meters
instruments	string[]	List of instrument names
keywords	string[]	List of keywords describing the entity
license	string	SPDX License identifier, SPDX expression, or 'other'
mission	string	Name of the mission or campaign
platform	string	Unique name of the platform (satellite, aircraft, etc.)
providers	StacProvider[]	Organizations or individuals who captured, processed, or hosted the data
title	string	Human-readable title
updated	string	Last update date and time in UTC (ISO 8601)

---

Contact

Property	Type	Description
address	Address
email	string
fax	string
name	string
organization	string
phone	string
position	string

---

ContactInformation

Property	Type	Description
contactAddress
contactElectronicMailAddress	string
contactFacsimileTelephone	string
contactPersonPrimary
contactPosition	string
contactVoiceTelephone	string

---

FetchOptions

Property	Type	Description
credentials	'same-origin' | 'include' | 'omit'
headers	Record<string, string>
integrity	string
mode	'same-origin' | 'cors' | 'no-cors'
redirect	'error' | 'follow'
referrer	string

---

GetCollectionItemsOptions

Property	Type	Description
bbox	BoundingBox	Bounding box to filter items [minx, miny, maxx, maxy]
datetime	DateTimeParameter	Date/time filter
limit	number	Maximum number of items to return
query	string	Additional query string to append to the URL

---

LayerStyle

Property	Type	Description
abstract	string
legendUrl	string	May not be defined; a GetLegendGraphic operation should work in any case
name	string
title	string

---

Metadata

Property	Type	Description
href	string
mimeType	string
type	string

---

NcwmsLayerDetails

Property	Type	Description
bbox	BoundingBox
defaultPalette	string
palettes	string[]
scaleRange	[number, number]
supportedStyles	string[]
units	string

---

NcwmsMinMax

Property	Type	Description
max	number
min	number

---

OgcApiCollectionInfo

Property	Type	Description
bulkDownloadLinks	Record<string, MimeType>	Map between formats and bulk download links (no filtering, pagination etc.)
crs	string[]
data_queries
description	string
extent	BoundingBox
id	string
itemCount	number
itemFormats	string[]	These mime types are available through the /items endpoint; use the getCollectionItemsUrl function to generate a URL using one of those formats
itemType	'feature' | 'record'
jsonDownloadLink	string	Link to the first bulk download link using JSON-FG or GeoJSON; null if no link found
keywords	string[]
language	string	Language is Iso 2-letter code (e.g. 'en')
license	string
links	any
mapTileFormats	string[]
parameter_names	Record<string, EdrParameterInfo>
publisher
queryables	CollectionParameter[]
sortables	CollectionParameter[]
storageCrs	string
supportedTileMatrixSets	string[]
title	string
updated	Date
vectorTileFormats	string[]

---

OgcApiDocumentLink

Property	Type	Description
href	string
rel	string
title	string
type	string

---

OgcApiEndpointInfo

Property	Type	Description
attribution	string
description	string
title	string

---

OgcApiRecordContact

Property	Type	Description
contactInstructions	string
links	OgcApiDocumentLink[]
name	string
roles	string[]

---

OgcApiRecordLanguage

Property	Type	Description
alternate	string
code	string
dir	'ltr' | 'rtl' | 'ttb' | 'btt'
name	string

---

OgcApiRecordProperties

Property	Type	Description
contacts	OgcApiRecordContact[]
created	Date
description	string
externalIds	OgcApiItemExternalId[]
formats	string[]
keywords	string[]
language	OgcApiRecordLanguage
languages	OgcApiRecordLanguage[]
license	string
providers	string[]
resourceLanguages	OgcApiRecordLanguage[]
rights	string
themes	OgcApiRecordTheme[]
title	string
type	string
updated	Date

---

Origin

Property	Type	Description
x	number
y	number

---

Provider

Property	Type	Description
contact	Contact
name	string
site	string

---

StacAsset

Property	Type	Description
bands	StacBand[]	Information about bands in the asset
constellation	string	Name of the constellation to which the platform belongs
created	string	Creation date and time in UTC (ISO 8601)
data_type	string	Data type of the values (e.g., uint8, float32)
description	string	Description of the asset
gsd	number	Ground Sample Distance in meters
href	string	URI to the asset object (required)
instruments	string[]	List of instrument names
keywords	string[]	List of keywords describing the entity
license	string	SPDX License identifier, SPDX expression, or 'other'
mission	string	Name of the mission or campaign
nodata	string | number	Value representing no data or invalid data
platform	string	Unique name of the platform (satellite, aircraft, etc.)
providers	StacProvider[]	Organizations or individuals who captured, processed, or hosted the data
roles	string[]	Semantic roles of the asset
statistics	StacStatistics	Statistics about data values
title	string	Human-readable title
type	string	Media type of the asset
unit	string	Unit of measurement (UCUM or UDUNITS-2)
updated	string	Last update date and time in UTC (ISO 8601)

---

StacBand

Property	Type	Description
center_wavelength	number	Center wavelength of the band in micrometers
description	string	Description of the band using CommonMark syntax
full_width_half_max	number	Full width at half maximum of the band in micrometers
name	string	Name of the band

---

StacCatalog

Property	Type	Description
description	string	Detailed description
id	string	Identifier for the catalog
links	StacLink[]	Links to related resources
stac_extensions	string[]	List of extension identifiers
stac_version	'1.0.0'	STAC version
title	string	Human-readable title
type	'Catalog'	Type must be "Catalog"

---

StacCollection

Property	Type	Description
assets	Record<string, StacAsset>	Dictionary of asset objects (at collection level)
description	string	Detailed description
extent	StacExtent	Spatial and temporal extents
id	string	Identifier for the collection
keywords	string[]	List of keywords
license	string	Collection license (SPDX identifier or 'other')
links	StacLink[]	Links to related resources
properties	Partial	Common metadata inherited by all items
providers	StacProvider[]	Organizations or individuals who provided the data
stac_extensions	string[]	List of extension identifiers
stac_version	'1.0.0'	STAC version
summaries	Record<string, unknown>	Summaries of properties across all items in the collection
title	string	Human-readable title
type	'Collection'	Type must be "Collection"

---

StacEndpointInfo

Property	Type	Description
conformsTo	string[]
description	string
id	string
stacVersion	string
title	string

---

StacExtent

Property	Type	Description
spatial	StacSpatialExtent	Spatial extent
temporal	StacTemporalExtent	Temporal extent

---

StacItem

Property	Type	Description
assets	Record<string, StacAsset>	Dictionary of asset objects (optional - some APIs may omit)
bbox	StacBBox	Bounding box (required if geometry is not null)
collection	string	Collection ID (required if a "collection" link exists)
geometry	Geometry	GeoJSON Geometry object or null
id	string	Provider identifier (unique within the collection)
links	StacLink[]	Links to related resources
properties	StacItemProperties	Properties object containing metadata
stac_extensions	string[]	List of extension identifiers
stac_version	'1.0.0'	STAC version (optional - may be inherited from collection/API level)
type	'Feature'	Type must be "Feature" (from GeoJSON)

---

StacItemProperties

Property	Type	Description
constellation	string	Name of the constellation to which the platform belongs
created	string	Creation date and time in UTC (ISO 8601)
datetime	string	Date and time in UTC (ISO 8601) Either datetime OR both start_datetime and end_datetime are required
description	string	Detailed description using CommonMark syntax
end_datetime	string	End date and time for a time range in UTC (ISO 8601)
gsd	number	Ground Sample Distance in meters
instruments	string[]	List of instrument names
keywords	string[]	List of keywords describing the entity
license	string	SPDX License identifier, SPDX expression, or 'other'
mission	string	Name of the mission or campaign
platform	string	Unique name of the platform (satellite, aircraft, etc.)
providers	StacProvider[]	Organizations or individuals who captured, processed, or hosted the data
start_datetime	string	Start date and time for a time range in UTC (ISO 8601)
title	string	Human-readable title
updated	string	Last update date and time in UTC (ISO 8601)

---

StacItemsDocument

Property	Type	Description
features	StacItem[]
links	undefined[]
numberMatched	number
numberReturned	number
type	'FeatureCollection'

---

StacLink

Property	Type	Description
body	unknown	Request body for POST requests
headers	Record<string, string | string[]>	Additional headers to include in the request
href	string	URI or URL to the linked resource
method	string	HTTP method for the request (default: GET)
rel	string	Relationship type
title	string	Human-readable title for the link
type	string	Media type of the linked resource

---

StacProvider

Property	Type	Description
description	string	Description of what the provider does
name	string	Name of the organization or individual
roles	'producer' | 'licensor' | 'processor' | 'host'[]	Roles of the provider (producer, licensor, processor, host)
url	string	Homepage URL

---

StacSpatialExtent

Property	Type	Description
bbox	StacBBox[]	Array of bounding boxes (at least one required)

---

StacStatistics

Property	Type	Description
count	number	Number of values used for statistics
maximum	number	Maximum value
mean	number	Mean value
minimum	number	Minimum value
stddev	number	Standard deviation

---

StacTemporalExtent

Property	Type	Description
interval	[string, string][]	Array of time intervals, each with start and end times (ISO 8601) null indicates open-ended interval

---

TileFormat

Property	Type	Description
extension	string
height	number
mimeType	string
width	number

---

TileMapInfo

Property	Type	Description
abstract	string
attribution	Attribution
boundingBox	BoundingBox
face	number
keywords	string[]
metadata	Metadata[]
origin	Origin
profile	TmsProfile
srs	string
tileFormat	TileFormat
tileMapService	string
tileSets	TileSet[]
title	string
version	string
webMapContext	string

---

TileMapReference

Property	Type	Description
href	string
profile	TmsProfile
srs	string
title	string

---

TileMapService

Property	Type	Description
abstract	string
contactInformation	ContactInformation
keywords	string[]
services	string
tileMaps	TileMapReference[]
title	string
version	string

---

TileMatrixSet

Property	Type	Description
id	string
uri	string

---

TileSet

Property	Type	Description
href	string
maxcol	number
maxrow	number
mincol	number
minrow	number
order	number
unitsPerPixel	number

---

TmsEndpointInfo

Property	Type	Description
abstract	string
contact	ContactInformation
keywords	string[]
title	string

---

WmtsEndpointInfo

Property	Type	Description
abstract	string
constraints	string
exceptionFormats	string[]	Contains a list of formats that can be used for Exceptions for WMS GetMap, or undefined for other services such as WFS
fees	string
getTileUrls
infoFormats	string[]	Contains a list of formats that can be used for WMS GetFeatureInfo, or undefined for other services such as WFS
keywords	string[]
name	string
outputFormats	string[]	Can contain the list of outputFormats from a WFS GetCapabilities, or the list of 'Formats' from a WMS GetCapabilities
provider	Provider
title	string

---

WmtsLayer

Property	Type	Description
defaultStyle	string
dimensions	LayerDimension[]
latLonBoundingBox	BoundingBox
matrixSets	MatrixSetLink[]
name	string
resourceLinks	WmtsLayerResourceLink[]
styles	LayerStyle[]

---

WmtsLayerResourceLink

Property	Type	Description
encoding	WmtsRequestEncoding
format	string
url	string

---

WmtsMatrixSet

Property	Type	Description
boundingBox	BoundingBox
crs	string
identifier	string
tileMatrices	TileMatrix[]
wellKnownScaleSet	string

---

WpsBoundingBoxData

Property	Type	Description
defaultCrs	string
supportedCrs	string[]

---

WpsComplexData

Property	Type	Description
default	WpsFormat
maximumMegabytes	number
supported	WpsFormat[]

---

WpsExecuteOptions

Property	Type	Description
inputs	WpsInputValue[]
lineage	boolean
outputs	WpsOutputSelection[]
status	boolean
storeExecuteResponse	boolean

---

WpsExecuteOutputResult

Property	Type	Description
data
identifier	string
reference
title	string

---

WpsExecuteResponse

Property	Type	Description
outputs	WpsExecuteOutputResult[]
percentCompleted	number
status	WpsExecuteStatus
statusLocation	string

---

WpsFormat

Property	Type	Description
encoding	string
mimeType	string
schema	string

---

WpsInputValue

Property	Type	Description
boundingBoxValue
complexValue		Complex content, e.g. GML/GeoJSON/WKT. The content is inserted raw when the mimeType denotes XML (GML), otherwise it is wrapped in CDATA.
identifier	string
literalValue	string

---

WpsLiteralData

Property	Type	Description
allowedValues	string[]
anyValue	boolean
dataType	string
defaultValue	string

---

WpsOutputSelection

Property	Type	Description
asReference	boolean
identifier	string
mimeType	string

---

WpsProcessFull

Property	Type	Description
abstract	string
identifier	string
inputs	WpsProcessInput[]
outputs	WpsProcessOutput[]
processVersion	string
statusSupported	boolean
storeSupported	boolean
title	string

---

WpsProcessInput

Property	Type	Description
abstract	string
boundingBoxData	WpsBoundingBoxData
complexData	WpsComplexData
identifier	string
literalData	WpsLiteralData
maxOccurs	number
minOccurs	number
title	string
type	WpsInputType

---

WpsProcessOutput

Property	Type	Description
abstract	string
complexData	WpsComplexData
identifier	string
literalData
title	string
type	WpsInputType

---

WpsProcessSummary

Property	Type	Description
abstract	string
identifier	string
processVersion	string
title	string

---

BoundingBox

        [number, number, number, number]
      

---

CollectionParameterType

        [object Object][number]
      

---

ConformanceClass

        string
      

---

CrsCode

        string
      

---

DataQueryType

        [object Object][number]
      

---

EdrParameterInfo

Property	Type	Description
id	string
name	string
observedProperty
type	string
unit

---

FeatureGeometryType

        'linestring' | 'polygon' | 'point' | 'multilinestring' | 'multipolygon' | 'multipoint' | 'unknown'
      

---

FeaturePropertyType

        'string' | 'float' | 'integer' | 'boolean' | 'date'
      

---

FeaturePropertyValue

        string | number | boolean | Date
      

---

GenericEndpointInfo

Property	Type	Description
abstract	string
constraints	string
exceptionFormats	MimeType[] | string[]	Contains a list of formats that can be used for Exceptions for WMS GetMap, or undefined for other services such as WFS
fees	string
infoFormats	MimeType[]	Contains a list of formats that can be used for WMS GetFeatureInfo, or undefined for other services such as WFS
keywords	string[]
name	string
outputFormats	MimeType[]	Can contain the list of outputFormats from a WFS GetCapabilities, or the list of 'Formats' from a WMS GetCapabilities
provider	Provider
title	string

---

MetadataURL

Property	Type	Description
format	string
type	string
url	string

---

MimeType

        string
      

---

OgcApiCollectionItem

        OgcApiRecord
      

---

OgcApiDocument

         & Record<string, unknown>
      

---

OgcApiRecord

Property	Type	Description
conformsTo	string[]
geometry	Geometry
id	string
links	OgcApiDocumentLink[]
properties	OgcApiRecordProperties
time	OgcApiTime
type	string

---

OgcApiStyleMetadata

Property	Type	Description
created	string
description	string
id	string
keywords	string[]
layers	undefined[]
license	string
links	OgcApiDocumentLink[]
pointOfContact	string
scope	'style'
stylesheets	OgcApiStylesheet[]
title	string
updated	string
version	string

---

OgcApiStyleRecord

Property	Type	Description
id	string
title	string

---

OgcApiStylesDocument

Property	Type	Description
links	OgcApiDocumentLink[]
styles	StyleItem[]

---

OgcApiStylesheet

Property	Type	Description
link	OgcApiDocumentLink
native	boolean
specification	string
title	string
version	string

---

OgcStyleBrief

Property	Type	Description
formats	string[]
id	string
title	string

---

OgcStyleFull

         & OgcApiStyleMetadata
      

---

StacBBox

        [number, number, number, number] | [number, number, number, number, number, number]
      

---

StacVersion

        '1.0.0'
      

---

StyleItem

Property	Type	Description
formats	string[]
id	string
links	OgcApiDocumentLink[]
title	string

---

TmsProfile

        'none' | 'global-geodetic' | 'global-mercator' | 'local'
      

---

WfsFeatureTypeBrief

Property	Type	Description
abstract	string
boundingBox	BoundingBox	Expressed in latitudes and longitudes
name	string
title	string

---

WfsFeatureTypeFull

Property	Type	Description
abstract	string
boundingBox	BoundingBox	Expressed in latitudes and longitudes
defaultCrs	CrsCode
geometryName	string	Not defined if no geometry present
geometryType	FeatureGeometryType	Not defined if no geometry present
keywords	string[]
name	string
objectCount	number	Not defined if object count could not be determined
otherCrs	CrsCode[]
outputFormats	MimeType[]
properties	Record<string, FeaturePropertyType>	These properties will not include the feature geometry
title	string

---

WfsFeatureTypePropDetails

        void
      

---

WfsFeatureTypePropsDetails

        Record<string, WfsFeatureTypePropDetails>
      

---

WfsFeatureTypeSummary

Property	Type	Description
abstract	string
boundingBox	BoundingBox	Expressed in latitudes and longitudes
defaultCrs	CrsCode
keywords	string[]
metadata	MetadataURL[]
name	string
otherCrs	CrsCode[]
outputFormats	MimeType[]
title	string

---

WfsFeatureTypeUniqueValue

Property	Type	Description
count	number
value	number | boolean | string

---

WfsFeatureWithProps

Property	Type	Description
id	string	Feature id
properties	Record<string, FeaturePropertyValue>	Feature properties

---

WfsGetFeatureOptions

Property	Type	Description
asJson	boolean	if true, will ask for GeoJSON; will throw if the service does not support it
attributes	string[]	if not defined, all attributes will be included; note that the fact that these attributes exist or not will not be checked!
extent	BoundingBox	an extent to restrict returned objects
extentCrs	CrsCode	if unspecified, extent should be in the data native projection
hitsOnly	boolean	if true, will not return feature data, only hit count note: this might not work for WFS version < 2
maxFeatures	number	No limit if undefined
outputCrs	CrsCode	if unspecified, this will be the data native projection
outputFormat	MimeType	a supported output format (overridden by asJson)
sortBy	FieldSort | FieldSort[]	attributes to sort by on, by either ascending or descending order
startIndex	number	if the service supports it, this will be the index of the first feature to return

---

WfsVersion

        '1.0.0' | '1.1.0' | '2.0.0'
      

---

WmsLayerAttribution

Property	Type	Description
logoUrl	string
title	string
url	string

---

WmsLayerDescription

Property	Type	Description
layerName	string
owsType	'wcs' | 'wfs'
owsUrl	string
typeName	string

---

WmsLayerDimension

Property	Type	Description
current	boolean
defaultValue	string
multipleValues	boolean
name	string
nearestValue	boolean
units	string
unitSymbol	string
values	string[]

---

WmsLayerFull

Property	Type	Description
abstract	string
attribution	WmsLayerAttribution
availableCrs	CrsCode[]
boundingBoxes	Record<CrsCode, BoundingBox>	Dict of bounding boxes where keys are CRS codes
children	WmsLayerFull[]	Not defined if the layer is a leaf in the tree
dimensions	WmsLayerDimension[]
keywords	string[]
maxScaleDenominator	number
metadata	MetadataURL[]
minScaleDenominator	number
name	string	The layer is renderable if defined
opaque	boolean
queryable	boolean
styles	LayerStyle[]
title	string

---

WmsLayerSummary

Property	Type	Description
abstract	string
children	WmsLayerSummary[]	Not defined if the layer is a leaf in the tree
name	string	The layer is renderable if defined
title	string

---

WmsVersion

        '1.1.0' | '1.1.1' | '1.3.0'
      

---

WmtsLayerDimensionValue

        string
      

---

WpsEndpointInfo

        GenericEndpointInfo
      

---

WpsExecuteStatus

        'accepted' | 'started' | 'paused' | 'succeeded' | 'failed'
      

---

WpsInputType

        'literal' | 'boundingbox' | 'complex'
      

---

WpsVersion

        '1.0.0'