Class GeoNet

Main class for interacting with the GeoNet API and related utilities. Provides access to all GeoNet services through a unified interface.

Remarks

This class acts as a central interface for all GeoNet API services and related utilities, thus providing a simplified way for accessing earthquake, volcano, network data, among others, from GeoNet.

Example

import { GeoNet } from "geonet";
const geonet = new GeoNet();

// Get recent earthquakes
const quakes = await geonet.getQuakes(...);

See

https://api.geonet.org.nz GeoNet API Documentation.
IntensityService For intensity-related methods.
StrongService For strong motion-related methods.
NewsService For news-related methods.
QuakeService For quake-related methods.
VolcanoService For volcano-related methods.
NetworkService For network-related methods.
QuakeMapUtil For generating GeoNet quake map URLs.

Since

1.0.0

Index

Constructors

constructor

Methods

generateColourCode generateMapURL getIntensity getNetworkFDSNDetails getNetworkGNSSDetails getNetworkSensor getNews getQuake getQuakeHistory getQuakes getQuakeStats getStrong getVolcanoAlertLevel getVolcanoQuakes

Constructors

constructor

new GeoNet(
    intensityService?: IntensityService,
    strongService?: StrongService,
    newsService?: NewsService,
    quakeService?: QuakeService,
    volcanoService?: VolcanoService,
    networkService?: NetworkService,
    quakeMapUtil?: QuakeMapUtil,
): GeoNet
Creates a new instance of the GeoNet client.
Parameters
- intensityService: IntensityService = ...
  Service for intensity data.
- strongService: StrongService = ...
  Service for strong motion data.
- newsService: NewsService = ...
  Service for news feed data.
- quakeService: QuakeService = ...
  Service for earthquake data.
- volcanoService: VolcanoService = ...
  Service for volcanic activity data.
- networkService: NetworkService = ...
  Service for network sensor data.
- quakeMapUtil: QuakeMapUtil = ...
Returns GeoNet
- Defined in src/GeoNet.ts:61

Methods

generateColourCode

generateColourCode(mmi: MMI): string
Parameters
- mmi: MMI
Returns string
Inherit Doc
QuakeMapUtil.generateColourCode
- Defined in src/GeoNet.ts:137

generateMapURL

generateMapURL(coordinates: [number, number], mmi: MMI): string
Parameters
- coordinates: [number, number]
- mmi: MMI
Returns string
Inherit Doc
QuakeMapUtil.generateMapURL
- Defined in src/GeoNet.ts:132

getIntensity

getIntensity(req: IntensityRequestUnion): Promise<IntensityResponse>
Parameters
- req: IntensityRequestUnion
Returns Promise<IntensityResponse>
Inherit Doc
IntensityService.getIntensity
- Defined in src/GeoNet.ts:72

getNetworkFDSNDetails

getNetworkFDSNDetails(
req: NetworkFDSNStationRequest,
): Promise<NetworkFDSNStationResponse>
Parameters
- req: NetworkFDSNStationRequest
Returns Promise<NetworkFDSNStationResponse>
Inherit Doc
NetworkService.getNetworkFDSNDetails
- Defined in src/GeoNet.ts:127

getNetworkGNSSDetails

getNetworkGNSSDetails(code: string): Promise<NetworkGNSStationResponse>
Parameters
- code: string
Returns Promise<NetworkGNSStationResponse>
Inherit Doc
NetworkService.getNetworkGNSSDetails
- Defined in src/GeoNet.ts:122

getNetworkSensor

getNetworkSensor(req: NetworkSensorRequest): Promise<NetworkSensorResponse>
Parameters
- req: NetworkSensorRequest
Returns Promise<NetworkSensorResponse>
Inherit Doc
NetworkService.getNetworkSensor
- Defined in src/GeoNet.ts:117

getNews

getNews(page?: number): Promise<NewsFeedResponse>
Parameters
- Optionalpage: number
Returns Promise<NewsFeedResponse>
Inherit Doc
NewsService.getNews
- Defined in src/GeoNet.ts:82

getQuake

getQuake(publicID: string): Promise<QuakeResponse>
Parameters
- publicID: string
Returns Promise<QuakeResponse>
Inherit Doc
QuakeService.getQuake
- Defined in src/GeoNet.ts:87

getQuakeHistory

getQuakeHistory(publicID: string): Promise<QuakeHistoryResponse>
Parameters
- publicID: string
Returns Promise<QuakeHistoryResponse>
Inherit Doc
QuakeService.getQuakeHistory
- Defined in src/GeoNet.ts:92

getQuakes

getQuakes(mmi: MMI): Promise<QuakesResponse>
Parameters
- mmi: MMI
Returns Promise<QuakesResponse>
Inherit Doc
QuakeService.getQuakes
- Defined in src/GeoNet.ts:102

getQuakeStats

getQuakeStats(): Promise<QuakeStatsResponse>
Returns Promise<QuakeStatsResponse>
Inherit Doc
QuakeService.getQuakeStats
- Defined in src/GeoNet.ts:97

getStrong

getStrong(publicID: string): Promise<StrongResponse>
Parameters
- publicID: string
Returns Promise<StrongResponse>
Inherit Doc
StrongService.getStrong
- Defined in src/GeoNet.ts:77

getVolcanoAlertLevel

getVolcanoAlertLevel(): Promise<VolcanoAlertLevelResponse>
Returns Promise<VolcanoAlertLevelResponse>
Inherit Doc
VolcanoService.getVolcanoAlertLevel
- Defined in src/GeoNet.ts:107

getVolcanoQuakes

getVolcanoQuakes(volcanoID: VolcanoID): Promise<VolcanoQuakeResponse>
Parameters
- volcanoID: VolcanoID
Returns Promise<VolcanoQuakeResponse>
Inherit Doc
VolcanoService.getVolcanoQuakes
- Defined in src/GeoNet.ts:112

Class GeoNet

Remarks

Example

See

Since

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GeoNet

Methods

generateColourCode

Parameters

Returns string

Inherit Doc

generateMapURL

Parameters

Returns string

Inherit Doc

getIntensity

Parameters

Returns Promise<IntensityResponse>

Inherit Doc

getNetworkFDSNDetails

Parameters

Returns Promise<NetworkFDSNStationResponse>

Inherit Doc

getNetworkGNSSDetails

Parameters

Returns Promise<NetworkGNSStationResponse>

Inherit Doc

getNetworkSensor

Parameters

Returns Promise<NetworkSensorResponse>

Inherit Doc

getNews

Parameters

Returns Promise<NewsFeedResponse>

Inherit Doc

getQuake

Parameters

Returns Promise<QuakeResponse>

Inherit Doc

getQuakeHistory

Parameters

Returns Promise<QuakeHistoryResponse>

Inherit Doc

getQuakes

Parameters

Returns Promise<QuakesResponse>

Inherit Doc

getQuakeStats

Returns Promise<QuakeStatsResponse>

Inherit Doc

getStrong

Parameters

Returns Promise<StrongResponse>

Inherit Doc

getVolcanoAlertLevel

Returns Promise<VolcanoAlertLevelResponse>

Inherit Doc

getVolcanoQuakes

Parameters

Returns Promise<VolcanoQuakeResponse>

Inherit Doc

Settings

On This Page