npm 包 bvg-shuttle-gtfs-rt-feed 使用教程

阅读时长 4 分钟读完

常规说明

npm 包 bvg-shuttle-gtfs-rt-feed 是一个优秀的 node.js 模块,用于获取 BVG 实时公交车到站信息。BVG(柏林公交公司)是德国柏林的公共交通运营商,这个模块通过抓取 BVG 的公交车到站信息并将其转换为 Google's GTFS 的实时更新信息格式,从而提供实时公交车到站信息的数据源。

本文将详细介绍如何使用 bvg-shuttle-gtfs-rt-feed 这个模块,并提供一些代码示例来帮助初学者更好地了解这个模块。

核心功能

bvg-shuttle-gtfs-rt-feed 这个模块包含以下核心功能:

  • 获取 BVG 的公交车实时到站信息
  • 将抓取到的到站信息转换为 GTFS-RT 格式返回
  • 支持对获取到的到站信息进行筛选和过滤

安装

要使用 bvg-shuttle-gtfs-rt-feed 这个模块,需要先安装它。可以通过 npm 或者 yarn 来安装:

或者

安装完成之后,可以在代码中通过以下方式引入该模块:

使用方法

1. 获取实时到站信息

要获取 BVG 的实时到站信息,需要提供公交车站的 ID 和相关信息。使用 bvgShuttleGtfsRtFeed.getVehiclePositions() 方法可以获取到这些信息。该方法的具体参数如下:

参数 类型 描述
stationId string 要查询的公交车站的 ID
agency string 公交公司对应的 GTFS agencies.txt 文件中的 ID
apiKey string 获取到站信息所需的 API key
options object 可选参数,支持对获取到的车辆位置信息进行筛选和过滤

以下是一个获取实时到站信息的示例代码:

-- -------------------- ---- -------
----- -------------------- - ------------------------------------
----- --------- - --------------- -- -------
----- ------ - ------ -- --- - ---- ------------ ---- --
----- ------ - ------------- -- -- --- ------- --- ---

--------------------------------------------------- ------- -------
  ------------ -- -
    ------------------
  --
  -------------- -- -
    ---------------------
  ---

getVehiclePositions() 方法返回一个 Promise,其中包含以 GTFS-RT 格式返回的实时车辆位置信息。

2. 筛选和过滤实时到站信息

getVehiclePositions() 方法还支持对获取到的车辆位置信息进行筛选和过滤。可以通过 options 参数来设置这些选项。以下是一个对实时车辆位置信息进行筛选和过滤的示例代码:

-- -------------------- ---- -------
----- -------------------- - ------------------------------------
----- --------- - --------------- -- -------
----- ------ - ------ -- --- - ---- ------------ ---- --
----- ------ - ------------- -- -- --- ------- --- ---
----- ------- - -
  ---------- ---- -- ----------
  ------ ---- -- -----------
  -------- ---- -- ----------
--

--------------------------------------------------- ------- ------- --------
  ------------ -- -
    ------------------
  --
  -------------- -- -
    ---------------------
  ---

以上代码将只查询行驶方向为 N,公交车路线号码为 100,车牌号为 1234 的公交车位置信息。

总结

bvg-shuttle-gtfs-rt-feed 这个模块提供了一种方便的方法来获取 BVG 的实时公交车到站信息,并将其转换为 GTFS-RT 格式。本文介绍了该模块的核心功能和使用方法,并提供了一些示例代码,希望对初学者有一定的帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60057c4a81e8991b448ebd03

纠错
反馈