Neat Paraskavedekatriaphobia's Meaning

    worldtides

    2.0.0 • Public • Published

    worldtides

    API wrapper for WorldTides.info on Node.js (unofficial)

    npm Build Status Coverage Status

    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 for details.

    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.

    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 | Buy me a coffee

    Install

    npm i worldtides

    DownloadsWeekly Downloads

    3

    Version

    2.0.0

    License

    Unlicense

    Unpacked Size

    7.38 kB

    Total Files

    5

    Last publish

    Collaborators

    • franklin