Cliente del servicio de transporte público de Berlín y Brandeburgo (VBB). Actúa como una interfaz coherente y sencilla además de una API detallada.
Este proyecto es en realidad una pequeña envoltura alrededor de hafas-client@6
. Sus documentos documentan la API en general.
Nota : Es posible que no desee consultar la API de VBB usted mismo. vbb-client
es un cliente compatible con API para vbb-rest
, mi API contenedora. También funciona en el navegador.
npm install vbb-hafas
Consulte los documentos de hafas-client
y sus personalizaciones específicas de VBB.
const createHafas = require ( 'vbb-hafas' )
const hafas = createHafas ( 'my-awesome-program' )
Como ejemplo, buscaremos un viaje desde Berlín Hauptbahnhof hasta Berlín Charlottenburg . Para obtener los ID de las estaciones, utilice vbb-stations
.
hafas . journeys ( '900000003201' , '900000024101' , { results : 1 } )
. then ( ( journeys ) => console . log ( journeys [ 0 ] ) )
. catch ( console . error )
El resultado será una serie de objetos journey
en el formato Friendly Public Transport Format 1.2.1
:
[ {
legs : [ {
tripId : '1|50420|0|86|25122017' ,
direction : 'Brandenburg, Hbf' ,
line : {
type : 'line' ,
id : '10' ,
name : 'RE1' ,
public : true ,
mode : 'train' ,
product : 'regional' ,
symbol : 'RE' ,
nr : 1 ,
metro : false ,
express : true ,
night : false ,
class : 64 ,
productCode : 6 ,
operator : {
type : 'operator' ,
id : 'db-regio-ag' ,
name : 'DB Regio AG'
}
} ,
origin : {
type : 'station' ,
id : '900000003201' ,
name : 'S+U Berlin Hauptbahnhof' ,
location : {
type : 'location' ,
latitude : 52.52585 ,
longitude : 13.368928
} ,
products : {
suburban : true ,
subway : true ,
tram : true ,
bus : true ,
ferry : false ,
express : true ,
regional : true
}
} ,
departure : '2017-12-26T00:41:00.000+01:00' ,
plannedDeparture : '2017-12-26T00:41:00.000+01:00' ,
departureDelay : 0 ,
departurePlatform : '14' ,
plannedDeparturePlatform : '13' ,
destination : {
type : 'station' ,
id : '900000024101' ,
name : 'S Charlottenburg' ,
location : {
type : 'location' ,
latitude : 52.504806 ,
longitude : 13.303846
} ,
products : {
suburban : true ,
subway : false ,
tram : false ,
bus : true ,
ferry : false ,
express : false ,
regional : true
}
} ,
arrival : '2017-12-26T00:50:00.000+01:00' ,
plannedArrival : '2017-12-26T00:50:00.000+01:00' ,
arrivalDelay : null ,
arrivalPlatform : '4' ,
plannedArrivalPlatform : '4'
} ] ,
// all these are from the first leg
origin : {
type : 'station' ,
id : '900000003201' ,
name : 'S+U Berlin Hauptbahnhof'
// …
} ,
departure : '2017-12-26T00:41:00.000+01:00' ,
plannedDeparture : '2017-12-26T00:41:00.000+01:00' ,
departureDelay : 0 ,
departurePlatform : '14' ,
plannedDeparturePlatform : '13' ,
// all these are from the last leg
destination : {
type : 'station' ,
id : '900000024101' ,
name : 'S Charlottenburg'
// …
} ,
arrival : '2017-12-26T00:50:00.000+01:00' ,
plannedArrival : '2017-12-26T00:50:00.000+01:00' ,
arrivalDelay : null ,
arrivalPlatform : '4' ,
plannedArrivalPlatform : '4'
// …
} ]
vbb-hafas
intentará agregar información de transferencia desde vbb-change-positions
si pasa transferInfo: true
como opción.
Si identifica una transferencia conocida, el tramo anterior tendrá una bestArrivalPosition
y el siguiente tramo tendrá una departurePosition
, que indica la transferencia óptima entre ambas plataformas. Consulte el marcado en vbb-change-positions
para obtener más detalles.
Consulte los proyectos relacionados con hafas-client
.
Si tiene alguna pregunta , encontró un error o desea proponer una característica , eche un vistazo a la página de problemas.