npm 包 cli-progress-spinner 使用教程-JavaScript中文网-JavaScript教程资源分享门户

1. 简介

cli-progress-spinner 是一款基于 Node.js 平台的命令行界面（CLI）进度条插件。它提供了许多丰富的参数和配置选项，可以为开发者在命令行中展示出优美的进度条效果，方便用户在长时间任务运行过程中监控进度和剩余时间，增强用户体验。

2. 模块安装

使用 npm 模块管理器进行安装：

npm install cli-progress-spinner

3. 使用示例

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

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

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

输出效果图：

Loading... 𝗦𝗧𝗔𝗥𝗧𝗜𝗡𝗚 𝗦𝗣𝗜𝗡𝗡𝗘𝗥

动画效果：

4. 功能选项

4.1 颜色

可以使用 color 属性来更改图标颜色。现在支持以下颜色：黄色、白色、绿色、蓝色、紫色、红色、黑色、品红色。

cliProgressSpinner.color = 'yellow';
cliProgressSpinner.text = 'Loading...';
// 执行任务

4.2 大小

可以使用 size 属性来更改图标尺寸。值必须大于或等于 1，并且必须是奇数，以保持图标的均衡。

cliProgressSpinner.size = 3;
cliProgressSpinner.text = 'Loading...';
// 执行任务

4.3 模式

cli-progress-spinner 模块支持两种模式：

spin：圆形旋转动画模式（默认值）
line：线性加载动画模式

cliProgressSpinner.mode = 'line'; // 模式属性设置
cliProgressSpinner.text = 'Loading...'; // 指定文本
// 执行任务

4.4 暂停与恢复

可以使用 pause() 和 resume() 方法来暂停和恢复动画

cliProgressSpinner.text = 'Loading...';
// 开始任务
cliProgressSpinner.pause(); // 暂停动画
cliProgressSpinner.text = 'Waiting...'; // 显示等待状态
// 执行其他任务
cliProgressSpinner.resume(); // 恢复动画
// 任务完成
cliProgressSpinner.succeed("Completed successfully!");

5. 结论

cli-progress-spinner 提供了非常实用的功能和选项，可以帮助开发者在命令行中展示出专业而且美观的进度条动画。这是一款非常值得研究和使用的 npm 包。

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