# worldtides

> API wrapper for WorldTides.info (unofficial)

Latest version **2.0.0** (published 2021-10-06) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install worldtides
pnpm add worldtides
yarn add worldtides
bun add worldtides
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-10-06 |
| First published | 2018-08-17 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12 |
| Dependencies | 1 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Franklin |
| Maintainers | franklin |
| Keywords | api, coast, environment, geolocation, ocean, sealevel, tides, worldtides |

## Links

- npm: https://www.npmjs.com/package/worldtides
- Repository: https://github.com/fvdm/nodejs-worldtides
- Homepage: https://github.com/fvdm/nodejs-worldtides#readme
- Issues: https://github.com/fvdm/nodejs-worldtides/issues
- npm.io page: https://npm.io/package/worldtides

## Dependencies (1)

- [httpreq](https://npm.io/package/httpreq.md) ^0.5.2

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2021-10-06
- 1.0.2 — 2018-09-02
- 1.0.1 — 2018-08-24
- 1.0.0 — 2018-08-17

## README

# worldtides

API wrapper for [WorldTides.info](https://www.worldtides.info) on [Node.js](https://nodejs.org) (unofficial)

[![npm](https://img.shields.io/npm/v/worldtides.svg?maxAge=3600)](https://github.com/fvdm/nodejs-worldtides/blob/master/CHANGELOG.md)
[![Build Status](https://github.com/fvdm/nodejs-worldtides/actions/workflows/node.js.yml/badge.svg?branch=master)](https://github.com/fvdm/nodejs-worldtides/actions/workflows/node.js.yml)
[![Coverage Status](https://coveralls.io/repos/github/fvdm/nodejs-worldtides/badge.svg?branch=master)](https://coveralls.io/github/fvdm/nodejs-worldtides?branch=master)


## Usage

You provide the parameters in an _object_ and it returns a _Promise_.

When a parameter only needs to be 'present' you still need to give it a value,
like an empty string `''` or `true`, it can be anything.

The `date`, `localtime` and `start` params are auto formatted from strings and Date.

See the [**API documentation**](https://www.worldtides.info/apidocs) for details.


```js
const tides = require ('worldtides');

// Get tide extremes for the next 2 weeks (3 credits)
tides ({
  key: 'abc123',
  extremes: '',
  length: 1209600,
  stationDistance: 15,
  lat: 52.381158,
  lon: 4.4837275,
})
.then (data => data.extremes)
.then (console.table)
.catch (console.error);
```


## Installation

`npm i worldtides`


## Configuration

You can add the configuration params in the same arguments
object as the API request method.

```js
const tides = require ('worldtides');

tides ({
  key: 'abc123',
  timeout: 5000,
  ...params,
});
```

### Parameters

param     | type   | default     | description
:---------|:-------|:------------|:-----------
[origin]  | string | `no-origin` | Origin on allow list
[timeout] | number | `5000`      | Request time out in ms


## Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <https://unlicense.org>


## Author

[Franklin](https://fvdm.com)
| [Buy me a coffee](https://fvdm.com/donating)

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