npm 包 @canboat/canboatjs 使用教程

阅读时长 3 分钟读完

什么是 @canboat/canboatjs

@canboat/canboatjs 是一个针对 Node.js 的 CANboat 数据库解析库。它可以解析多种数据格式,如 Actisense、Yacht Devices 和 Garmin,可以将这些数据格式转换为 NMEA 2000 格式,方便可视化和后续数据处理。@canboat/canboatjs 的优势在于它支持 CANboat 数据库的所有功能,包括查询、过滤和转换等等。

安装

@canboat/canboatjs 可以通过 npm 安装:

示例代码

以下是一个简单的 @canboat/canboatjs 使用例子:

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

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

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

------------------
展开代码

在上面的例子中,我们导入了 createCanboatjs 函数,创建了一个本机数据库实例。然后我们使用 .filter() 方法查询了一个 pgn 为 128259 的数据库记录。

API 文档

createCanboatjs(options)

创建一个 canboat 数据库实例。

options

directory: string

必填。CANboat 数据库所在的目录。

mode: string

必填。数据库模式。可选值为 readOnlyreadWrite

resolvedPaths: string[]

必填。数据库模式。可选值为 readOnlyreadWrite

parseString(str)

解析 CANboat 数据库 XML 格式的字符串。

str: string

必填。CANboat 数据库 XML 格式的字符串。

parseFile(filename)

解析 CANboat 数据库 XML 格式的文件。

filename: string

必填。数据库文件名。

filter(filterFunc)

过滤数据库记录。

filterFunc: (pgn: any) => boolean

必填。用于过滤的函数。

总结

@canboat/canboatjs 是一个非常优秀的 CANboat 数据库解析库,它可以让我们更加便捷地处理 NMEA 2000 数据格式。只要熟悉使用方法,我们就可以在 Node.js 环境下对庞大的数据进行检索和处理。希望这篇学习笔记对您有帮助!

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