@giapspzoo/gugik-api-client
v0.0.1
Published
A set of utility functions for interacting with GUGiK's REST API.
Readme
@giapspzoo/gugik-api-client
A set of utility functions for interacting with GUGiK's (Head Office of Geodesy and Cartography) REST API.
API
getCityStreets({ simc, options })
| Parameter | Type | Required | Default value | Description |
| -------------- | ------ | -------- | ------------- | ----------------------- |
| simc | string | Yes | - | SIMC identifier of city |
| options | object | No | {} | Configuration object |
| options.srid | number | No | - | CRS of response data |
getMunicipalityCities({ teryt, options })
| Parameter | Type | Required | Default value | Description |
| -------------- | ------ | -------- | ------------- | -------------------------------- |
| teryt | string | Yes | - | TERYT identifier of municipality |
| options | object | No | {} | Configuration object |
| options.srid | number | No | - | CRS of response data |
getStreetAddresses({ teryt, ulic, options })
| Parameter | Type | Required | Default value | Description |
| -------------- | ------ | -------- | ------------- | ------------------------------- |
| simc | string | Yes | - | SIMC identifier of municipality |
| ulic | string | No | - | ULIC identifier of street |
| options | object | No | {} | Configuration object |
| options.srid | number | No | - | CRS of response data |
Development
Scripts
build
Use npm run build to prepare a production build of the package.
dev
Use npm run dev to run the functions playground.
