exceedance_product_api_definition

ExceedanceProductApiDefinition - JavaScript client for exceedance_product_api_definition No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.5.0
• Package version: 0.5.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install exceedance_product_api_definition --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your exceedance_product_api_definition from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ExceedanceProductApiDefinition = require('exceedance_product_api_definition');


var api = new ExceedanceProductApiDefinition.ThresholdingApi()
var parameterName = temp; // {String} 
var coords = POLYGON((-77.783203 39.089949,-77.563477 38.662333,-76.486816 38.679486,-76.662596 39.192193,-77.783203 39.089949)); // {String} WKT for Position for retrieving data at a point
var datetime = "datetime_example"; // {String} Datetime for the query
var f = json; // {String} Output Format for the Query
var opts = {
  'threshold': "threshold_example", // {String} 
  'showTimingHistogram': true, // {String} 
  'earliest': true, // {String} Display the earliest that a threshold is met
  'latest': true, // {String} Display the latest that a threshold is met
  'count': true // {String} Display the count for how many times the threshold is met per grid point
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getArea(parameterName, coords, datetime, f, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://edr-api-c.mdl.nws.noaa.gov/Product-API-Exceedance

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ExceedanceProductApiDefinition.ThresholdingApi | getArea | GET /collections/ndfd_gridded/area | Retrieve Data at a Area

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.