npm 包 irishrail-client 使用教程

在前端开发中，我们经常需要使用一些第三方库或者 npm 包来帮助我们完成一些常规的开发任务。在处理一些与铁路行业相关的项目时，我们可以使用 npm 包 irishrail-client 来获取实时的火车信息。

什么是 irishrail-client

irishrail-client 是一个由 Node.js 编写的轻量级的 npm 包。它与爱尔兰铁路公司的火车时刻表和实时列车追踪服务进行通信，并提供简单的 API 以便于查询火车时刻和实时列车信息。

如何安装和使用 irishrail-client

irishrail-client 可以通过 npm 安装，使用以下命令：

npm install irishrail-client

使用 irishrail-client 之前，你需要在自己的项目中引入该模块：

const IrishRail = require('irishrail-client');

API 详解

irishrail-client 提供了一些简单易用的 API 来查询火车时刻和实时列车信息。

getStations()

该 API 可以获取所有火车站的信息，返回一个包含站点代码（StationCode）和站点名称（StationDesc）的数组。

示例代码：

const IrishRail = require('irishrail-client');
IrishRail.getStations().then((stationData) => {
  console.log(stationData);
}).catch((error) => {
  console.log(error);
});

getStationData(stationCode)

该 API 可以获取特定火车站的信息，需要传入站点代码（StationCode）作为参数。返回该火车站的名称、经度、纬度和海拔高度等详细信息。

示例代码：

const IrishRail = require('irishrail-client');
IrishRail.getStationData('LIMK').then((stationData) => {
  console.log(stationData);
}).catch((error) => {
  console.log(error);
});

getCurrentTrains(stationCode)

该 API 可以获取特定火车站现在正在运行的列车信息，需要传入站点代码（StationCode）作为参数。返回一个包含所有列车信息的数组，包括列车号码（TrainCode）、目的地（Destination）、预计到达时间（Exp Arrival）、预计发车时间（Exp Depart）和列车状态等信息。

示例代码：

const IrishRail = require('irishrail-client');
IrishRail.getCurrentTrains('LIMK').then((trainData) => {
  console.log(trainData);
}).catch((error) => {
  console.log(error);
});

getTrainMovements(trainId, trainDate)

该 API 可以获取指定列车的历史位置信息，需要传入列车号码（TrainId）和日期（TrainDate）作为参数。返回一个包含有关列车位置和状态的数组，包括时间戳（Timestamp）、位置（Location）、速度（Speed），笛声和灯光等信息。

示例代码：

const IrishRail = require('irishrail-client');
IrishRail.getTrainMovements('E800', '2021-09-20').then((trainData) => {
  console.log(trainData);
}).catch((error) => {
  console.log(error);
});

总结

本文介绍了 npm 包 irishrail-client 的基本信息和常用 API，并提供了相应的示例代码。使用 irishrail-client 可以轻松地在自己的项目中获取实时的火车时刻和列车位置信息，对于某些需要与铁路行业相关的项目，这个 npm 包无疑会极大地方便开发人员的工作。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005601681e8991b448de2e2