Skip to main content

validateDatasetConfig()

const validateDatasetConfig: (data) => object

Pre-configured validator for dataset configurations.

Parameters​

data​

unknown

Returns​

object

dataType​

dataType: "Unknown" | "GEOJSON" | "ARROW" = layerDataTypeSchema

description​

description: string

fields​

fields: object[]

id​

id: string

level​

level: "generated" | "user"

metadata​

metadata: object = layerDatasetMetadataSchema

metadata.defaultFields​

defaultFields: string[]

metadata.filterDialect?​

optional filterDialect: "cql" | "gml"

metadata.geometryProperty​

geometryProperty: string

metadata.idProperty?​

optional idProperty: string

metadata.maxRequests?​

optional maxRequests: number

metadata.maxZoom?​

optional maxZoom: number

metadata.minZoom?​

optional minZoom: number

metadata.positionFormat?​

optional positionFormat: "XYZ" | "XY"

metadata.refetchInterval?​

optional refetchInterval: number

metadata.serviceLayer?​

optional serviceLayer: string

metadata.serviceUrls?​

optional serviceUrls: string[]

metadata.serviceVersion?​

optional serviceVersion: string

metadata.table​

table: string

mutatable​

mutatable: boolean

name​

name: string

presentationTypes​

presentationTypes: Record<string, string[] | null>

serviceType​

serviceType: "VTS" | "WMS" | "WFS" | "FS" | "Unknown" = layerServiceTypeSchema

visible​

visible: boolean

Throws​

Validation error with formatted path and message details (from returned function)

Remarks​

Convenience export that pre-applies the anyDatasetSchema to the validate function.

Example​

const dataset = validateDatasetConfig(rawDataset);