npm 包 node-osr 使用教程

前言

node-osr 描述了一组用于查询 Oxide 拆分后物品名称的方法。对于前端开发人员，该包能够帮助他们更轻松地操作一些数据。本篇文章将详细介绍如何使用 npm 包 node-osr。

安装 node-osr

在安装 node-osr 前，您需要先安装 Node.js 和 npm。安装完成后，可以使用以下命令进行安装：

npm install node-osr

使用 node-osr

在安装了 node-osr 后，您可以通过以下方式引用它：

const { getItemNameById } = require('node-osr');

或者在 ES6 模块引用中：

import { getItemNameById } from 'node-osr';

现在，您可以通过以下方式查询物品名称：

const { getItemNameById } = require('node-osr');

(async () => {
  const itemName = await getItemNameById(6);
  console.log(itemName);
})();

上述代码执行后，将打印出 “Raw Wood”（生木材）。

node-osr 方法

node-osr 提供了以下方法：

getItemNameById(itemId: number): Promise<string>

根据物品 ID 查询物品名称。

const { getItemNameById } = require('node-osr');

(async () => {
  const itemName = await getItemNameById(6);
  console.log(itemName);
})();

getItemNameByItemName(itemName: string): Promise<string>

根据物品名称查询物品名称。

const { getItemNameByItemName } = require('node-osr');

(async () => {
  const itemName = await getItemNameByItemName('Raw Wood');
  console.log(itemName);
})();

getIdByItemName(itemName: string): Promise<number>

根据物品名称查询物品 ID。

const { getIdByItemName } = require('node-osr');

(async () => {
  const itemId = await getIdByItemName('Raw Wood');
  console.log(itemId);
})();

node-osr 数据源

node-osr 的数据源是从 Oxide（Rust 服务器插件）生成的，因此该数据源仅包含 Rust 的所有默认数据（包括扩展的护甲值和食品能量）。如有必要，也可以先从 Rust 游戏文件中提取数据，然后使用 node-osr 中的 convertCSVToObject 函数将它们转换为与 node-osr API 兼容的格式。

结语

本篇文章简单介绍了 npm 包 node-osr 的基本用法，希望它能够帮助到您。要深入了解 node-osr 的更多用法，请查看其官方文档。

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