node tfl journey planner

Un contenedor de nodo simple para obtener viajes en tiempo real desde la API de TFL

Instalar

 npm install tfl-journey-planner --save

Uso

 tflJourneyPlanner = require ( 'tfl-journey-planner' ) ;

// Specify locations in this format
locations = {
  to : { lat : 51.5002452 , lng : 0.0035842 } ,
  from : { lat : 51.5131652 , lng : - 0.0905267 }
} ;

options = { } ; // Specify additional options if you want (see below)

tflJourneyPlanner ( locations , options , function ( results ) {
  console . log ( results ) ; // Do awesome stuff with the TFL results!
} ) ; 

Ubicaciones

Las ubicaciones se pueden especificar como:

 locations = {
  to : { lat : 51.5002452 , lng : 0.0035842 } ,
  from : { lat : 51.5131652 , lng : - 0.0905267 }
}

o con su valor de texto

 locations = {
  to : 'Aldgate East' ,
  from : 'London Bridge'
} ;

Sin embargo, el uso de valores de texto probablemente tendrá muchas coincidencias, por lo que es posible que su respuesta no sea la que había planeado.

o con códigos postales/direcciones de texto

 locations = {
  to : 'SE18 7PH' ,
  from : 'EC3M 3AD'
} ; 

Especificación de opciones adicionales

El segundo parámetro es un objeto JSON donde puedes colocar cualquiera de los siguientes (todos son opcionales):

OPCIÓN	POR DEFECTO	EXPLICACIÓN
a través de		Viajar (si está en formato de coordenadas, debe ser "longitud, latitud")
búsqueda nacional	[FALSO]	¿El viaje cubre paradas fuera de Londres? p.ej. "Búsqueda Nacional=verdadero"
fecha		La fecha debe estar en formato aaaaMMdd
tiempo		La hora debe estar en formato HHmm.
el tiempo es	[Partiendo]	¿La hora indicada se relaciona con la hora de llegada o de salida? Posibles opciones: "partir"
viajePreferencia	[Tiempo mínimo]	La preferencia de viaje, por ejemplo, opciones posibles: "mínimo intercambio"
modo		El modo debe ser una lista de modos separados por comas. por ejemplo, opciones posibles: "autobús público, metro, tren, metro, autocar, dlr, teleférico, tranvía, río, caminar, bicicleta"
Preferencia de accesibilidad		La preferencia de accesibilidad debe ser una lista separada por comas, por ejemplo. "noSolidStairs,noEscaleras mecánicas,noAscensores,stepFreeToVehicle,stepFreeToPlatform"
deNombre		Nombre de origen es el nombre de la ubicación asociada con una coordenada de origen.
al nombre		Para nombrar es la ubicación de la etiqueta asociada con una para coordinar.
víaNombre		El nombre de vía es el nombre de la ubicación asociada con una coordenada de vía.
maxTransferMinutos		El tiempo máximo de caminata en minutos para el traslado, por ejemplo. "120"
maxCaminarMinutos		El tiempo máximo de caminata en minutos para viajes, por ejemplo. "120"
caminarVelocidad	[Promedio]	La velocidad al caminar. por ejemplo, opciones posibles: "lento"
cicloPreferencia	[Ninguno]	La preferencia del ciclo. por ejemplo, opciones posibles: "allTheWay"
ajuste		Comando de ajuste de tiempo. por ejemplo, opciones posibles: "TripFirst"
bicicletaCompetencia		Una lista separada por comas de niveles de competencia en ciclismo. por ejemplo, opciones posibles: "fácil, moderado, rápido"
ciclo alternativo	[FALSO]	Opción para determinar si se regresa o no por un viaje alternativo en bicicleta
alternativacaminar	[Verdadero]	Opción para determinar si regresar o realizar un viaje alternativo a pie
aplicar HTMLMarkup	[FALSO]	Bandera para determinar si cierto texto (por ejemplo, instrucciones para caminar) debe mostrarse con etiquetas HTML o no.
utilizarMultiModalCall	[FALSO]	Un booleano para indicar si se deben devolver o no 3 viajes en transporte público, un viaje en autobús, un viaje en bicicleta de alquiler, un viaje en bicicleta personal y un viaje a pie.
caminarOptimización	[FALSO]	Un booleano para indicar si se deben optimizar los viajes caminando

Especifique opciones como esta:

 options = {
    walkingOptimization : true ,
    bikeProficiency : 'easy' ,
    accessibilityPreference : 'noEscalators'
} 

Desarrollo

Escrito en LiveScript, ejecute npm run build para compilar o npm run watch para observar los cambios y luego compilar

Pruebas unitarias

npm test

Asuntos

Informe sobre la página de problemas del repositorio de GitHub

Autenticación

Ya no se requiere autenticación ni solicitudes tfl. Si necesita autenticarse, puede registrarse para obtener una clave API en https://api-portal.tfl.gov.uk/signup. Cree un objeto JSON similar al siguiente.

    tfl = {
        appId : 'xxxxxxxx' ,
        appKey : 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
    } ;