@urban-toolkit/autk-db

---

@urban-toolkit/autk-db / LoadOsmParams

Type Alias: LoadOsmParams

LoadOsmParams = object

Defined in: use-cases/load-osm-overpass/interfaces.ts:121

Properties

autoLoadLayers

autoLoadLayers: object

Defined in: use-cases/load-osm-overpass/interfaces.ts:123

coordinateFormat?

optional coordinateFormat?: string

CRS of the OSM input data (source). Defaults to EPSG:4326.

layers

layers: LayerType[]

Public layers to retain; may be empty for tag-only loads. Surface is always constructed as a workspace mask, hidden unless requested.

---

forceRefresh?

optional forceRefresh?: boolean

Defined in: use-cases/load-osm-overpass/interfaces.ts:141

When true, bypasses the cached Overpass response and fetches fresh data.

---

onProgress?

optional onProgress?: OnLoadingProgress

Defined in: use-cases/load-osm-overpass/interfaces.ts:143

---

outputTableName?

optional outputTableName?: string

Defined in: use-cases/load-osm-overpass/interfaces.ts:122

---

pbfFileUrl?

optional pbfFileUrl?: string

Defined in: use-cases/load-osm-overpass/interfaces.ts:139

If provided, OSM data is loaded from this .osm.pbf file instead of the Overpass API.

---

queryArea

queryArea: OsmQueryArea

Defined in: use-cases/load-osm-overpass/interfaces.ts:135

Named boundaries or a WGS84 bbox. Named coastline collection/classification uses the geocode bbox, including neighboring coasts regardless of jurisdiction. Water adds bbox(areas) minus classified land; generated context has properties.generated = 'coastline'. Missing/invalid coastlines never imply sea. PBFs must cover the geocode bbox with complete coastlines; no supplemental network requests are made. Surface excludes sea when reconstruction succeeds; otherwise the full query area is used with a warning. Buildings retain complete original parts.

---

tagSets?

optional tagSets?: OsmTagSet[]

Defined in: use-cases/load-osm-overpass/interfaces.ts:137

Overpass-only tag-selected layers, clipped to the mandatory surface. Each set requires one geometry type.

---

workspace?

optional workspace?: string

Defined in: use-cases/load-osm-overpass/interfaces.ts:142