ol-wfs-capabilities/README.md

Format for reading WFS capabilities data

# ol-wfs-capabilities

<p align="center">
    <a href="https://www.npmjs.com/package/ol-wfs-capabilities">
        <img src="https://img.shields.io/npm/v/ol-wfs-capabilities.svg" alt="npm version">
    </a>
    <a href="https://img.shields.io/npm/dm/ol-wfs-capabilities">
        <img alt="npm" src="https://img.shields.io/npm/dm/ol-wfs-capabilities">
    </a>
    <a href="https://github.com/gastonzalba/ol-wfs-capabilities/blob/master/LICENSE">
        <img src="https://img.shields.io/npm/l/ol-wfs-capabilities.svg" alt="license">
    </a>
</p>

Module to work alongside OpenLayers for reading WFS Capabilities data (versions 1.0.0, 1.1.0 and 2.0.0) and convert it to JSON, complementing the native classes `ol/format/WMSCapabilities` and `ol/format/WMTSCapabilities`.

OpenLayers (at least up to 8.1.0 version) does not have a native way to do this (see related [issue](https://github.com/openlayers/openlayers/issues/8909)), hence the creation of this module that does not depend on any other external dependency other than what comes with OpenLayers.

## Online example

See [converter](https://raw.githack.com/GastonZalba/ol-wfs-capabilities/main/examples/converter.html) to text and parse data

## Usage

```js
import WFSCapabilities from 'ol-wfs-capabilities';

const parser = new WFSCapabilities();

const parsedCapabilities = parser.read(myWfsCapabilitiesSource);
```

## Changelog

See CHANGELOG for details of changes in each release.

## Install

### Parcel, Webpack, etc.

NPM package: [ol-wfs-capabilities](https://www.npmjs.com/package/ol-wfs-capabilities).

Install the package via `npm`

```shell
npm install ol-wfs-capabilities
```

### TypeScript type definition

TypeScript types are shipped with the project in the dist directory and should be automatically used in a TypeScript project. Interfaces are provided for the Options.

## Development

```shell
# install dependencies
npm install

# run test
npm test
# run test without pretest
npx jest

# run online example locally on http://localhost:3009/
npm run watch 
```

## License
MIT (c) Gastón Zalba.