npm 包 payasan-base-names-pmb 使用教程

阅读时长 4 分钟读完

简介

payasan-base-names-pmb 是一个基于 JavaScript 编写的 npm 包,用于生成 Payasan 音乐套路的名称。Payasan 是一种日本传统音乐套路,传统上通过口口相传传递,没有统一的名称体系。该包有助于音乐家和研究人员更容易地识别并使用 Payasan 套路名称。

安装

在命令行中输入以下命令安装 payasan-base-names-pmb

或者,您可以将其添加到您的 package.json 文件中:

然后通过运行以下命令安装:

使用教程

导入

在您的代码中,首先要导入 payasan-base-names-pmb

生成名称

要生成一个套路名称,您可以使用 payasanBaseNames.generateName() 方法。例如:

自定义名称

您可以通过以下方法来自定义生成名称的参数:

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

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

上述示例中,我们设置了 category 参数为 H - Nagashiform 参数为 2theme 参数为 Taki,和 variation 参数为 A。这将生成名称 "H2 Taki Nagashi A"

支持的参数列表

payasanBaseNames.generateName() 方法支持以下的参数:

  • location (string):设置套路地区的名称(默认为随机地区)
  • form (string):设置套路的形单双,值为 1 代表单,值为 2 代表双(默认为随机)
  • theme (string):设置套路的主题名称(默认为随机主题)
  • category (string):设置套路的分类名称(默认为随机分类)
  • variation (string):设置套路的变化名称(默认为随机变化)

上述参数的值都可以在 payasanBaseNames 模块的 data.js 文件中进行设置和检查。

示例代码

以下是一个完整的示例,其中我们将自定义生成套路名称:

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

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

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

总结

通过使用 payasan-base-names-pmb,您可以更轻松地生成 Payasan 套路的名称。我们希望这篇教程可以帮助您开始使用该 npm 包,您可以在自己的项目中使用它。

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

纠错
反馈