node tfl journey planner

一個簡單的 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'
    } ;