db-vendo-client/docs/lines.md
Kristjan SCHMIDT fc1afe0625
lines() docs: fix typo 📝
part of #278
2022-11-23 12:46:47 +01:00

1.5 KiB

lines([opt])

Fetches all lines known to the HAFAS endpoint, e.g. warnings about disruptions, planned construction work, and general notices about the operating situation.

Example

As an example, we're going to use the SVV profile:

import {createClient} from 'hafas-client'
import {profile as svvProfile} from 'hafas-client/p/svv/index.js'

const client = createClient(svvProfile, 'my-awesome-program')

const {
	lines,
	realtimeDataUpdatedAt,
} = await client.lines('S1')

realtimeDataUpdatedAt is a UNIX timestamp reflecting the latest moment when (at least some of) the response's realtime data have been updated.

lines may look like this:

[
	{
		"id": "obb-1-S1-V-j20-1",
		"type": "line",
		"name": "S1",
		"public": true,
		"mode": "train",
		"product": "bahn-s-bahn",
		"operator": {
			"type": "operator",
			"id": "montafonerbahn-ag",
			"name": "Montafonerbahn AG"
		},
		"directions": [
			"Bludenz Bahnhof",
			"Bregenz Hafen Bahnhof",
			"Lindau Hbf",
			"Bregenz Bahnhof",
			"Schruns Bahnhof",
			"Lochau Bahnhof"
		],
	},
	// …
	{
		"id": "svv-42-50-j20-2",
		"type": "line",
		"name": "S1",
		"public": true,
		"mode": "train",
		"product": "bahn-s-bahn",
		"operator": {
			"type": "operator",
			"id": "salzburg-ag-salzburger-lokalbahn",
			"name": "Salzburg AG - Salzburger Lokalbahn"
		},
		"directions": [
			"Lamprechtshausen Bahnhof",
			"Salzburg Hauptbahnhof",
			"Acharting S-Bahn",
			"Weitwörth-Nussdorf Bahnhof"
		],
	},
]