ora

ora

优雅的终端旋转器

安装

NPM安装ORA

查看yocto-spinner以获取较小的替代方案。

用法

从“ ora”中导入ora; stant spinner = ora（'loading Unicorns'）。start（）; settimeout（（）=> {spinner.color ='yellow'; spinner.text ='loading Rainbows';}，1000） ;

API

ORA（文字）

ORA（选项）

如果提供了字符串，则将其视为options.text的快捷方式。

选项

类型： object

文本

类型： string

旋转器旁边显示的文本。

前缀

类型： string | () => string

文本或返回文本以在旋转器之前显示的函数。如果设置为空字符串，则不会显示前缀文本。

后缀文本

类型： string | () => string

文本或返回文本以在旋转器文本之后显示的函数。如果设置为空字符串，则不会显示后缀文本。

旋转器

类型： string | object
默认： 'dots'

提供的旋转器之一的名称。如果您想测试不同的旋转器，请参见此存储库中的example.js 。在Windows上（Windows终端除外），它将始终使用line旋转器，因为Windows命令行没有适当的Unicode支持。

或类似的对象：

 {框架：[' - '，'+'，' - ']，间隔：80 //可选}

颜色

类型： string
默认： 'cyan'
值： 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray'

旋转器的颜色。

Hidecursor

类型： boolean
默认值： true

设置为false以阻止ORA隐藏光标。

缩进

类型： number
默认值： 0

用给定数量的空间缩进旋转器。

间隔

类型： number
默认：由旋转器或100

每个帧之间的间隔。

旋转器提供自己的建议间隔，因此您实际上不需要指定此信息。

溪流

类型： stream.Writable
默认值： process.stderr

流写输出。

例如，您可以将其设置为process.stdout 。

类别

类型： boolean

强制启用/禁用旋转器。如果未指定，则如果stream在TTY上下文（未产生或管道）和/或在CI环境中运行，则将启用旋转器。

请注意， {isEnabled: false}并不意味着它不会输出任何内容。它只是意味着它不会输出旋转器，颜色和其他ANSI逃生代码。它仍然会记录文本。

Issilent

类型： boolean
默认值： false

禁用旋转器和所有日志文本。所有输出均被抑制， isEnabled将被视为false 。

丢弃

类型： boolean
默认值： true

在运行TTY时丢弃STDIN输入（CTRL+C除外）。这样可以防止旋转器在输入上抽搐，在Enter按键按下输出断线，并在旋转器运行时防止输入缓冲。

这对Windows没有影响，因为没有好的方法可以正确地实施丢弃的STDIN。

实例

.TEXT^{获取/设置}

更改旋转器之后显示的文本。

.preFixText^{获取/设置}

在旋转器面前更改文本。

如果设置为空字符串，则不会显示前缀文本。

.suffixText^{获取/设置}

更改旋转器文本之后的文本。

如果设置为空字符串，则不会显示后缀文本。

。彩色^{获取/设置}

更改旋转器颜色。

.spinner^{获取/设置}

更改旋转器。

.indent ^get/set

更改旋转器凹痕。

.isspinning^获得

布尔值指示该实例当前是否正在旋转。

.interval^获取

每个帧之间的间隔。

间隔由选定的旋转器决定。

.START（文字？）

启动旋转器。返回实例。如果提供text ，请设置当前文本。

。停止（）

停止并清除旋转器。返回实例。

.Succeed（文字？）

停止旋转器，将其更改为绿色✔ ，并持续当前文本，或者如果提供的text 。返回实例。请参阅下面的GIF。

.fail（文字？）

停止旋转器，将其更改为红色✖ ，并持续当前文本，或者如果提供的text 。返回实例。请参阅下面的GIF。

.warn（文字？）

停止旋转器，将其更改为黄色，并将当前文本持续使用，或者如果提供的text 。返回实例。

.info（文字？）

停止旋转器，将其更改为蓝色ℹ ，并持续当前文本，或者如果提供的text 。返回实例。

。

停止旋转器并更改符号或文本。返回实例。请参阅下面的GIF。

选项

类型： object

象征

类型： string
默认： ' '

用符号代替旋转器。

文本

类型： string
默认值：当前的'text'

符号之后要持续存在的文字。

前缀

类型： string | () => string
默认值：当前的prefixText

文本或返回符号之前文本的函数。如果设置为空字符串，则不会显示前缀文本。

后缀文本

类型： string | () => string
默认值：当前的suffixText

文本或返回文本后要在符号之后的文本之后持续存在的函数。如果设置为空字符串，则不会显示后缀文本。

。清除（）

清除旋转器。返回实例。

。使成为（）

手动渲染一个新框架。返回实例。

。框架（）

获取一个新的框架。

Orapromise（动作，文本）

Orapromise（操作，选项）

启动一个旋转器，以获得承诺或承诺的功能。如果承诺符合承诺或.fail() ，则旋转器将与.succeed()停止。返回诺言。

从'ora'导入{orapromise};等待orapromise（somePromise）;

行动

类型： Promise | ((spinner: ora.Ora) => Promise)

选项

类型： object

所有选项以及以下内容：

SuccessText

类型： string | ((result: T) => string) | undefined

当诺言得到解决时，旋转器的新文本。

如果undefined则将现有文本保留。

FailText

类型： string | ((error: Error) => string) | undefined

当诺言被拒绝时，旋转器的新文本。

如果undefined则将现有文本保留。

旋转器

类型： Record<string, Spinner>

所有人都提供了旋转器。

常问问题

如何更改文本的颜色？

使用chalk或yoctocolors ：

从“ ora”中导入ORA；从“粉笔”导入粉笔； stann spinner = ora（`loading $ {chalk.red（'unicorns'）}`）.start（）;

为什么旋转器冻结？

JavaScript是单线程，因此任何同步操作都会阻止旋转器的动画。为了避免这种情况，更喜欢使用异步操作。

有关的

• Yocto -Spinner-微小的终端旋转器

• CLI -SPINNER-用于终端的旋转器

端口

• Clispinner- Swift的终端旋转器库

• 光环 - 蟒蛇港

• 旋转器 - 生锈的终端旋转器

• Marquee -Ora-滚动ORA的Marquee Spinner

• Briandowns/旋转器 - 终端旋转器/GO的进度指标

• TJ/Go -Spin- GO的终端旋转器包

• observablehq.com/@victordidenko/ora- ORA端口到可观察的笔记本

• 起亚 - DENO的简单终端旋转器？