ndfd_drought_product_api_definition v1.1.1
ndfd_drought_product_api_definition
NdfdDroughtProductApiDefinition - JavaScript client for ndfd_drought_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.1.0
- Package version: 0.1.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 ndfd_drought_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 ndfd_drought_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 NdfdDroughtProductApiDefinition = require('ndfd_drought_product_api_definition');
var api = new NdfdDroughtProductApiDefinition.DroughtApi()
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 = 2023-08-05T14:00:00/2023-08-12T00:00:00; // {String} Datetime for the query
var f = "f_example"; // {String} Output Format for the Query
var opts = {
'parameterName': "parameterName_example", // {String} Parameter Description: * `temp` - Hourly Temperature * `rh` - Relative Humidity
'tempThreshold': "tempThreshold_example", // {String}
'rhThreshold': "rhThreshold_example", // {String}
'tempPalette': "tempPalette_example", // {String} palette color for client
'rhPalette': "rhPalette_example" // {String} palette color for client
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.getAreaTemp(coords, datetime, f, opts, callback);
Documentation for API Endpoints
All URIs are relative to https://edr-api-c.mdl.nws.noaa.gov/OGC-EDR-API
Class | Method | HTTP request | Description |
---|---|---|---|
NdfdDroughtProductApiDefinition.DroughtApi | getAreaTemp | GET /collections/ndfd_probabilistic/instances/latest/area | Retrieve Data at a Area |
NdfdDroughtProductApiDefinition.DroughtApi | getMetadata | GET /collections/ndfd_probabilistic/instances/latest |
Documentation for Models
Documentation for Authorization
Endpoints do not require authorization.