seisplotjs 3.1.4 | Documentation

seisplotjs

3.1.4

SEEDLINK_PATH
DATALINK_PATH
RingserverVersion
StreamsResult
IRIS_HOST
RingserverConnection ▸
- Instance members
- #host
- #getHost
- #port
- #getPort
- #timeout
- #getTimeout
- #pullId
- #pullStreamIds
- #pullStreams
- #pullRaw
- #getDataLinkURL
- #getSeedLinkURL
- #formBaseURL
- #formIdURL
- #formStreamsURL
- #formStreamIdsURL
stationsFromStreams
NslcWithType ▸
- Instance members
- #type
- #nslc
nslcSplit
StreamStat ▸
- Instance members
- #key
- #startRaw
- #endRaw
- #start
- #end
- #calcLatency

Need help reading this?

SEEDLINK_PATH

src/ringserverweb.ts

SEEDLINK_PATH

Type: string

DATALINK_PATH

src/ringserverweb.ts

DATALINK_PATH

Type: string

RingserverVersion

src/ringserverweb.ts

RingserverVersion

Type: {ringserverVersion: string, serverId: string}

Properties

ringserverVersion (string)

serverId (string)

StreamsResult

src/ringserverweb.ts

StreamsResult

Type: {accessTime: DateTime, streams: Array<StreamStat>}

Properties

accessTime (DateTime)

streams (Array<StreamStat>)

IRIS_HOST

src/ringserverweb.ts

IRIS_HOST

Type: string

RingserverConnection

src/ringserverweb.ts

Web connection to a Ringserver.

new RingserverConnection(host: string?, port: number?)

Parameters

host (string?) optional host to connect to, defaults to IRIS. This maybe a full URL.

port (number?) optional host to connect to, defaults to 80

Instance Members

▸ host(value?)

src/ringserverweb.ts

Gets/Sets the remote host to connect to.

host(value: string?): RingserverConnection

Parameters

value (string?) optional new value if setting

Returns

RingserverConnection: new value if getting, this if setting

▸ getHost()

src/ringserverweb.ts

getHost(): string

Returns

string

▸ port(value?)

src/ringserverweb.ts

Gets/Sets the remote port to connect to.

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

Parameters

value (number?) optional new value if setting

Returns

(number | RingserverConnection): new value if getting, this if setting

▸ getPort()

src/ringserverweb.ts

getPort(): (number | undefined)

Returns

(number | undefined)

▸ timeout(value?)

src/ringserverweb.ts

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

timeout(value: number?): RingserverConnection

Parameters

value (number?) optional new value if setting

Returns

RingserverConnection: new value if getting, this if setting

▸ getTimeout()

src/ringserverweb.ts

getTimeout(): (number | undefined)

Returns

(number | undefined)

▸ pullId()

src/ringserverweb.ts

Pulls id result from ringserver /id parsed into an object with 'ringserverVersion' and 'serverId' fields.

pullId(): Promise<RingserverVersion>

Returns

Promise<RingserverVersion>: Result as a Promise.

▸ pullStreamIds(level, matchPattern)

src/ringserverweb.ts

Use numeric level (1-6) to pull just IDs from ringserver. In a default ringserver, level=1 would return all networks like CO and level=2 would return all stations like CO_JSC If level is falsy/missing, level=6 is used. The optional matchPattern is a regular expression, so for example '.+_JSC_00_HH.' would get all HH? channels from any station name JSC.

pullStreamIds(level: number, matchPattern: string): Promise<Array<string>>

Parameters

level (number) 1-6

matchPattern (string) regular expression to match

Returns

Promise<Array<string>>: Result as a Promise.

▸ pullStreams(matchPattern)

src/ringserverweb.ts

Pull streams, including start and end times, from the ringserver. The optional matchPattern is a regular expression, so for example '.+_JSC_00_HH.' would get all HH? channels from any station name JSC. Result returned is an Promise.

pullStreams(matchPattern: string): Promise<StreamsResult>

Parameters

matchPattern (string) regular expression to match

Returns

Promise<StreamsResult>: promise to object with 'accessTime' as a DateTime and 'streams' as an array of StreamStat objects.

▸ pullRaw(url)

src/ringserverweb.ts

Utility method to pull raw result from ringserver url. Result returned is an Promise.

pullRaw(url: string): Promise<string>

Parameters

url (string) the url

Returns

Promise<string>: promise to string result

▸ getDataLinkURL()

src/ringserverweb.ts

getDataLinkURL(): string

Returns

string

▸ getSeedLinkURL()

src/ringserverweb.ts

getSeedLinkURL(): string

Returns

string

▸ formBaseURL()

src/ringserverweb.ts

Forms base url from protocol, host and port.

formBaseURL(): string

Returns

string: the string url

▸ formIdURL()

src/ringserverweb.ts

Forms the ringserver id url.

formIdURL(): string

Returns

string: the id url

▸ formStreamsURL(queryParams?)

src/ringserverweb.ts

Forms the ringserver streams url using the query parameters.

formStreamsURL(queryParams: string?): string

Parameters

queryParams (string?) optional string of query parameters

Returns

string: the streams url

▸ formStreamIdsURL(queryParams)

src/ringserverweb.ts

Forms the ringserver stream ids url using the query parameters.

formStreamIdsURL(queryParams: string): string

Parameters

queryParams (string) optional string of query parameters

Returns

string: the stream ids url

stationsFromStreams

src/ringserverweb.ts

Extract one StreamStat per station from an array of channel level StreamStats. The start and end times are the min and max times for all the channels within the station. Can be used to get most time of most recent packet from the stations to give an idea of current latency.

stationsFromStreams(streams: Array<StreamStat>): Array<StreamStat>

Parameters

streams (Array<StreamStat>) array of channel level StreamStats

Returns

Array<StreamStat>: array of station level StreamStats