Class NveHazardsClient

Client for NVE's open warning feeds and API-key-protected HydAPI.

Normalized warning records are discovery summaries. Public warning displays must retain the complete provider payload and follow NVE/Varsom's current service-specific attribution and presentation terms; use includeRaw when building such a display.

Index

Methods

getAvalancheWarnings getFloodWarnings getHydrologyObservations getHydrologyStations getLandslideWarnings

Methods

getAvalancheWarnings

getAvalancheWarnings(
parameters?: HazardWarningParameters,
options?: RequestOptions,
): Promise<OpenDataResponse<HazardWarning[]>>
Gets public avalanche warnings for a bounded date interval.
Parameters
- parameters: HazardWarningParameters = {}
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<HazardWarning[]>>
- Defined in src/providers/nve/hazards-client.ts:203

getFloodWarnings

getFloodWarnings(
parameters?: HazardWarningParameters,
options?: RequestOptions,
): Promise<OpenDataResponse<HazardWarning[]>>
Gets public flood warnings for a bounded date interval.
Parameters
- parameters: HazardWarningParameters = {}
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<HazardWarning[]>>
- Defined in src/providers/nve/hazards-client.ts:195

getHydrologyObservations

getHydrologyObservations(
parameters: HydrologyObservationParameters,
options?: RequestOptions,
): Promise<OpenDataResponse<HydrologyObservation[]>>
Gets observations for one HydAPI series. Requires a free HydAPI key.
Parameters
- parameters: HydrologyObservationParameters
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<HydrologyObservation[]>>
- Defined in src/providers/nve/hazards-client.ts:260

getHydrologyStations

getHydrologyStations(
parameters?: HydrologyStationParameters,
options?: RequestOptions,
): Promise<OpenDataResponse<HydrologyStation[]>>
Searches NVE hydrology stations. Requires a free HydAPI key.
Parameters
- parameters: HydrologyStationParameters = {}
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<HydrologyStation[]>>
- Defined in src/providers/nve/hazards-client.ts:219

getLandslideWarnings

getLandslideWarnings(
parameters?: HazardWarningParameters,
options?: RequestOptions,
): Promise<OpenDataResponse<HazardWarning[]>>
Gets public landslide warnings for a bounded date interval.
Parameters
- parameters: HazardWarningParameters = {}
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<HazardWarning[]>>
- Defined in src/providers/nve/hazards-client.ts:211

Class NveHazardsClient

Index

Methods

Methods

getAvalancheWarnings

Parameters

Returns Promise<OpenDataResponse<HazardWarning[]>>

getFloodWarnings

Parameters

Returns Promise<OpenDataResponse<HazardWarning[]>>

getHydrologyObservations

Parameters

Returns Promise<OpenDataResponse<HydrologyObservation[]>>

getHydrologyStations

Parameters

Returns Promise<OpenDataResponse<HydrologyStation[]>>

getLandslideWarnings

Parameters

Returns Promise<OpenDataResponse<HazardWarning[]>>

Settings

On This Page