Car-Registration-API-Ireland 是一个基于 Node.js 的 npm 包,用于获取爱尔兰车辆注册号的详细信息。该包可以通过车辆注册号对车辆信息进行查询,并提供了丰富的查询结果。
本文将详细介绍该 npm 包的使用教程,包括安装、调用方法、参数说明,以及示例代码。
安装
使用 npm 包管理器安装:
npm install car-registration-api-ireland
调用方法
在项目中使用 require
引入包:
const CarRegistrationAPI = require('car-registration-api-ireland');
然后创建 CarRegistrationAPI 实例:
const api = new CarRegistrationAPI();
创建实例时,也可以传递配置参数:
const api = new CarRegistrationAPI({ showLogo: false, showNotes: false, showHistory: false, showTests: false, showOwners: false, showImages: false, });
爱尔兰车牌号查询
调用 getVehicleDetailsByNumberPlate
方法来查询车辆信息:
api.getVehicleDetailsByNumberPlate('181D1234') .then((vehicleDetails) => { console.log(vehicleDetails); }) .catch((error) => { console.error(error); });
该方法返回一个 Promise 对象,查询成功时会解析出一个 VehicleDetails
对象,可以通过该对象获取车辆详细信息。
参数说明
CarRegistrationAPI
构造函数接受一个可选的配置对象,用于指定查询结果的显示方式。默认情况下,包将显示所有信息。
参数 | 类型 | 默认值 | 描述 |
---|---|---|---|
showLogo |
Boolean |
true |
是否显示查询服务的 logo |
showNotes |
Boolean |
true |
是否显示车辆的备注信息,例如车辆品牌和型号等 |
showHistory |
Boolean |
true |
是否显示车辆历史信息,如上牌时间等 |
showTests |
Boolean |
true |
是否显示车辆测试信息,如车辆年检日期等 |
showOwners |
Boolean |
true |
是否显示车辆所有者及其相关信息 |
showImages |
Boolean |
true |
是否显示车辆图片信息 |
timeoutSeconds |
Number |
10 |
查询超时时间,以秒为单位 |
示例代码
以下是一个完整的使用示例,该示例演示了如何使用 CarRegistrationAPI
获取车辆信息并显示结果。
-- -------------------- ---- ------- ----- ------------------ - ---------------------------------------- ----- --- - --- --------------------- ---------------------------------------------- ---------------------- -- - ---------------------------- -- -------------- -- - --------------------- ---
输出:
-- -------------------- ---- ------- - ------ - ------ ------ --------- ----- -------- ------- ------- ------------- ------------- ---------- --------- --------- --------- ---- ---------- ------------------ ----- ------------- ------ ---------- -- ---- ----- ------ -------------- ---------- ------------ ----- -- -------- - ---------------------- - ----- ------------- ---- -- ----- - ------- -- ---------------------- --- ---------------------- -- -- ------ - -------- - --------------- ------------- ---------------- -- --------------------- -- ------------ - -------- ------- ------------ ------------ - -- ------ - - ----- ------------- ----- ------------- --------------- ------- ---- ------------ ----------- ------------ - -------- ------- ------------ ------------ - -- - ----- ------------- ----- ------------- --------------- ------- ---- ------------ ----------- ------------ - -------- ------- ------------ ------------ - - - -- ------- --- ------- - ---------- ------------------------------------------------------------------------------------------------------------ - -
如上所述,VehicleDetails
对象包含了车辆的各种详细信息,例如车辆品牌、型号、颜色、上牌时间、车主等。您可以根据您的需求解析和使用这些信息。
总结
本文介绍了 npm 包 car-registration-api-ireland 的使用教程,包括安装、调用方法、参数说明和示例代码。该包可以方便地查询爱尔兰车牌号的详细信息,并提供了丰富的查询结果,具有很高的实用性和学习价值。希望本文能够对大家的前端开发工作有所帮助!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055fc581e8991b448dd28d