简介
wmata-metro-js 是一个通过 WMATA API 获取本地火车站和列车信息的 npm 包。它的使用方法简单,可以使开发者快速获取 WMATA 的查询结果。
安装
安装是通过 npm 进行的,我们需要在控制台输入以下命令:
npm install wmata-metro-js
基本用法
-- -------------------- ---- ------- -- -- ---------------- ----- ----- - -------------------------- -- -- -- ----- -- ----- ----- - --- -------------------- -- -- ----------- ----------------------------------------- -- - -------------------- ---
WMATA 实例
想要使用 wmata-metro-js,我们需要创建一个 WMATA 实例。WMATA 类需要接收一个 ACCESS_KEY 作为参数,ACCESS_KEY 是由 WMATA API 提供的。
const WMATA = require("wmata-metro-js"); const wmata = new WMATA("ACCESS_KEY");
getTrainArrivals 方法
getTrainArrivals 方法可以用于获取指定站点的列车信息,并可以附加其它参数以进一步筛选结果。以下是 getTrainArrivals 方法的参数列表:
参数 | 描述 |
---|---|
stationCode | 字符串,需要查询车站的编码。 |
lineCode | 字符串,需要查询的线路编码。 |
directionCode | 字符串,指定查询方向,必须是1(进站)或2(出站) |
includeStations | 数组,只返回包含该车站编码的结果,避免在查询所有车站和所有列表时出现庞大的列表。 |
excludeStations | 数组,不包括指定车站编码的结果。 |
getTrainArrivals 方法返回一个 Promise 对象,我们可以使用 then 方法来处理结果。
wmata.getTrainArrivals("A01").then(result => { console.log(result); });
示例代码
以下是一个完整的示例代码:
const WMATA = require("wmata-metro-js"); const wmata = new WMATA("ACCESS_KEY"); wmata.getTrainArrivals("A01").then(result => { console.log(result); });
总结
通过使用 wmata-metro-js,我们可以轻松地获取 WMATA 的信息。在我们开发 与 WMATA 相关的应用程序时,这是非常有用的。希望本教程能够对您有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006710f8dd3466f61ffe279