ogrinfo-validator wraps the ogrinfo
GDAL tool to retrieve information about provided vector datasets. This package also allows the user to validate their vector data source against set criteria. Validation includes:
- Ability to determine if number of features is beyond specified limit
- If extent of the Vector Dataset is Incorrect
-
[Install GDAL tools][1] (includes the
ogr2ogr
command line tool) -
Install package:
npm install ogrinfo-validator
ogrinfo takes a file path. The result will include general & validation information.
// Using CommonJS modules
const ogrinfov = require('ogrinfo-validator')
// Simple Call
ogrinfov('test.zip').then((result)=>{
// Do what you need
}).catch((err)=>{
// Show or handle error
})
// Call with options & Limits
ogrinfov('<file location>', {options: ['summaryOnly','listAll']}, {limits:{ featureCount: 500000, checkExtent: true }}).then((result)=>{
console.log(result);
}).catch((err)=>{
console.log(err);
});
## IMPORTANT
- Input file (*.shp) must have related *.shx file and optional *.prj file.
- Supports shp file (*.zip), GeoJSON or JSON (with GIS data) and csv with latitude and longitude
## VERSION
- 1.0.11
## API
### ogrinfo-validator(input, options?) -> {metadata and validation information}
The **`input`** may be one of:
- A path (`string`). This includes file paths and network paths including HTTP endpoints.
The following **`options`** are available (none required):
- `summaryOnly` - Outputs summary only (default)
- `listAll` - Detailed Information/Metadata
The following **`limits`** are available for validation purposes (none required):
- `featureCount` - Reports if features are more then specified limit.
- `checkExtent` - Check extent (WGS84 Supported Only)
The **`output`** object has the following properties:
- `promise` - Javascript object that contains metadata and validation Information. Error information is return in error key.
- 'Rejection Promise' - on Error of process