node tfl journey planner
1.0.0
一个简单的 Node 包装器,用于从 TFL API 获取实时旅程
npm install tfl-journey-planner --save
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!
} ) ;
位置可以指定为:
locations = {
to : { lat : 51.5002452 , lng : 0.0035842 } ,
from : { lat : 51.5131652 , lng : - 0.0905267 }
}
或它们的文本值
locations = {
to : 'Aldgate East' ,
from : 'London Bridge'
} ;
但是,使用文本值可能会产生很多匹配项,因此您的响应可能不会按照您的计划进行。
或邮政编码/文本地址
locations = {
to : 'SE18 7PH' ,
from : 'EC3M 3AD'
} ;
第二个参数是一个 JSON 对象,您可以在其中放置以下任意内容(全部都是可选的):
选项 | 默认 | 解释 |
---|---|---|
通过 | 穿越(如果是坐标格式则必须是“经度,纬度”) | |
全国搜索 | [错误的] | 旅程是否在伦敦以外停靠?例如。 “国家搜索=真” |
日期 | 日期必须采用 yyyyMMdd 格式 | |
时间 | 时间必须采用 HHmm 格式 | |
时间是 | [出发] | 给出的时间与到达或离开时间有关吗?可能的选项:“出发” |
旅程偏好 | [最短时间] | 旅程偏好,例如可能的选项:“leastinterchange” |
模式 | 模式必须是逗号分隔的模式列表。例如可能的选项:“公共巴士、地上、火车、地铁、长途汽车、dlr、缆车、电车、河流、步行、自行车” | |
辅助功能偏好 | 可访问性首选项必须是逗号分隔的列表,例如。 “禁止实心楼梯、禁止自动扶梯、禁止电梯、stepFreeToVehicle、stepFreeToPlatform” | |
发件人姓名 | 起始名称是与起始坐标关联的位置名称 | |
姓名 | To name 是与 to 坐标关联的标签位置 | |
通过名称 | 过孔名称是与过孔坐标关联的位置名称。 | |
最大传输分钟数 | 换乘的最大步行时间(以分钟为单位),例如。 “120” | |
最大步行分钟数 | 旅程的最大步行时间(以分钟为单位),例如。 “120” | |
行走速度 | [平均的] | 步行速度。例如可能的选项:“慢” |
周期偏好 | [没有任何] | 周期偏好。例如可能的选项:“allTheWay” |
调整 | 时间调整命令。例如可能的选项:“TripFirst” | |
自行车熟练度 | 以逗号分隔的自行车熟练程度列表。例如可能的选项:“简单、中等、快速” | |
替代循环 | [错误的] | 决定是否返回替代骑行旅程的选项 |
另类步行 | [真的] | 选择是否返回替代步行旅程 |
应用Html标记 | [错误的] | 确定是否应使用 HTML 标签输出某些文本(例如步行指令)的标志。 |
使用多模式调用 | [错误的] | 一个布尔值,指示是否返回 3 个公共交通旅程、巴士旅程、自行车租赁旅程、个人自行车旅程和步行旅程 |
行走优化 | [错误的] | 一个布尔值,指示是否使用步行来优化旅程 |
指定如下选项:
options = {
walkingOptimization : true ,
bikeProficiency : 'easy' ,
accessibilityPreference : 'noEscalators'
}
用 LiveScript 编写,运行npm run build
来构建,或npm run watch
来观察更改然后构建
npm test
在 GitHub 存储库问题页面上报告
不再需要身份验证或 tfl 请求。如果您确实需要进行身份验证,则可以在 https://api-portal.tfl.gov.uk/signup 注册 API 密钥 创建一个类似于以下内容的 JSON 对象
tfl = {
appId : 'xxxxxxxx' ,
appKey : 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
} ;