# uk-river-data

> Access level, flow and other data for UK rivers and other watercourses.

Latest version **0.9.1** (published 2023-06-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install uk-river-data
pnpm add uk-river-data
yarn add uk-river-data
bun add uk-river-data
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.1 |
| Published | 2023-06-05 |
| First published | 2023-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 43.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | riverdatauk |
| Maintainers | pbuk |
| Keywords | river flow, river level, groundwater, tides |

## Links

- npm: https://www.npmjs.com/package/uk-river-data
- Repository: https://github.com/riverdatauk/uk-river-data
- Issues: https://github.com/riverdatauk/uk-river-data/issues
- npm.io page: https://npm.io/package/uk-river-data

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.9.1 (latest) — 2023-06-05
- 0.9.0 — 2023-05-24

## README

# UK River Data

> Access level, flow and other data for UK rivers and other watercourses.

## Quick start: browser

Download from CDN:

```html
<script src="https://cdn.jsdelivr.net/npm/uk-river-data@0.9"></script>
```

Example usage:

```js
const floodApi = new UkRiverData.FloodApi();
// Get the last 7 days readings from the flow guage at Kingston.
const readings = await floodApi.fetchMeasureReadings(
  '3400TH-flow--i-15_min-m3_s'
  { since: new Date(Date.now() - 86400 * 7)}
);
```

## Quick start: Node JS

Install the package:

```console
$ npm i uk-river-data
```

Example usage:

```js
import { FloodApi } from 'uk-river-data';
const floodApi = new FloodApi();
// Get the last 7 days readings from the flow guage at Kingston.
const readings = await floodApi.fetchMeasureReadings(
  '3400TH-flow--i-15_min-m3_s'
  { since: new Date(Date.now() - 86400 * 7)}
);
```

---
_Source: https://npm.io/package/uk-river-data · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
