npm

npm’s 2019 JavaScript ecosystem survey analysis is now available!Get your copy here »

koop-provider-csv

3.0.0 • Public • Published

koop-provider-csv

npm Build Status

A configurable and reusable CSV provider for Koop

This provider can load a CSV file from a local path or a remote endpoint. The provided CSV file must include columns of latitude and longitude coordinates.

Features

  • fully configurable
  • support multiple CSV sources
  • support local file path or remote endpoint
  • parse boolean and numeric automatically
  • stream processing

Installation

with npm

npm install koop-provider-csv

with Koop CLI for your Koop app

bash koop add koop-provider-csv

Usage

Once installed, this provider enables routes like

/koop-provider-csv/:id/FeatureServer/*

where id is the unique ID for a source CSV defined in the configuration file.

For example, this route allows to query a CSV file with ID my-csv:

/koop-provider-csv/my-csv/FeatureServer/0/query

Configuration

This provider is configured with config and all configuration files are in the config directory.

A configuration looks like this:

{
  // configuration namespace for this provider plugin
  "koop-provider-csv": {
    // define one or multiple CSV sources
    "sources": {
      // a unique ID for each source, which is used in the query route
      "my-data": {
        // [required] a file path or a URL for the source CSV
        "url": "path_to_csv",
        // [required] point coordinate columns
        "geometryColumns": {
          "longitude": "longitude_column_name",
          "latitude": "latitude_column_name"
        },
        // [optional] delimiter character
        "delimiter": ",",
        // [optional] ArcGIS service metadata
        "metadata": {
          "idField": "id_column_name"
        }
      }
    }
  }
}
 

See config/example.json for a full example.

Development

This provider is created by Koop CLI and it is recommended to use the CLI tool during your development.

Run server

koop serve

A dev server will be set up at http://localhost:8080.

Run test

koop test

License

MIT

install

npm i koop-provider-csv

Downloadsweekly downloads

3

version

3.0.0

license

MIT

last publish

collaborators

  • avatar
Report a vulnerability