seisplotjs.fdsndatacenters 2.0.0-alpha.4

seisplotjs.fdsndatacenters

2.0.0-alpha.4

FDSN_HOST
DataCentersQuery ▸
- Instance members
- #specVersion
- #protocol
- #host
- #port
- #name
- #services
- #includeDataSets
- #timeout
- #queryJson
- #findFdsnAvailability
- #findFdsnDataSelect
- #findFdsnEvent
- #findFdsnStation
- #extractCompatibleServices
- #formBaseURL
- #formVersionURL
- #queryVersion
- #makeParam
- #formURL

Need help reading this?

FDSN_HOST

src/fdsndatacenters.js

const for fdsn web service host, www.fdsn.org

FDSN_HOST

Type: string

DataCentersQuery

src/fdsndatacenters.js

Query to a FDSN Data Centers Registry web service.

new DataCentersQuery(host: string?)

Parameters

host (string?)

Instance Members

▸ specVersion(value?)

src/fdsndatacenters.js

Gets/Sets the version of the fdsnws spec, 1 is currently the only value. Setting this is probably a bad idea as the code may not be compatible with the web service.

specVersion(value: number?): (number | DataCentersQuery)

Parameters

value (number?)

Returns

(number | DataCentersQuery): the query when setting, the current value os services if no arguments

▸ protocol(value?)

src/fdsndatacenters.js

Gets/Sets the protocol, http or https. This should match the protocol of the page loaded, but is autocalculated and generally need not be set.

protocol(value: string?): (string | DataCentersQuery)

Parameters

value (string?)

Returns

(string | DataCentersQuery): the query when setting, the current value os services if no arguments

▸ host(value?)

src/fdsndatacenters.js

Gets/Sets the remote host to connect to. This defaults to www.fdsn.org and generally should not be set.

host(value: string?): (string | DataCentersQuery)

Parameters

value (string?)

Returns

(string | DataCentersQuery): the query when setting, the current value os services if no arguments

▸ port(value?)

src/fdsndatacenters.js

Gets/Sets the remote port to connect to. This defaults to the standard port for the protocol and generally should not be set.

port(value: number?): (number | DataCentersQuery)

Parameters

value (number?)

Returns

(number | DataCentersQuery): the query when setting, the current value os services if no arguments

▸ name(value?)

src/fdsndatacenters.js

limits results to the named data center, default is all data centers

name(value: string?): (string | DataCentersQuery)

Parameters

value (string?) names to search for

Returns

(string | DataCentersQuery): the query when setting, the current value os services if no arguments

▸ services(value?)

src/fdsndatacenters.js

limits results to services that match the glob style pattern

services(value: string?): (string | DataCentersQuery)

Parameters

value (string?) glob style pattern to match against

Returns

(string | DataCentersQuery): the query when setting, the current value os services if no arguments

▸ includeDataSets(value?)

src/fdsndatacenters.js

whether the results include detailed information about the data sets offered by each center, default is false

includeDataSets(value: boolean?): (boolean | DataCentersQuery)

Parameters

value (boolean?) true to include datasets

Returns

(boolean | DataCentersQuery): the query when setting, the current value os services if no arguments

▸ timeout(value?)

src/fdsndatacenters.js

Get/Set the timeout in seconds for the request. Default is 30.

timeout(value: number?): (number | DataCentersQuery)

Parameters

value (number?) timeout seconds

Returns

(number | DataCentersQuery): the query when setting, the current value os services if no arguments

▸ queryJson()

src/fdsndatacenters.js

queries the fdsn registry web service, returning the result as a parsed json object.

queryJson(): Promise<RootType>

Returns

Promise<RootType>: Promise to the json object.

▸ findFdsnAvailability(name, repoName?)

src/fdsndatacenters.js

queries the registry to find fdsn availability compatible web services within a datacenter of the given name, optionally within the repository with the repo name.

findFdsnAvailability(name: string, repoName: string?): Promise<Array<fdsnavailability.AvailabilityQuery>>

Parameters

name (string) datacenter name

repoName (string?) optional repository name

Returns

Promise<Array<fdsnavailability.AvailabilityQuery>>: Promise to Array of fdsnavailability.AvailabilityQuery objects

▸ findFdsnDataSelect(name, repoName?)

src/fdsndatacenters.js

queries the registry to find fdsn dataselect compatible web services within a datacenter of the given name, optionally within the repository with the repo name.

findFdsnDataSelect(name: string, repoName: string?): Promise<Array<fdsndataselect.DataSelectQuery>>

Parameters

name (string) datacenter name

repoName (string?) optional repository name

Returns

Promise<Array<fdsndataselect.DataSelectQuery>>: Promise to Array of fdsndataselect.DataSelectQuery objects

▸ findFdsnEvent(dcname, repoName?, name)

src/fdsndatacenters.js

queries the registry to find a fdsn event compatible web services within a datacenter of the given name, optionally within the repository with the repo name.

findFdsnEvent(dcname: string, repoName: string?, name: any): Promise<Array<fdsnevent.EventQuery>>

Parameters

dcname (string)

repoName (string?) optional repository name

name (any) datacenter name

Returns

Promise<Array<fdsnevent.EventQuery>>: Promise to Array of fdsnevent.EventQuery objects

▸ findFdsnStation(dcname, repoName?, name)

src/fdsndatacenters.js

queries the registry to find a fdsn station compatible web services within a datacenter of the given name, optionally within the repository with the repo name.

findFdsnStation(dcname: string, repoName: string?, name: any): Promise<Array<fdsnstation.StationQuery>>

Parameters

dcname (string)

repoName (string?) optional repository name

name (any) datacenter name

Returns

Promise<Array<fdsnstation.StationQuery>>: Promise to Array of fdsnstation.StationQuery objects

▸ extractCompatibleServices(json, compatibleName, repoName?)

src/fdsndatacenters.js

extractCompatibleServices(json: RootType, compatibleName: string, repoName: string?): Array<any>

Parameters

json (RootType)

compatibleName (string)

repoName (string?)

Returns

Array<any>

▸ formBaseURL()

src/fdsndatacenters.js

formBaseURL(): string

Returns

string

▸ formVersionURL()

src/fdsndatacenters.js

formVersionURL(): string

Returns

string

▸ queryVersion()

src/fdsndatacenters.js

Queries the remote web service to get its version

queryVersion(): Promise<string>

Returns

Promise<string>: Promise to version string

▸ makeParam(name, val)

src/fdsndatacenters.js

makeParam(name: string, val: any): string

Parameters

name (string)

val (any)

Returns

string

▸ formURL()

src/fdsndatacenters.js

forms a url to the fdsn registry based on the configured parameters.

formURL(): string

Returns

string: the url